[+-])?\"\n r\"P(?!\\b)\"\n r\"(?P<years>[0-9]+([,.][0-9]+)?Y)?\"\n r\"(?P<months>[0-9]+([,.][0-9]+)?M)?\"\n r\"(?P<weeks>[0-9]+([,.][0-9]+)?W)?\"\n r\"(?P<days>[0-9]+([,.][0-9]+)?D)?\"\n r\"((?P<separator>T)(?P<hours>[0-9]+([,.][0-9]+)?H)?\"\n r\"(?P<minutes>[0-9]+([,.][0-9]+)?M)?\"\n r\"(?P<seconds>[0-9]+([,.][0-9]+)?S)?)?$\"\n)\n# regular expression to parse ISO duration strings.\n\n\ndef parse_duration(\n datestring: str, as_timedelta_if_possible: bool = True\n) -> Union[timedelta, Duration]:\n \"\"\"Parses an ISO 8601 durations into datetime.timedelta or Duration objects.\n\n If the ISO date string does not contain years or months, a timedelta\n instance is returned, else a Duration instance is returned.\n\n The following duration formats are supported:\n -PnnW duration in weeks\n -PnnYnnMnnDTnnHnnMnnS complete duration specification\n -PYYYYMMDDThhmmss basic alternative complete date format\n -PYYYY-MM-DDThh:mm:ss extended alternative complete date format\n -PYYYYDDDThhmmss basic alternative ordinal date format\n -PYYYY-DDDThh:mm:ss extended alternative ordinal date format\n\n The '-' is optional.\n\n Limitations: ISO standard defines some restrictions about where to use\n fractional numbers and which component and format combinations are\n allowed. This parser implementation ignores all those restrictions and\n returns something when it is able to find all necessary components.\n In detail:\n it does not check, whether only the last component has fractions.\n it allows weeks specified with all other combinations\n\n The alternative format does not support durations with years, months or\n days set to 0.\n \"\"\"\n ret: Optional[Union[timedelta, Duration]] = None\n if not isinstance(datestring, str):\n raise TypeError(\"Expecting a string %r\" % datestring)\n match = ISO8601_PERIOD_REGEX.match(datestring)\n if not match:\n # try alternative format:\n if datestring.startswith(\"P\"):\n durdt = parse_datetime(datestring[1:])\n if as_timedelta_if_possible and durdt.year == 0 and durdt.month == 0:\n # FIXME: currently not possible in alternative format\n # create timedelta\n ret = timedelta(\n days=durdt.day,\n seconds=durdt.second,\n microseconds=durdt.microsecond,\n minutes=durdt.minute,\n hours=durdt.hour,\n )\n else:\n # create Duration\n ret = Duration(\n days=durdt.day,\n seconds=durdt.second,\n microseconds=durdt.microsecond,\n minutes=durdt.minute,\n hours=durdt.hour,\n months=durdt.month,\n years=durdt.year,\n )\n return ret\n raise ISO8601Error(\"Unable to parse duration string %r\" % datestring)\n groups = match.groupdict()\n for key, val in groups.items():\n if key not in (\"separator\", \"sign\"):\n if val is None:\n groups[key] = \"0n\"\n # print groups[key]\n if key in (\"years\", \"months\"):\n groups[key] = Decimal(groups[key][:-1].replace(\",\", \".\"))\n else:\n # these values are passed into a timedelta object,\n # which works with floats.\n groups[key] = float(groups[key][:-1].replace(\",\", \".\"))\n if as_timedelta_if_possible and groups[\"years\"] == 0 and groups[\"months\"] == 0:\n ret = timedelta(\n # values have been converted to float or Decimal\n days=groups[\"days\"], # type: ignore [arg-type]\n hours=groups[\"hours\"], # type: ignore [arg-type]\n minutes=groups[\"minutes\"], # type: ignore [arg-type]\n seconds=groups[\"seconds\"], # type: ignore [arg-type]\n weeks=groups[\"weeks\"], # type: ignore [arg-type]\n )\n if groups[\"sign\"] == \"-\":\n ret = timedelta(0) - ret\n else:\n ret = Duration(\n # values have been converted to float or Decimal\n years=groups[\"years\"], # type: ignore [arg-type]\n months=groups[\"months\"], # type: ignore [arg-type]\n days=groups[\"days\"], # type: ignore [arg-type]\n hours=groups[\"hours\"], # type: ignore [arg-type]\n minutes=groups[\"minutes\"], # type: ignore [arg-type]\n seconds=groups[\"seconds\"], # type: ignore [arg-type]\n weeks=groups[\"weeks\"], # type: ignore [arg-type]\n )\n if groups[\"sign\"] == \"-\":\n ret = Duration(0) - ret\n return ret\n\n\ndef duration_isoformat(\n tduration: Union[timedelta, Duration, time, date], format: str = D_DEFAULT\n) -> str:\n \"\"\"Format duration strings.\n\n This method is just a wrapper around isodate.isostrf.strftime and uses\n P%P (D_DEFAULT) as default format.\n \"\"\"\n # TODO: implement better decision for negative Durations.\n # should be done in Duration class in consistent way with timedelta.\n if (\n isinstance(tduration, Duration)\n and (tduration.years < 0 or tduration.months < 0 or tduration.tdelta < timedelta(0))\n ) or (isinstance(tduration, timedelta) and (tduration < timedelta(0))):\n ret = \"-\"\n else:\n ret = \"\"\n ret += strftime(tduration, format)\n return ret\n\n[end of src/isodate/isoduration.py]","filename":"src/isodate/isoduration.py","id":"13"},{"content":"\"\"\"This module provides an alternative strftime method.\n\nThe strftime method in this module allows only a subset of Python's strftime\nformat codes, plus a few additional. It supports the full range of date values\npossible with standard Python date/time objects. Furthermore there are several\npr-defined format strings in this module to make ease producing of ISO 8601\nconforming strings.\n\"\"\"\n\nimport re\nfrom datetime import date, time, timedelta\nfrom typing import Callable, Union\n\nfrom isodate.duration import Duration\nfrom isodate.isotzinfo import tz_isoformat\n\n# Date specific format strings\nDATE_BAS_COMPLETE = \"%Y%m%d\"\nDATE_EXT_COMPLETE = \"%Y-%m-%d\"\nDATE_BAS_WEEK_COMPLETE = \"%YW%W%w\"\nDATE_EXT_WEEK_COMPLETE = \"%Y-W%W-%w\"\nDATE_BAS_ORD_COMPLETE = \"%Y%j\"\nDATE_EXT_ORD_COMPLETE = \"%Y-%j\"\nDATE_BAS_WEEK = \"%YW%W\"\nDATE_EXT_WEEK = \"%Y-W%W\"\nDATE_BAS_MONTH = \"%Y%m\"\nDATE_EXT_MONTH = \"%Y-%m\"\nDATE_YEAR = \"%Y\"\nDATE_CENTURY = \"%C\"\n\n# Time specific format strings\nTIME_BAS_COMPLETE = \"%H%M%S\"\nTIME_EXT_COMPLETE = \"%H:%M:%S\"\nTIME_BAS_MINUTE = \"%H%M\"\nTIME_EXT_MINUTE = \"%H:%M\"\nTIME_HOUR = \"%H\"\n\n# Time zone formats\nTZ_BAS = \"%z\"\nTZ_EXT = \"%Z\"\nTZ_HOUR = \"%h\"\n\n# DateTime formats\nDT_EXT_COMPLETE = DATE_EXT_COMPLETE + \"T\" + TIME_EXT_COMPLETE + TZ_EXT\nDT_BAS_COMPLETE = DATE_BAS_COMPLETE + \"T\" + TIME_BAS_COMPLETE + TZ_BAS\nDT_EXT_ORD_COMPLETE = DATE_EXT_ORD_COMPLETE + \"T\" + TIME_EXT_COMPLETE + TZ_EXT\nDT_BAS_ORD_COMPLETE = DATE_BAS_ORD_COMPLETE + \"T\" + TIME_BAS_COMPLETE + TZ_BAS\nDT_EXT_WEEK_COMPLETE = DATE_EXT_WEEK_COMPLETE + \"T\" + TIME_EXT_COMPLETE + TZ_EXT\nDT_BAS_WEEK_COMPLETE = DATE_BAS_WEEK_COMPLETE + \"T\" + TIME_BAS_COMPLETE + TZ_BAS\n\n# Duration formts\nD_DEFAULT = \"P%P\"\nD_WEEK = \"P%p\"\nD_ALT_EXT = \"P\" + DATE_EXT_COMPLETE + \"T\" + TIME_EXT_COMPLETE\nD_ALT_BAS = \"P\" + DATE_BAS_COMPLETE + \"T\" + TIME_BAS_COMPLETE\nD_ALT_EXT_ORD = \"P\" + DATE_EXT_ORD_COMPLETE + \"T\" + TIME_EXT_COMPLETE\nD_ALT_BAS_ORD = \"P\" + DATE_BAS_ORD_COMPLETE + \"T\" + TIME_BAS_COMPLETE\n\nSTRF_DT_MAP: dict[str, Callable[[Union[time, date], int], str]] = {\n \"%d\": lambda tdt, yds: \"%02d\" % tdt.day, # type: ignore [union-attr]\n \"%f\": lambda tdt, yds: \"%06d\" % tdt.microsecond, # type: ignore [union-attr]\n \"%H\": lambda tdt, yds: \"%02d\" % tdt.hour, # type: ignore [union-attr]\n \"%j\": lambda tdt, yds: \"%03d\" % (tdt.toordinal() - date(tdt.year, 1, 1).toordinal() + 1), # type: ignore [union-attr, operator] # noqa: E501\n \"%m\": lambda tdt, yds: \"%02d\" % tdt.month, # type: ignore [union-attr]\n \"%M\": lambda tdt, yds: \"%02d\" % tdt.minute, # type: ignore [union-attr]\n \"%S\": lambda tdt, yds: \"%02d\" % tdt.second, # type: ignore [union-attr]\n \"%w\": lambda tdt, yds: \"%1d\" % tdt.isoweekday(), # type: ignore [union-attr]\n \"%W\": lambda tdt, yds: \"%02d\" % tdt.isocalendar()[1], # type: ignore [union-attr]\n \"%Y\": lambda tdt, yds: (((yds != 4) and \"+\") or \"\") + ((\"%%0%dd\" % yds) % tdt.year), # type: ignore [union-attr] # noqa: E501\n \"%C\": lambda tdt, yds: (((yds != 4) and \"+\") or \"\") # type: ignore [union-attr]\n + ((\"%%0%dd\" % (yds - 2)) % (tdt.year / 100)), # type: ignore [union-attr]\n \"%h\": lambda tdt, yds: tz_isoformat(tdt, \"%h\"), # type: ignore [arg-type]\n \"%Z\": lambda tdt, yds: tz_isoformat(tdt, \"%Z\"), # type: ignore [arg-type]\n \"%z\": lambda tdt, yds: tz_isoformat(tdt, \"%z\"), # type: ignore [arg-type]\n \"%%\": lambda tdt, yds: \"%\",\n}\n\nSTRF_D_MAP: dict[str, Callable[[Union[timedelta, Duration], int], str]] = {\n \"%d\": lambda tdt, yds: \"%02d\" % tdt.days,\n \"%f\": lambda tdt, yds: \"%06d\" % tdt.microseconds,\n \"%H\": lambda tdt, yds: \"%02d\" % (tdt.seconds / 60 / 60),\n \"%m\": lambda tdt, yds: \"%02d\" % tdt.months, # type: ignore [union-attr]\n \"%M\": lambda tdt, yds: \"%02d\" % ((tdt.seconds / 60) % 60),\n \"%S\": lambda tdt, yds: \"%02d\" % (tdt.seconds % 60),\n \"%W\": lambda tdt, yds: \"%02d\" % (abs(tdt.days / 7)),\n \"%Y\": lambda tdt, yds: (((yds != 4) and \"+\") or \"\") + ((\"%%0%dd\" % yds) % tdt.years), # type: ignore [union-attr] # noqa: E501\n \"%C\": lambda tdt, yds: (((yds != 4) and \"+\") or \"\")\n + ((\"%%0%dd\" % (yds - 2)) % (tdt.years / 100)), # type: ignore [union-attr]\n \"%%\": lambda tdt, yds: \"%\",\n}\n\n\ndef _strfduration(tdt: Union[timedelta, Duration], format: str, yeardigits: int = 4) -> str:\n \"\"\"This is the work method for timedelta and Duration instances.\n\n See strftime for more details.\n \"\"\"\n\n def repl(match: re.Match[str]) -> str:\n \"\"\"Lookup format command and return corresponding replacement.\"\"\"\n if match.group(0) in STRF_D_MAP:\n return STRF_D_MAP[match.group(0)](tdt, yeardigits)\n elif match.group(0) == \"%P\":\n ret: list[str] = []\n if isinstance(tdt, Duration):\n if tdt.years:\n ret.append(\"%sY\" % abs(tdt.years))\n if tdt.months:\n ret.append(\"%sM\" % abs(tdt.months))\n usecs = abs((tdt.days * 24 * 60 * 60 + tdt.seconds) * 1000000 + tdt.microseconds)\n seconds, usecs = divmod(usecs, 1000000)\n minutes, seconds = divmod(seconds, 60)\n hours, minutes = divmod(minutes, 60)\n days, hours = divmod(hours, 24)\n if days:\n ret.append(\"%sD\" % days)\n if hours or minutes or seconds or usecs:\n ret.append(\"T\")\n if hours:\n ret.append(\"%sH\" % hours)\n if minutes:\n ret.append(\"%sM\" % minutes)\n if seconds or usecs:\n if usecs:\n ret.append((\"%d.%06d\" % (seconds, usecs)).rstrip(\"0\"))\n else:\n ret.append(\"%d\" % seconds)\n ret.append(\"S\")\n # at least one component has to be there.\n return \"\".join(ret) if ret else \"0D\"\n elif match.group(0) == \"%p\":\n return str(abs(tdt.days // 7)) + \"W\"\n return match.group(0)\n\n return re.sub(\"%d|%f|%H|%m|%M|%S|%W|%Y|%C|%%|%P|%p\", repl, format)\n\n\ndef _strfdt(tdt: Union[time, date], format: str, yeardigits: int = 4) -> str:\n \"\"\"This is the work method for time and date instances.\n\n See strftime for more details.\n \"\"\"\n\n def repl(match: re.Match[str]) -> str:\n \"\"\"Lookup format command and return corresponding replacement.\"\"\"\n if match.group(0) in STRF_DT_MAP:\n return STRF_DT_MAP[match.group(0)](tdt, yeardigits)\n return match.group(0)\n\n return re.sub(\"%d|%f|%H|%j|%m|%M|%S|%w|%W|%Y|%C|%z|%Z|%h|%%\", repl, format)\n\n\ndef strftime(tdt: Union[timedelta, Duration, time, date], format: str, yeardigits: int = 4) -> str:\n \"\"\"Directive Meaning Notes.\n\n %d Day of the month as a decimal number [01,31].\n %f Microsecond as a decimal number [0,999999], zero-padded\n on the left (1)\n %H Hour (24-hour clock) as a decimal number [00,23].\n %j Day of the year as a decimal number [001,366].\n %m Month as a decimal number [01,12].\n %M Minute as a decimal number [00,59].\n %S Second as a decimal number [00,61]. (3)\n %w Weekday as a decimal number [0(Monday),6].\n %W Week number of the year (Monday as the first day of the week)\n as a decimal number [00,53]. All days in a new year preceding the\n first Monday are considered to be in week 0. (4)\n %Y Year with century as a decimal number. [0000,9999]\n %C Century as a decimal number. [00,99]\n %z UTC offset in the form +HHMM or -HHMM (empty string if the\n object is naive). (5)\n %Z Time zone name (empty string if the object is naive).\n %P ISO8601 duration format.\n %p ISO8601 duration format in weeks.\n %% A literal '%' character.\n\n \"\"\"\n if isinstance(tdt, (timedelta, Duration)):\n return _strfduration(tdt, format, yeardigits)\n return _strfdt(tdt, format, yeardigits)\n\n[end of src/isodate/isostrf.py]","filename":"src/isodate/isostrf.py","id":"14"},{"content":"\"\"\"This module defines all exception classes in the whole package.\"\"\"\n\n\nclass ISO8601Error(ValueError):\n \"\"\"Raised when the given ISO string can not be parsed.\"\"\"\n\n[end of src/isodate/isoerror.py]","filename":"src/isodate/isoerror.py","id":"15"},{"content":"\"\"\"This modules provides a method to parse an ISO 8601:2004 time string to a\nPython datetime.time instance.\n\nIt supports all basic and extended formats including time zone specifications\nas described in the ISO standard.\n\"\"\"\n\nimport re\nfrom datetime import date, time, timedelta\nfrom decimal import ROUND_FLOOR, Decimal\nfrom typing import Union\n\nfrom isodate.duration import Duration\nfrom isodate.isoerror import ISO8601Error\nfrom isodate.isostrf import TIME_EXT_COMPLETE, TZ_EXT, strftime\nfrom isodate.isotzinfo import TZ_REGEX, build_tzinfo\n\nTIME_REGEX_CACHE: list[re.Pattern[str]] = []\n# used to cache regular expressions to parse ISO time strings.\n\n\ndef build_time_regexps() -> list[re.Pattern[str]]:\n \"\"\"Build regular expressions to parse ISO time string.\n\n The regular expressions are compiled and stored in TIME_REGEX_CACHE\n for later reuse.\n \"\"\"\n if not TIME_REGEX_CACHE:\n # ISO 8601 time representations allow decimal fractions on least\n # significant time component. Command and Full Stop are both valid\n # fraction separators.\n # The letter 'T' is allowed as time designator in front of a time\n # expression.\n # Immediately after a time expression, a time zone definition is\n # allowed.\n # a TZ may be missing (local time), be a 'Z' for UTC or a string of\n # +-hh:mm where the ':mm' part can be skipped.\n # TZ information patterns:\n # ''\n # Z\n # +-hh:mm\n # +-hhmm\n # +-hh =>\n # isotzinfo.TZ_REGEX\n def add_re(regex_text: str) -> None:\n TIME_REGEX_CACHE.append(re.compile(r\"\\A\" + regex_text + TZ_REGEX + r\"\\Z\"))\n\n # 1. complete time:\n # hh:mm:ss.ss ... extended format\n add_re(\n r\"T?(?P<hour>[0-9]{2}):\"\n r\"(?P<minute>[0-9]{2}):\"\n r\"(?P<second>[0-9]{2}\"\n r\"([,.][0-9]+)?)\"\n )\n # hhmmss.ss ... basic format\n add_re(\n r\"T?(?P<hour>[0-9]{2})\" r\"(?P<minute>[0-9]{2})\" r\"(?P<second>[0-9]{2}\" r\"([,.][0-9]+)?)\"\n )\n # 2. reduced accuracy:\n # hh:mm.mm ... extended format\n add_re(r\"T?(?P<hour>[0-9]{2}):\" r\"(?P<minute>[0-9]{2}\" r\"([,.][0-9]+)?)\")\n # hhmm.mm ... basic format\n add_re(r\"T?(?P<hour>[0-9]{2})\" r\"(?P<minute>[0-9]{2}\" r\"([,.][0-9]+)?)\")\n # hh.hh ... basic format\n add_re(r\"T?(?P<hour>[0-9]{2}\" r\"([,.][0-9]+)?)\")\n return TIME_REGEX_CACHE\n\n\ndef parse_time(timestring: str) -> time:\n \"\"\"Parses ISO 8601 times into datetime.time objects.\n\n Following ISO 8601 formats are supported:\n (as decimal separator a ',' or a '.' is allowed)\n hhmmss.ssTZD basic complete time\n hh:mm:ss.ssTZD extended complete time\n hhmm.mmTZD basic reduced accuracy time\n hh:mm.mmTZD extended reduced accuracy time\n hh.hhTZD basic reduced accuracy time\n TZD is the time zone designator which can be in the following format:\n no designator indicates local time zone\n Z UTC\n +-hhmm basic hours and minutes\n +-hh:mm extended hours and minutes\n +-hh hours\n \"\"\"\n isotimes = build_time_regexps()\n for pattern in isotimes:\n match = pattern.match(timestring)\n if match:\n groups = match.groupdict()\n for key, value in groups.items():\n if value is not None:\n groups[key] = value.replace(\",\", \".\")\n tzinfo = build_tzinfo(\n groups[\"tzname\"],\n groups[\"tzsign\"],\n int(groups[\"tzhour\"] or 0),\n int(groups[\"tzmin\"] or 0),\n )\n if \"second\" in groups:\n second = Decimal(groups[\"second\"]).quantize(\n Decimal(\".000001\"), rounding=ROUND_FLOOR\n )\n microsecond = (second - int(second)) * int(1e6)\n # int(...) ... no rounding\n # to_integral() ... rounding\n return time(\n int(groups[\"hour\"]),\n int(groups[\"minute\"]),\n int(second),\n int(microsecond.to_integral()),\n tzinfo,\n )\n if \"minute\" in groups:\n minute = Decimal(groups[\"minute\"])\n second = Decimal((minute - int(minute)) * 60).quantize(\n Decimal(\".000001\"), rounding=ROUND_FLOOR\n )\n microsecond = (second - int(second)) * int(1e6)\n return time(\n int(groups[\"hour\"]),\n int(minute),\n int(second),\n int(microsecond.to_integral()),\n tzinfo,\n )\n else:\n microsecond, second, minute = Decimal(0), Decimal(0), Decimal(0)\n hour = Decimal(groups[\"hour\"])\n minute = (hour - int(hour)) * 60\n second = Decimal((minute - int(minute)) * 60)\n microsecond = (second - int(second)) * int(1e6)\n return time(\n int(hour),\n int(minute),\n int(second),\n int(microsecond.to_integral()),\n tzinfo,\n )\n raise ISO8601Error(\"Unrecognised ISO 8601 time format: %r\" % timestring)\n\n\ndef time_isoformat(\n ttime: Union[timedelta, Duration, time, date], format: str = TIME_EXT_COMPLETE + TZ_EXT\n) -> str:\n \"\"\"Format time strings.\n\n This method is just a wrapper around isodate.isostrf.strftime and uses\n Time-Extended-Complete with extended time zone as default format.\n \"\"\"\n return strftime(ttime, format)\n\n[end of src/isodate/isotime.py]","filename":"src/isodate/isotime.py","id":"16"},{"content":"[end of src/isodate/py.typed]","filename":"src/isodate/py.typed","id":"17"},{"content":"\"\"\"This module provides an ISO 8601:2004 time zone info parser.\n\nIt offers a function to parse the time zone offset as specified by ISO 8601.\n\"\"\"\n\nimport re\nfrom datetime import datetime, tzinfo\nfrom typing import Union\n\nfrom isodate.isoerror import ISO8601Error\nfrom isodate.tzinfo import UTC, ZERO, FixedOffset, Utc\n\nTZ_REGEX = r\"(?P<tzname>(Z|(?P<tzsign>[+-])\" r\"(?P<tzhour>[0-9]{2})(:?(?P<tzmin>[0-9]{2}))?)?)\"\n\nTZ_RE = re.compile(TZ_REGEX)\n\n\ndef build_tzinfo(\n tzname: Union[str, None], tzsign: str = \"+\", tzhour: float = 0, tzmin: float = 0\n) -> Union[FixedOffset, Utc, None]:\n \"\"\"\n create a tzinfo instance according to given parameters.\n\n tzname:\n 'Z' ... return UTC\n '' | None ... return None\n other ... return FixedOffset\n \"\"\"\n if tzname is None or tzname == \"\":\n return None\n if tzname == \"Z\":\n return UTC\n tzsignum = ((tzsign == \"-\") and -1) or 1\n return FixedOffset(tzsignum * tzhour, tzsignum * tzmin, tzname)\n\n\ndef parse_tzinfo(tzstring: str) -> Union[tzinfo, None]:\n \"\"\"Parses ISO 8601 time zone designators to tzinfo objects.\n\n A time zone designator can be in the following format:\n no designator indicates local time zone\n Z UTC\n +-hhmm basic hours and minutes\n +-hh:mm extended hours and minutes\n +-hh hours\n \"\"\"\n match = TZ_RE.match(tzstring)\n if match:\n groups = match.groupdict()\n return build_tzinfo(\n groups[\"tzname\"],\n groups[\"tzsign\"],\n int(groups[\"tzhour\"] or 0),\n int(groups[\"tzmin\"] or 0),\n )\n raise ISO8601Error(\"%s not a valid time zone info\" % tzstring)\n\n\ndef tz_isoformat(dt: datetime, format: str = \"%Z\") -> str:\n \"\"\"Return time zone offset ISO 8601 formatted.\n\n The various ISO formats can be chosen with the format parameter.\n\n if tzinfo is None returns ''\n if tzinfo is UTC returns 'Z'\n else the offset is rendered to the given format.\n format:\n %h ... +-HH\n %z ... +-HHMM\n %Z ... +-HH:MM\n \"\"\"\n tzinfo = dt.tzinfo\n if (tzinfo is None) or (tzinfo.utcoffset(dt) is None):\n return \"\"\n if tzinfo.utcoffset(dt) == ZERO and tzinfo.dst(dt) == ZERO:\n return \"Z\"\n tdelta = tzinfo.utcoffset(dt)\n if tdelta is None:\n return \"\"\n seconds = tdelta.days * 24 * 60 * 60 + tdelta.seconds\n sign = ((seconds < 0) and \"-\") or \"+\"\n seconds = abs(seconds)\n minutes, seconds = divmod(seconds, 60)\n hours, minutes = divmod(minutes, 60)\n if hours > 99:\n raise OverflowError(\"can not handle differences > 99 hours\")\n if format == \"%Z\":\n return \"%s%02d:%02d\" % (sign, hours, minutes)\n elif format == \"%z\":\n return \"%s%02d%02d\" % (sign, hours, minutes)\n elif format == \"%h\":\n return \"%s%02d\" % (sign, hours)\n raise ValueError('unknown format string \"%s\"' % format)\n\n[end of src/isodate/isotzinfo.py]","filename":"src/isodate/isotzinfo.py","id":"18"},{"content":"\"\"\"This module defines a method to parse an ISO 8601:2004 date time string.\n\nFor this job it uses the parse_date and parse_time methods defined in date\nand time module.\n\"\"\"\n\nfrom __future__ import annotations\n\nfrom datetime import date, datetime, time, timedelta\n\nimport isodate\nfrom isodate.isodates import parse_date\nfrom isodate.isoerror import ISO8601Error\nfrom isodate.isostrf import DATE_EXT_COMPLETE, TIME_EXT_COMPLETE, TZ_EXT, strftime\nfrom isodate.isotime import parse_time\n\n\ndef parse_datetime(datetimestring: str) -> datetime:\n \"\"\"Parses ISO 8601 date-times into datetime.datetime objects.\n\n This function uses parse_date and parse_time to do the job, so it allows\n more combinations of date and time representations, than the actual\n ISO 8601:2004 standard allows.\n \"\"\"\n try:\n datestring, timestring = datetimestring.split(\"T\")\n except ValueError:\n raise ISO8601Error(\n \"ISO 8601 time designator 'T' missing. Unable to\"\n \" parse datetime string %r\" % datetimestring\n )\n tmpdate = parse_date(datestring)\n tmptime = parse_time(timestring)\n return datetime.combine(tmpdate, tmptime)\n\n\ndef datetime_isoformat(\n tdt: timedelta | isodate.isoduration.Duration | time | date,\n format: str = DATE_EXT_COMPLETE + \"T\" + TIME_EXT_COMPLETE + TZ_EXT,\n) -> str:\n \"\"\"Format datetime strings.\n\n This method is just a wrapper around isodate.isostrf.strftime and uses\n Extended-Complete as default format.\n \"\"\"\n return strftime(tdt, format)\n\n[end of src/isodate/isodatetime.py]","filename":"src/isodate/isodatetime.py","id":"19"}],"string":"[\n {\n \"content\": \"TODOs\\n=====\\n\\nThis to do list contains some thoughts and ideas about missing features, and\\nparts to think about, whether to implement them or not. This list is probably\\nnot complete.\\n\\nMissing features:\\n-----------------\\n\\n * time formatting does not allow to create fractional representations.\\n * parser for ISO intervals.\\n * currently microseconds are always padded to a length of 6 characters.\\n trailing 0s should be optional\\n\\nDocumentation:\\n--------------\\n\\n * parse_datetime:\\n - complete documentation to show what this function allows, but ISO forbids.\\n and vice verse.\\n - support other separators between date and time than 'T'\\n\\n * parse_date:\\n - yeardigits should be always greater than 4\\n - dates before 0001-01-01 are not supported\\n\\n * parse_duration:\\n - alternative formats are not fully supported due to parse_date restrictions\\n - standard duration format is fully supported but not very restrictive.\\n\\n * Duration:\\n - support fractional years and month in calculations\\n - implement w3c order relation? (`<http://www.w3.org/TR/xmlschema-2/#duration-order>`_)\\n - refactor to have duration mathematics only at one place.\\n - localize __str__ method (does timedelta do this?)\\n - when is a Duration negative?\\n - normalize Durations. months [00-12] and years ]-inf,+inf[\\n\\n[end of TODO.txt]\",\n \"filename\": \"TODO.txt\",\n \"id\": \"0\"\n },\n {\n \"content\": \"Copyright (c) 2021, Hugo van Kemenade and contributors\\nCopyright (c) 2009-2018, Gerhard Weis and contributors\\nCopyright (c) 2009, Gerhard Weis\\nAll rights reserved.\\n\\nRedistribution and use in source and binary forms, with or without\\nmodification, 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 the <organization> 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\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \\\"AS IS\\\" AND\\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\\nDISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY\\nDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\\nON 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\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"repos:\\n - repo: https://github.com/asottile/pyupgrade\\n rev: v3.17.0\\n hooks:\\n - id: pyupgrade\\n args: [--py39-plus]\\n\\n - repo: https://github.com/pycqa/flake8\\n rev: 7.1.1\\n hooks:\\n - id: flake8\\n args:\\n - \\\"--max-line-length=100\\\"\\n\\n - repo: https://github.com/pre-commit/pygrep-hooks\\n rev: v1.10.0\\n hooks:\\n - id: python-check-blanket-noqa\\n\\n - repo: https://github.com/pre-commit/pre-commit-hooks\\n rev: v5.0.0\\n hooks:\\n - id: check-merge-conflict\\n - id: check-yaml\\n - id: end-of-file-fixer\\n - id: trailing-whitespace\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[project]\\nname = \\\"isodate\\\"\\ndescription = \\\"An ISO 8601 date/time/duration parser and formatter\\\"\\nauthors = [{name=\\\"Gerhard Weis\\\"}]\\n# keywords =\\nlicense = {file = \\\"LICENSE\\\"}\\n# license = {text=\\\"BSD-3-Clause\\\"}\\nclassifiers = [\\n \\\"Development Status :: 4 - Beta\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Programming Language :: Python :: 3.10\\\",\\n \\\"Programming Language :: Python :: 3.11\\\",\\n \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: Implementation :: CPython\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Topic :: Internet\\\",\\n \\\"Topic :: Software Development :: Libraries :: Python Modules\\\",\\n]\\nrequires-python = \\\">=3.9\\\"\\ndynamic = [\\\"version\\\", \\\"readme\\\"]\\n\\n[project.urls]\\nHomepage = \\\"https://github.com/gweis/isodate/\\\"\\n\\n[tool.setuptools.dynamic]\\nreadme = {file=[\\\"README.rst\\\", \\\"CHANGES.txt\\\", \\\"TODO.txt\\\"], content-type=\\\"text/x-rst\\\"}\\n\\n\\n[build-system]\\nrequires = [\\\"setuptools\\\", \\\"setuptools_scm[toml]\\\"]\\nbuild-backend = \\\"setuptools.build_meta\\\"\\n\\n[tool.setuptools_scm]\\nwrite_to = \\\"src/isodate/version.py\\\"\\nfallback_version = \\\"0.0.0.dev0\\\"\\n\\n\\n[tool.pytest.ini_options]\\ntestpaths = [\\\"tests\\\"]\\nfilterwarnings = [\\n # treat all warnings as errors\\n \\\"error\\\",\\n # ignore:<regexp>\\n # e.g.:\\n # ignore:jsonschema.RefResolver is deprecated as of v4.18.0\\n]\\njunit_family = \\\"xunit2\\\"\\n\\n[tool.coverage.run]\\nsource_pkgs = [\\\"isodate\\\"]\\nomit = [\\\"tests/\\\"]\\n\\n[tool.black]\\nline-length = 100\\n\\n[tool.isort]\\nprofile = \\\"black\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include CHANGES.txt\\ninclude TODO.txt\\ninclude src/isodate/py.typed\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"CHANGES\\n=======\\n\\n0.7.3 (unreleased)\\n------------------\\n\\n- Drop support for Python < 3.9\\n- add type hints\\n\\n\\n0.7.2 (2024-10-08)\\n------------------\\n\\n- drop end of life python versions\\n- Don't match garbage characters at the end of parsed strings #16 (Gabriel de Perthuis)\\n\\n\\nPotentially breaking changes:\\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\\n\\n- Fractional seconds are cut off to microseconds (always round down)\\n- Allow control over return type of parse_duration #64 (Felix Claessen)\\n- Python >= 3.7 required\\n\\n\\n0.6.1 (2021-12-13)\\n------------------\\n\\n- support python 3.10 (Hugo van Kemenade)\\n- last version to support py 2.7\\n\\n\\n0.6.0 (2017-10-13)\\n------------------\\n\\n- support incomplete month date (Fabien Loffredo)\\n- rely on duck typing when doing duration maths\\n- support ':' as separator in fractional time zones (usrenmae)\\n\\n\\n0.5.4 (2015-08-06)\\n------------------\\n\\n- Fix parsing of Periods (Fabien Bochu)\\n- Make Duration objects hashable (Geoffrey Fairchild)\\n- Add multiplication to duration (Reinoud Elhorst)\\n\\n\\n0.5.1 (2014-11-07)\\n------------------\\n\\n- fixed pickling of Duration objects\\n- raise ISO8601Error when there is no 'T' separator in datetime strings (Adrian Coveney)\\n\\n\\n0.5.0 (2014-02-23)\\n------------------\\n\\n- ISO8601Error are subclasses of ValueError now (Michael Hrivnak)\\n- improve compatibility across various python variants and versions\\n- raise exceptions when using fractional years and months in date\\n maths with durations\\n- renamed method todatetime on Duraction objects to totimedelta\\n\\n\\n0.4.9 (2012-10-30)\\n------------------\\n\\n- support pickling FixedOffset instances\\n- make sure parsed fractional seconds are in microseconds\\n- add leading zeros when formattig microseconds (Jarom Loveridge)\\n\\n\\n0.4.8 (2012-05-04)\\n------------------\\n\\n- fixed incompatibility of unittests with python 2.5 and 2.6 (runs fine on 2.7\\n and 3.2)\\n\\n\\n0.4.7 (2012-01-26)\\n------------------\\n\\n- fixed tzinfo formatting (never pass None into tzinfo.utcoffset())\\n\\n\\n0.4.6 (2012-01-06)\\n------------------\\n\\n- added Python 3 compatibility via 2to3\\n\\n0.4.5 (2012-01-06)\\n------------------\\n\\n- made setuptools dependency optional\\n\\n0.4.4 (2011-04-16)\\n------------------\\n\\n- Fixed formatting of microseconds for datetime objects\\n\\n0.4.3 (2010-10-29)\\n------------------\\n\\n- Fixed problem with %P formatting and fractions (supplied by David Brooks)\\n\\n0.4.2 (2010-10-28)\\n------------------\\n\\n- Implemented unary - for Duration (supplied by David Brooks)\\n- Output fractional seconds with '%P' format. (partly supplied by David Brooks)\\n\\n0.4.1 (2010-10-13)\\n------------------\\n\\n- fixed bug in comparison between timedelta and Duration.\\n- fixed precision problem with microseconds (reported by Tommi Virtanen)\\n\\n0.4.0 (2009-02-09)\\n------------------\\n\\n- added method to parse ISO 8601 time zone strings\\n- added methods to create ISO 8601 conforming strings\\n\\n0.3.0 (2009-1-05)\\n------------------\\n\\n- Initial release\\n\\n[end of CHANGES.txt]\",\n \"filename\": \"CHANGES.txt\",\n \"id\": \"5\"\n },\n {\n \"content\": \"[tox]\\nisolated_build = True\\nenvlist =\\n lint\\n py{39, 310, 311, 312, py39}\\n\\n[testenv]\\ndeps =\\n pytest\\n pytest-cov\\nsetenv =\\n PYTHONWARNINGS = default\\ncommands =\\n pytest\\n # {envpython} setup.py clean --all\\n # pytest --cov=isodate --cov-report=xml\\n\\n[testenv:lint]\\ndeps = pre-commit\\ncommands = pre-commit run --all-files\\nskip_install = true\\npassenv = PRE_COMMIT_COLOR\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"6\"\n },\n {\n \"content\": \"ISO 8601 date/time parser\\n=========================\\n\\n.. image:: https://travis-ci.org/gweis/isodate.svg?branch=master\\n :target: https://travis-ci.org/gweis/isodate\\n :alt: Travis-CI\\n.. image:: https://coveralls.io/repos/gweis/isodate/badge.svg?branch=master\\n :target: https://coveralls.io/r/gweis/isodate?branch=master\\n :alt: Coveralls\\n.. image:: https://img.shields.io/pypi/v/isodate.svg\\n :target: https://pypi.python.org/pypi/isodate/\\n :alt: Latest Version\\n.. image:: https://img.shields.io/pypi/l/isodate.svg\\n :target: https://pypi.python.org/pypi/isodate/\\n :alt: License\\n\\n\\nThis module implements ISO 8601 date, time and duration parsing.\\nThe implementation follows ISO8601:2004 standard, and implements only\\ndate/time representations mentioned in the standard. If something is not\\nmentioned there, then it is treated as non existent, and not as an allowed\\noption.\\n\\nFor instance, ISO8601:2004 never mentions 2 digit years. So, it is not\\nintended by this module to support 2 digit years. (while it may still\\nbe valid as ISO date, because it is not explicitly forbidden.)\\nAnother example is, when no time zone information is given for a time,\\nthen it should be interpreted as local time, and not UTC.\\n\\nAs this module maps ISO 8601 dates/times to standard Python data types, like\\n*date*, *time*, *datetime* and *timedelta*, it is not possible to convert\\nall possible ISO 8601 dates/times. For instance, dates before 0001-01-01 are\\nnot allowed by the Python *date* and *datetime* classes. Additionally\\nfractional seconds are limited to microseconds. That means if the parser finds\\nfor instance nanoseconds it will round it down to microseconds.\\n\\nDocumentation\\n-------------\\n\\nThe following parsing methods are available.\\n * parse_time:\\n parses an ISO 8601 time string into a *time* object\\n * parse_date:\\n parses an ISO 8601 date string into a *date* object\\n * parse_datetime:\\n parses an ISO 8601 date-time string into a *datetime* object\\n * parse_duration:\\n parses an ISO 8601 duration string into a *timedelta* or *Duration*\\n object.\\n * parse_tzinfo:\\n parses the time zone info part of an ISO 8601 string into a\\n *tzinfo* object.\\n\\nAs ISO 8601 allows to define durations in years and months, and *timedelta*\\ndoes not handle years and months, this module provides a *Duration* class,\\nwhich can be used almost like a *timedelta* object (with some limitations).\\nHowever, a *Duration* object can be converted into a *timedelta* object.\\n\\nThere are also ISO formatting methods for all supported data types. Each\\n*xxx_isoformat* method accepts a format parameter. The default format is\\nalways the ISO 8601 expanded format. This is the same format used by\\n*datetime.isoformat*:\\n\\n * time_isoformat:\\n Intended to create ISO time strings with default format\\n *hh:mm:ssZ*.\\n * date_isoformat:\\n Intended to create ISO date strings with default format\\n *yyyy-mm-dd*.\\n * datetime_isoformat:\\n Intended to create ISO date-time strings with default format\\n *yyyy-mm-ddThh:mm:ssZ*.\\n * duration_isoformat:\\n Intended to create ISO duration strings with default format\\n *PnnYnnMnnDTnnHnnMnnS*.\\n * tz_isoformat:\\n Intended to create ISO time zone strings with default format\\n *hh:mm*.\\n * strftime:\\n A re-implementation mostly compatible with Python's *strftime*, but\\n supports only those format strings, which can also be used for dates\\n prior 1900. This method also understands how to format *datetime* and\\n *Duration* instances.\\n\\nInstallation\\n------------\\n\\nThis module can easily be installed with Python standard installation methods.\\n\\nUse *pip install isodate*.\\n\\nLimitations\\n-----------\\n\\n * The parser accepts several date/time representation which should be invalid\\n according to ISO 8601 standard.\\n\\n 1. for date and time together, this parser accepts a mixture of basic and extended format.\\n e.g. the date could be in basic format, while the time is accepted in extended format.\\n It also allows short dates and times in date-time strings.\\n 2. For incomplete dates, the first day is chosen. e.g. 19th century results in a date of\\n 1901-01-01.\\n 3. negative *Duration* and *timedelta* value are not fully supported yet.\\n\\nFurther information\\n-------------------\\n\\nThe doc strings and unit tests should provide rather detailed information about\\nthe methods and their limitations.\\n\\nThe source release provides a *setup.py* script,\\nwhich can be used to run the unit tests included.\\n\\nSource code is available at `<https://github.com/gweis/isodate>`_.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"[end of src/py.typed]\",\n \"filename\": \"src/py.typed\",\n \"id\": \"8\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This module provides some datetime.tzinfo implementations.\\n\\nAll those classes are taken from the Python documentation.\\n\\\"\\\"\\\"\\n\\nimport time\\nfrom datetime import datetime, timedelta, tzinfo\\nfrom typing import Literal, Optional\\n\\nZERO = timedelta(0)\\n# constant for zero time offset.\\n\\n\\nclass Utc(tzinfo):\\n \\\"\\\"\\\"UTC\\n\\n Universal time coordinated time zone.\\n \\\"\\\"\\\"\\n\\n def utcoffset(self, dt: Optional[datetime]) -> timedelta:\\n \\\"\\\"\\\"Return offset from UTC in minutes east of UTC, which is ZERO for UTC.\\\"\\\"\\\"\\n return ZERO\\n\\n def tzname(self, dt: Optional[datetime]) -> Literal[\\\"UTC\\\"]:\\n \\\"\\\"\\\"Return the time zone name corresponding to the datetime object dt,\\n as a string.\\n \\\"\\\"\\\"\\n return \\\"UTC\\\"\\n\\n def dst(self, dt: Optional[datetime]) -> timedelta:\\n \\\"\\\"\\\"Return the daylight saving time (DST) adjustment, in minutes east\\n of UTC.\\n \\\"\\\"\\\"\\n return ZERO\\n\\n def __reduce__(self):\\n \\\"\\\"\\\"When unpickling a Utc object, return the default instance below, UTC.\\\"\\\"\\\"\\n return _Utc, ()\\n\\n\\nUTC = Utc()\\n# the default instance for UTC.\\n\\n\\ndef _Utc() -> Utc:\\n \\\"\\\"\\\"Helper function for unpickling a Utc object.\\\"\\\"\\\"\\n return UTC\\n\\n\\nclass FixedOffset(tzinfo):\\n \\\"\\\"\\\"A class building tzinfo objects for fixed-offset time zones.\\n\\n Note that FixedOffset(0, 0, \\\"UTC\\\") or FixedOffset() is a different way to\\n build a UTC tzinfo object.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self, offset_hours: float = 0, offset_minutes: float = 0, name: str = \\\"UTC\\\"\\n ) -> None:\\n \\\"\\\"\\\"Initialise an instance with time offset and name.\\n\\n The time offset should be positive for time zones east of UTC\\n and negate for time zones west of UTC.\\n \\\"\\\"\\\"\\n self.__offset = timedelta(hours=offset_hours, minutes=offset_minutes)\\n self.__name = name\\n\\n def utcoffset(self, dt: Optional[datetime]) -> timedelta:\\n \\\"\\\"\\\"Return offset from UTC in minutes of UTC.\\\"\\\"\\\"\\n return self.__offset\\n\\n def tzname(self, dt: Optional[datetime]) -> str:\\n \\\"\\\"\\\"Return the time zone name corresponding to the datetime object dt, as a\\n string.\\n \\\"\\\"\\\"\\n return self.__name\\n\\n def dst(self, dt: Optional[datetime]) -> timedelta:\\n \\\"\\\"\\\"Return the daylight saving time (DST) adjustment, in minutes east of\\n UTC.\\n \\\"\\\"\\\"\\n return ZERO\\n\\n def __repr__(self) -> str:\\n \\\"\\\"\\\"Return nicely formatted repr string.\\\"\\\"\\\"\\n return \\\"<FixedOffset %r>\\\" % self.__name\\n\\n\\nSTDOFFSET = timedelta(seconds=-time.timezone)\\n# locale time zone offset\\n\\n# calculate local daylight saving offset if any.\\nDSTOFFSET = timedelta(seconds=-time.altzone) if time.daylight else STDOFFSET\\n\\nDSTDIFF = DSTOFFSET - STDOFFSET\\n# difference between local time zone and local DST time zone\\n\\n\\nclass LocalTimezone(tzinfo):\\n \\\"\\\"\\\"A class capturing the platform's idea of local time.\\\"\\\"\\\"\\n\\n def utcoffset(self, dt: Optional[datetime]) -> timedelta:\\n \\\"\\\"\\\"Return offset from UTC in minutes of UTC.\\\"\\\"\\\"\\n if self._isdst(dt):\\n return DSTOFFSET\\n else:\\n return STDOFFSET\\n\\n def dst(self, dt: Optional[datetime]) -> timedelta:\\n \\\"\\\"\\\"Return daylight saving offset.\\\"\\\"\\\"\\n if self._isdst(dt):\\n return DSTDIFF\\n else:\\n return ZERO\\n\\n def tzname(self, dt: Optional[datetime]) -> str:\\n \\\"\\\"\\\"Return the time zone name corresponding to the datetime object dt, as a\\n string.\\n \\\"\\\"\\\"\\n return time.tzname[self._isdst(dt)]\\n\\n def _isdst(self, dt: Optional[datetime]) -> bool:\\n \\\"\\\"\\\"Returns true if DST is active for given datetime object dt.\\\"\\\"\\\"\\n if dt is None:\\n raise Exception(\\\"datetime object dt was None!\\\")\\n tt = (\\n dt.year,\\n dt.month,\\n dt.day,\\n dt.hour,\\n dt.minute,\\n dt.second,\\n dt.weekday(),\\n 0,\\n -1,\\n )\\n stamp = time.mktime(tt)\\n tt = time.localtime(stamp)\\n return tt.tm_isdst > 0\\n\\n\\n# the default instance for local time zone.\\nLOCAL = LocalTimezone()\\n\\n[end of src/isodate/tzinfo.py]\",\n \"filename\": \"src/isodate/tzinfo.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This module defines a Duration class.\\n\\nThe class Duration allows to define durations in years and months and can be\\nused as limited replacement for timedelta objects.\\n\\\"\\\"\\\"\\n\\nfrom __future__ import annotations\\n\\nfrom datetime import date, datetime, timedelta\\nfrom decimal import ROUND_FLOOR, Decimal\\n\\n\\ndef fquotmod(val: Decimal, low: int, high: int) -> tuple[int, Decimal]:\\n \\\"\\\"\\\"A divmod function with boundaries.\\\"\\\"\\\"\\n # assumes that all the maths is done with Decimals.\\n # divmod for Decimal uses truncate instead of floor as builtin\\n # divmod, so we have to do it manually here.\\n a, b = val - low, high - low\\n div = (a / b).to_integral(ROUND_FLOOR)\\n mod = a - div * b\\n # if we were not using Decimal, it would look like this.\\n # div, mod = divmod(val - low, high - low)\\n mod += low\\n return int(div), mod\\n\\n\\ndef max_days_in_month(year: int, month: int) -> int:\\n \\\"\\\"\\\"Determines the number of days of a specific month in a specific year.\\\"\\\"\\\"\\n if month in (1, 3, 5, 7, 8, 10, 12):\\n return 31\\n if month in (4, 6, 9, 11):\\n return 30\\n if ((year % 400) == 0) or ((year % 100) != 0) and ((year % 4) == 0):\\n return 29\\n return 28\\n\\n\\nclass Duration:\\n \\\"\\\"\\\"A class which represents a duration.\\n\\n The difference to datetime.timedelta is, that this class handles also\\n differences given in years and months.\\n A Duration treats differences given in year, months separately from all\\n other components.\\n\\n A Duration can be used almost like any timedelta object, however there\\n are some restrictions:\\n * It is not really possible to compare Durations, because it is unclear,\\n whether a duration of 1 year is bigger than 365 days or not.\\n * Equality is only tested between the two (year, month vs. timedelta)\\n basic components.\\n\\n A Duration can also be converted into a datetime object, but this requires\\n a start date or an end date.\\n\\n The algorithm to add a duration to a date is defined at\\n http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n days: float = 0,\\n seconds: float = 0,\\n microseconds: float = 0,\\n milliseconds: float = 0,\\n minutes: float = 0,\\n hours: float = 0,\\n weeks: float = 0,\\n months: float | Decimal = 0,\\n years: float | Decimal = 0,\\n ):\\n \\\"\\\"\\\"Initialise this Duration instance with the given parameters.\\\"\\\"\\\"\\n if not isinstance(months, Decimal):\\n months = Decimal(str(months))\\n if not isinstance(years, Decimal):\\n years = Decimal(str(years))\\n self.months = months\\n self.years = years\\n self.tdelta = timedelta(days, seconds, microseconds, milliseconds, minutes, hours, weeks)\\n\\n def __getstate__(self):\\n return self.__dict__\\n\\n def __setstate__(self, state):\\n self.__dict__.update(state)\\n\\n def __getattr__(self, name: str):\\n \\\"\\\"\\\"Provide direct access to attributes of included timedelta instance.\\\"\\\"\\\"\\n return getattr(self.tdelta, name)\\n\\n def __str__(self):\\n \\\"\\\"\\\"Return a string representation of this duration similar to timedelta.\\\"\\\"\\\"\\n params: list[str] = []\\n if self.years:\\n params.append(\\\"%s years\\\" % self.years)\\n if self.months:\\n fmt = \\\"%s months\\\"\\n if self.months <= 1:\\n fmt = \\\"%s month\\\"\\n params.append(fmt % self.months)\\n params.append(str(self.tdelta))\\n return \\\", \\\".join(params)\\n\\n def __repr__(self):\\n \\\"\\\"\\\"Return a string suitable for repr(x) calls.\\\"\\\"\\\"\\n return \\\"{}.{}({}, {}, {}, years={}, months={})\\\".format(\\n self.__class__.__module__,\\n self.__class__.__name__,\\n self.tdelta.days,\\n self.tdelta.seconds,\\n self.tdelta.microseconds,\\n self.years,\\n self.months,\\n )\\n\\n def __hash__(self):\\n \\\"\\\"\\\"Return a hash of this instance.\\n\\n So that it can be used in, for example, dicts and sets.\\n \\\"\\\"\\\"\\n return hash((self.tdelta, self.months, self.years))\\n\\n def __neg__(self):\\n \\\"\\\"\\\"A simple unary minus.\\n\\n Returns a new Duration instance with all it's negated.\\n \\\"\\\"\\\"\\n negduration = Duration(years=-self.years, months=-self.months)\\n negduration.tdelta = -self.tdelta\\n return negduration\\n\\n def __add__(self, other: Duration | timedelta | date | datetime) -> Duration | date | datetime:\\n \\\"\\\"\\\"+ operator for Durations.\\n\\n Durations can be added with Duration, timedelta, date and datetime objects.\\n \\\"\\\"\\\"\\n if isinstance(other, Duration):\\n newduration = Duration(\\n years=self.years + other.years, months=self.months + other.months\\n )\\n newduration.tdelta = self.tdelta + other.tdelta\\n return newduration\\n elif isinstance(other, (date, datetime)):\\n # try anything that looks like a date or datetime\\n # 'other' has attributes year, month, day\\n # and relies on 'timedelta + other' being implemented\\n if not (float(self.years).is_integer() and float(self.months).is_integer()):\\n raise ValueError(\\n \\\"fractional years or months not supported\\\" \\\" for date calculations\\\"\\n )\\n newmonth = other.month + self.months\\n carry, newmonth = fquotmod(newmonth, 1, 13)\\n newyear = other.year + self.years + carry\\n maxdays = max_days_in_month(int(newyear), int(newmonth))\\n if other.day > maxdays:\\n newday = maxdays\\n else:\\n newday = other.day\\n newdt = other.replace(year=int(newyear), month=int(newmonth), day=int(newday))\\n # does a timedelta + date/datetime\\n return self.tdelta + newdt\\n elif isinstance(other, timedelta):\\n # try if other is a timedelta\\n # relies on timedelta + timedelta supported\\n newduration = Duration(years=self.years, months=self.months)\\n newduration.tdelta = self.tdelta + other\\n return newduration\\n # we have tried everything .... return a NotImplemented\\n return NotImplemented\\n\\n __radd__ = __add__\\n\\n def __mul__(self, other: int) -> Duration:\\n if isinstance(other, int):\\n newduration = Duration(years=self.years * other, months=self.months * other)\\n newduration.tdelta = self.tdelta * other\\n return newduration\\n return NotImplemented\\n\\n __rmul__ = __mul__\\n\\n def __sub__(self, other: Duration | timedelta) -> Duration:\\n \\\"\\\"\\\"- operator for Durations.\\n\\n It is possible to subtract Duration and timedelta objects from Duration\\n objects.\\n \\\"\\\"\\\"\\n if isinstance(other, Duration):\\n newduration = Duration(\\n years=self.years - other.years, months=self.months - other.months\\n )\\n newduration.tdelta = self.tdelta - other.tdelta\\n return newduration\\n try:\\n # do maths with our timedelta object ....\\n newduration = Duration(years=self.years, months=self.months)\\n newduration.tdelta = self.tdelta - other\\n return newduration\\n except TypeError:\\n # looks like timedelta - other is not implemented\\n pass\\n return NotImplemented\\n\\n def __rsub__(self, other: Duration | date | datetime | timedelta):\\n \\\"\\\"\\\"- operator for Durations.\\n\\n It is possible to subtract Duration objects from date, datetime and\\n timedelta objects.\\n\\n TODO: there is some weird behaviour in date - timedelta ...\\n if timedelta has seconds or microseconds set, then\\n date - timedelta != date + (-timedelta)\\n for now we follow this behaviour to avoid surprises when mixing\\n timedeltas with Durations, but in case this ever changes in\\n the stdlib we can just do:\\n return -self + other\\n instead of all the current code\\n \\\"\\\"\\\"\\n if isinstance(other, timedelta):\\n tmpdur = Duration()\\n tmpdur.tdelta = other\\n return tmpdur - self\\n try:\\n # check if other behaves like a date/datetime object\\n # does it have year, month, day and replace?\\n if not (float(self.years).is_integer() and float(self.months).is_integer()):\\n raise ValueError(\\n \\\"fractional years or months not supported\\\" \\\" for date calculations\\\"\\n )\\n newmonth = other.month - self.months\\n carry, newmonth = fquotmod(newmonth, 1, 13)\\n newyear = other.year - self.years + carry\\n maxdays = max_days_in_month(int(newyear), int(newmonth))\\n if other.day > maxdays:\\n newday = maxdays\\n else:\\n newday = other.day\\n newdt = other.replace(year=int(newyear), month=int(newmonth), day=int(newday))\\n return newdt - self.tdelta\\n except AttributeError:\\n # other probably was not compatible with data/datetime\\n pass\\n return NotImplemented\\n\\n def __eq__(self, other: object) -> bool:\\n \\\"\\\"\\\"== operator.\\n\\n If the years, month part and the timedelta part are both equal, then\\n the two Durations are considered equal.\\n \\\"\\\"\\\"\\n if isinstance(other, Duration):\\n if (self.years * 12 + self.months) == (\\n other.years * 12 + other.months\\n ) and self.tdelta == other.tdelta:\\n return True\\n return False\\n # check if other con be compared against timedelta object\\n # will raise an AssertionError when optimisation is off\\n if self.years == 0 and self.months == 0:\\n return self.tdelta == other\\n return False\\n\\n def __ne__(self, other: object) -> bool:\\n \\\"\\\"\\\"!= operator.\\n\\n If the years, month part or the timedelta part is not equal, then\\n the two Durations are considered not equal.\\n \\\"\\\"\\\"\\n if isinstance(other, Duration):\\n if (self.years * 12 + self.months) != (\\n other.years * 12 + other.months\\n ) or self.tdelta != other.tdelta:\\n return True\\n return False\\n # check if other can be compared against timedelta object\\n # will raise an AssertionError when optimisation is off\\n if self.years == 0 and self.months == 0:\\n return self.tdelta != other\\n return True\\n\\n def totimedelta(\\n self, start: date | datetime | None = None, end: date | datetime | None = None\\n ) -> timedelta:\\n \\\"\\\"\\\"Convert this duration into a timedelta object.\\n\\n This method requires a start datetime or end datetimem, but raises\\n an exception if both are given.\\n \\\"\\\"\\\"\\n if start is None and end is None:\\n raise ValueError(\\\"start or end required\\\")\\n if start is not None and end is not None:\\n raise ValueError(\\\"only start or end allowed\\\")\\n if start is not None:\\n # TODO: ignore type error ... false positive in mypy or wrong type annotation in\\n # __rsub__ ?\\n return (start + self) - start # type: ignore [operator, return-value]\\n # ignore typ error ... false positive in mypy\\n return end - (end - self) # type: ignore [operator]\\n\\n[end of src/isodate/duration.py]\",\n \"filename\": \"src/isodate/duration.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This modules provides a method to parse an ISO 8601:2004 date string to a\\npython datetime.date instance.\\n\\nIt supports all basic, extended and expanded formats as described in the ISO\\nstandard. The only limitations it has, are given by the Python datetime.date\\nimplementation, which does not support dates before 0001-01-01.\\n\\\"\\\"\\\"\\n\\nimport re\\nfrom datetime import date, time, timedelta\\nfrom typing import Union\\n\\nfrom isodate.duration import Duration\\nfrom isodate.isoerror import ISO8601Error\\nfrom isodate.isostrf import DATE_EXT_COMPLETE, strftime\\n\\nDATE_REGEX_CACHE: dict[tuple[int, bool], list[re.Pattern[str]]] = {}\\n# A dictionary to cache pre-compiled regular expressions.\\n# A set of regular expressions is identified, by number of year digits allowed\\n# and whether a plus/minus sign is required or not. (This option is changeable\\n# only for 4 digit years).\\n\\n\\ndef build_date_regexps(yeardigits: int = 4, expanded: bool = False) -> list[re.Pattern[str]]:\\n \\\"\\\"\\\"Compile set of regular expressions to parse ISO dates.\\n\\n The expressions will be created only if they are not already in REGEX_CACHE.\\n\\n It is necessary to fix the number of year digits, else it is not possible\\n to automatically distinguish between various ISO date formats.\\n\\n ISO 8601 allows more than 4 digit years, on prior agreement, but then a +/-\\n sign is required (expanded format). To support +/- sign for 4 digit years,\\n the expanded parameter needs to be set to True.\\n \\\"\\\"\\\"\\n if yeardigits != 4:\\n expanded = True\\n if (yeardigits, expanded) not in DATE_REGEX_CACHE:\\n cache_entry: list[re.Pattern[str]] = []\\n # ISO 8601 expanded DATE formats allow an arbitrary number of year\\n # digits with a leading +/- sign.\\n if expanded:\\n sign = 1\\n else:\\n sign = 0\\n\\n def add_re(regex_text: str) -> None:\\n cache_entry.append(re.compile(r\\\"\\\\A\\\" + regex_text + r\\\"\\\\Z\\\"))\\n\\n # 1. complete dates:\\n # YYYY-MM-DD or +- YYYYYY-MM-DD... extended date format\\n add_re(\\n r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\"\\n r\\\"-(?P<month>[0-9]{2})-(?P<day>[0-9]{2})\\\" % (sign, yeardigits)\\n )\\n # YYYYMMDD or +- YYYYYYMMDD... basic date format\\n add_re(\\n r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\"\\n r\\\"(?P<month>[0-9]{2})(?P<day>[0-9]{2})\\\" % (sign, yeardigits)\\n )\\n # 2. complete week dates:\\n # YYYY-Www-D or +-YYYYYY-Www-D ... extended week date\\n add_re(\\n r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\"\\n r\\\"-W(?P<week>[0-9]{2})-(?P<day>[0-9]{1})\\\" % (sign, yeardigits)\\n )\\n # YYYYWwwD or +-YYYYYYWwwD ... basic week date\\n add_re(\\n r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})W\\\"\\n r\\\"(?P<week>[0-9]{2})(?P<day>[0-9]{1})\\\" % (sign, yeardigits)\\n )\\n # 3. ordinal dates:\\n # YYYY-DDD or +-YYYYYY-DDD ... extended format\\n add_re(r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\" r\\\"-(?P<day>[0-9]{3})\\\" % (sign, yeardigits))\\n # YYYYDDD or +-YYYYYYDDD ... basic format\\n add_re(r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\" r\\\"(?P<day>[0-9]{3})\\\" % (sign, yeardigits))\\n # 4. week dates:\\n # YYYY-Www or +-YYYYYY-Www ... extended reduced accuracy week date\\n # 4. week dates:\\n # YYYY-Www or +-YYYYYY-Www ... extended reduced accuracy week date\\n add_re(\\n r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\" r\\\"-W(?P<week>[0-9]{2})\\\" % (sign, yeardigits)\\n )\\n # YYYYWww or +-YYYYYYWww ... basic reduced accuracy week date\\n add_re(r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})W\\\" r\\\"(?P<week>[0-9]{2})\\\" % (sign, yeardigits))\\n # 5. month dates:\\n # YYY-MM or +-YYYYYY-MM ... reduced accuracy specific month\\n # 5. month dates:\\n # YYY-MM or +-YYYYYY-MM ... reduced accuracy specific month\\n add_re(\\n r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\" r\\\"-(?P<month>[0-9]{2})\\\" % (sign, yeardigits)\\n )\\n # YYYMM or +-YYYYYYMM ... basic incomplete month date format\\n add_re(r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\" r\\\"(?P<month>[0-9]{2})\\\" % (sign, yeardigits))\\n # 6. year dates:\\n # YYYY or +-YYYYYY ... reduced accuracy specific year\\n add_re(r\\\"(?P<sign>[+-]){%d}(?P<year>[0-9]{%d})\\\" % (sign, yeardigits))\\n # 7. century dates:\\n # YY or +-YYYY ... reduced accuracy specific century\\n add_re(r\\\"(?P<sign>[+-]){%d}\\\" r\\\"(?P<century>[0-9]{%d})\\\" % (sign, yeardigits - 2))\\n\\n DATE_REGEX_CACHE[(yeardigits, expanded)] = cache_entry\\n return DATE_REGEX_CACHE[(yeardigits, expanded)]\\n\\n\\ndef parse_date(\\n datestring: str,\\n yeardigits: int = 4,\\n expanded: bool = False,\\n defaultmonth: int = 1,\\n defaultday: int = 1,\\n) -> date:\\n \\\"\\\"\\\"Parse an ISO 8601 date string into a datetime.date object.\\n\\n As the datetime.date implementation is limited to dates starting from\\n 0001-01-01, negative dates (BC) and year 0 can not be parsed by this\\n method.\\n\\n For incomplete dates, this method chooses the first day for it. For\\n instance if only a century is given, this method returns the 1st of\\n January in year 1 of this century.\\n\\n supported formats: (expanded formats are shown with 6 digits for year)\\n YYYYMMDD +-YYYYYYMMDD basic complete date\\n YYYY-MM-DD +-YYYYYY-MM-DD extended complete date\\n YYYYWwwD +-YYYYYYWwwD basic complete week date\\n YYYY-Www-D +-YYYYYY-Www-D extended complete week date\\n YYYYDDD +-YYYYYYDDD basic ordinal date\\n YYYY-DDD +-YYYYYY-DDD extended ordinal date\\n YYYYWww +-YYYYYYWww basic incomplete week date\\n YYYY-Www +-YYYYYY-Www extended incomplete week date\\n YYYMM +-YYYYYYMM basic incomplete month date\\n YYY-MM +-YYYYYY-MM incomplete month date\\n YYYY +-YYYYYY incomplete year date\\n YY +-YYYY incomplete century date\\n\\n @param datestring: the ISO date string to parse\\n @param yeardigits: how many digits are used to represent a year\\n @param expanded: if True then +/- signs are allowed. This parameter\\n is forced to True, if yeardigits != 4\\n\\n @return: a datetime.date instance represented by datestring\\n @raise ISO8601Error: if this function can not parse the datestring\\n @raise ValueError: if datestring can not be represented by datetime.date\\n \\\"\\\"\\\"\\n if yeardigits != 4:\\n expanded = True\\n isodates = build_date_regexps(yeardigits, expanded)\\n for pattern in isodates:\\n match = pattern.match(datestring)\\n if match:\\n groups = match.groupdict()\\n # sign, century, year, month, week, day,\\n # FIXME: negative dates not possible with python standard types\\n sign = (groups[\\\"sign\\\"] == \\\"-\\\" and -1) or 1\\n if \\\"century\\\" in groups:\\n return date(sign * (int(groups[\\\"century\\\"]) * 100 + 1), defaultmonth, defaultday)\\n if \\\"month\\\" not in groups: # weekdate or ordinal date\\n ret = date(sign * int(groups[\\\"year\\\"]), 1, 1)\\n if \\\"week\\\" in groups:\\n isotuple = ret.isocalendar()\\n if \\\"day\\\" in groups:\\n days = int(groups[\\\"day\\\"] or 1)\\n else:\\n days = 1\\n # if first week in year, do weeks-1\\n return ret + timedelta(\\n weeks=int(groups[\\\"week\\\"]) - (((isotuple[1] == 1) and 1) or 0),\\n days=-isotuple[2] + days,\\n )\\n elif \\\"day\\\" in groups: # ordinal date\\n return ret + timedelta(days=int(groups[\\\"day\\\"]) - 1)\\n else: # year date\\n return ret.replace(month=defaultmonth, day=defaultday)\\n # year-, month-, or complete date\\n if \\\"day\\\" not in groups or groups[\\\"day\\\"] is None:\\n day = defaultday\\n else:\\n day = int(groups[\\\"day\\\"])\\n return date(sign * int(groups[\\\"year\\\"]), int(groups[\\\"month\\\"]) or defaultmonth, day)\\n raise ISO8601Error(\\\"Unrecognised ISO 8601 date format: %r\\\" % datestring)\\n\\n\\ndef date_isoformat(\\n tdate: Union[timedelta, Duration, time, date],\\n format: str = DATE_EXT_COMPLETE,\\n yeardigits: int = 4,\\n) -> str:\\n \\\"\\\"\\\"Format date strings.\\n\\n This method is just a wrapper around isodate.isostrf.strftime and uses\\n Date-Extended-Complete as default format.\\n \\\"\\\"\\\"\\n return strftime(tdate, format, yeardigits)\\n\\n[end of src/isodate/isodates.py]\",\n \"filename\": \"src/isodate/isodates.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"\\\"\\\"\\\"\\nImport all essential functions and constants to re-export them here for easy\\naccess.\\n\\nThis module contains also various pre-defined ISO 8601 format strings.\\n\\\"\\\"\\\"\\n\\nfrom isodate.duration import Duration\\nfrom isodate.isodates import date_isoformat, parse_date\\nfrom isodate.isodatetime import datetime_isoformat, parse_datetime\\nfrom isodate.isoduration import duration_isoformat, parse_duration\\nfrom isodate.isoerror import ISO8601Error\\nfrom isodate.isostrf import (\\n D_ALT_BAS,\\n D_ALT_BAS_ORD,\\n D_ALT_EXT,\\n D_ALT_EXT_ORD,\\n D_DEFAULT,\\n D_WEEK,\\n DATE_BAS_COMPLETE,\\n DATE_BAS_MONTH,\\n DATE_BAS_ORD_COMPLETE,\\n DATE_BAS_WEEK,\\n DATE_BAS_WEEK_COMPLETE,\\n DATE_CENTURY,\\n DATE_EXT_COMPLETE,\\n DATE_EXT_MONTH,\\n DATE_EXT_ORD_COMPLETE,\\n DATE_EXT_WEEK,\\n DATE_EXT_WEEK_COMPLETE,\\n DATE_YEAR,\\n DT_BAS_COMPLETE,\\n DT_BAS_ORD_COMPLETE,\\n DT_BAS_WEEK_COMPLETE,\\n DT_EXT_COMPLETE,\\n DT_EXT_ORD_COMPLETE,\\n DT_EXT_WEEK_COMPLETE,\\n TIME_BAS_COMPLETE,\\n TIME_BAS_MINUTE,\\n TIME_EXT_COMPLETE,\\n TIME_EXT_MINUTE,\\n TIME_HOUR,\\n TZ_BAS,\\n TZ_EXT,\\n TZ_HOUR,\\n strftime,\\n)\\nfrom isodate.isotime import parse_time, time_isoformat\\nfrom isodate.isotzinfo import parse_tzinfo, tz_isoformat\\nfrom isodate.tzinfo import LOCAL, UTC, FixedOffset\\nfrom isodate.version import version as __version__\\n\\n__all__ = [\\n \\\"parse_date\\\",\\n \\\"date_isoformat\\\",\\n \\\"parse_time\\\",\\n \\\"time_isoformat\\\",\\n \\\"parse_datetime\\\",\\n \\\"datetime_isoformat\\\",\\n \\\"parse_duration\\\",\\n \\\"duration_isoformat\\\",\\n \\\"ISO8601Error\\\",\\n \\\"parse_tzinfo\\\",\\n \\\"tz_isoformat\\\",\\n \\\"UTC\\\",\\n \\\"FixedOffset\\\",\\n \\\"LOCAL\\\",\\n \\\"Duration\\\",\\n \\\"strftime\\\",\\n \\\"DATE_BAS_COMPLETE\\\",\\n \\\"DATE_BAS_ORD_COMPLETE\\\",\\n \\\"DATE_BAS_WEEK\\\",\\n \\\"DATE_BAS_WEEK_COMPLETE\\\",\\n \\\"DATE_CENTURY\\\",\\n \\\"DATE_EXT_COMPLETE\\\",\\n \\\"DATE_EXT_ORD_COMPLETE\\\",\\n \\\"DATE_EXT_WEEK\\\",\\n \\\"DATE_EXT_WEEK_COMPLETE\\\",\\n \\\"DATE_YEAR\\\",\\n \\\"DATE_BAS_MONTH\\\",\\n \\\"DATE_EXT_MONTH\\\",\\n \\\"TIME_BAS_COMPLETE\\\",\\n \\\"TIME_BAS_MINUTE\\\",\\n \\\"TIME_EXT_COMPLETE\\\",\\n \\\"TIME_EXT_MINUTE\\\",\\n \\\"TIME_HOUR\\\",\\n \\\"TZ_BAS\\\",\\n \\\"TZ_EXT\\\",\\n \\\"TZ_HOUR\\\",\\n \\\"DT_BAS_COMPLETE\\\",\\n \\\"DT_EXT_COMPLETE\\\",\\n \\\"DT_BAS_ORD_COMPLETE\\\",\\n \\\"DT_EXT_ORD_COMPLETE\\\",\\n \\\"DT_BAS_WEEK_COMPLETE\\\",\\n \\\"DT_EXT_WEEK_COMPLETE\\\",\\n \\\"D_DEFAULT\\\",\\n \\\"D_WEEK\\\",\\n \\\"D_ALT_EXT\\\",\\n \\\"D_ALT_BAS\\\",\\n \\\"D_ALT_BAS_ORD\\\",\\n \\\"D_ALT_EXT_ORD\\\",\\n \\\"__version__\\\",\\n]\\n\\n[end of src/isodate/__init__.py]\",\n \"filename\": \"src/isodate/__init__.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This module provides an ISO 8601:2004 duration parser.\\n\\nIt also provides a wrapper to strftime. This wrapper makes it easier to\\nformat timedelta or Duration instances as ISO conforming strings.\\n\\\"\\\"\\\"\\n\\nimport re\\nfrom datetime import date, time, timedelta\\nfrom decimal import Decimal\\nfrom typing import Union, Optional\\n\\nfrom isodate.duration import Duration\\nfrom isodate.isodatetime import parse_datetime\\nfrom isodate.isoerror import ISO8601Error\\nfrom isodate.isostrf import D_DEFAULT, strftime\\n\\nISO8601_PERIOD_REGEX = re.compile(\\n r\\\"^(?P<sign>[+-])?\\\"\\n r\\\"P(?!\\\\b)\\\"\\n r\\\"(?P<years>[0-9]+([,.][0-9]+)?Y)?\\\"\\n r\\\"(?P<months>[0-9]+([,.][0-9]+)?M)?\\\"\\n r\\\"(?P<weeks>[0-9]+([,.][0-9]+)?W)?\\\"\\n r\\\"(?P<days>[0-9]+([,.][0-9]+)?D)?\\\"\\n r\\\"((?P<separator>T)(?P<hours>[0-9]+([,.][0-9]+)?H)?\\\"\\n r\\\"(?P<minutes>[0-9]+([,.][0-9]+)?M)?\\\"\\n r\\\"(?P<seconds>[0-9]+([,.][0-9]+)?S)?)?$\\\"\\n)\\n# regular expression to parse ISO duration strings.\\n\\n\\ndef parse_duration(\\n datestring: str, as_timedelta_if_possible: bool = True\\n) -> Union[timedelta, Duration]:\\n \\\"\\\"\\\"Parses an ISO 8601 durations into datetime.timedelta or Duration objects.\\n\\n If the ISO date string does not contain years or months, a timedelta\\n instance is returned, else a Duration instance is returned.\\n\\n The following duration formats are supported:\\n -PnnW duration in weeks\\n -PnnYnnMnnDTnnHnnMnnS complete duration specification\\n -PYYYYMMDDThhmmss basic alternative complete date format\\n -PYYYY-MM-DDThh:mm:ss extended alternative complete date format\\n -PYYYYDDDThhmmss basic alternative ordinal date format\\n -PYYYY-DDDThh:mm:ss extended alternative ordinal date format\\n\\n The '-' is optional.\\n\\n Limitations: ISO standard defines some restrictions about where to use\\n fractional numbers and which component and format combinations are\\n allowed. This parser implementation ignores all those restrictions and\\n returns something when it is able to find all necessary components.\\n In detail:\\n it does not check, whether only the last component has fractions.\\n it allows weeks specified with all other combinations\\n\\n The alternative format does not support durations with years, months or\\n days set to 0.\\n \\\"\\\"\\\"\\n ret: Optional[Union[timedelta, Duration]] = None\\n if not isinstance(datestring, str):\\n raise TypeError(\\\"Expecting a string %r\\\" % datestring)\\n match = ISO8601_PERIOD_REGEX.match(datestring)\\n if not match:\\n # try alternative format:\\n if datestring.startswith(\\\"P\\\"):\\n durdt = parse_datetime(datestring[1:])\\n if as_timedelta_if_possible and durdt.year == 0 and durdt.month == 0:\\n # FIXME: currently not possible in alternative format\\n # create timedelta\\n ret = timedelta(\\n days=durdt.day,\\n seconds=durdt.second,\\n microseconds=durdt.microsecond,\\n minutes=durdt.minute,\\n hours=durdt.hour,\\n )\\n else:\\n # create Duration\\n ret = Duration(\\n days=durdt.day,\\n seconds=durdt.second,\\n microseconds=durdt.microsecond,\\n minutes=durdt.minute,\\n hours=durdt.hour,\\n months=durdt.month,\\n years=durdt.year,\\n )\\n return ret\\n raise ISO8601Error(\\\"Unable to parse duration string %r\\\" % datestring)\\n groups = match.groupdict()\\n for key, val in groups.items():\\n if key not in (\\\"separator\\\", \\\"sign\\\"):\\n if val is None:\\n groups[key] = \\\"0n\\\"\\n # print groups[key]\\n if key in (\\\"years\\\", \\\"months\\\"):\\n groups[key] = Decimal(groups[key][:-1].replace(\\\",\\\", \\\".\\\"))\\n else:\\n # these values are passed into a timedelta object,\\n # which works with floats.\\n groups[key] = float(groups[key][:-1].replace(\\\",\\\", \\\".\\\"))\\n if as_timedelta_if_possible and groups[\\\"years\\\"] == 0 and groups[\\\"months\\\"] == 0:\\n ret = timedelta(\\n # values have been converted to float or Decimal\\n days=groups[\\\"days\\\"], # type: ignore [arg-type]\\n hours=groups[\\\"hours\\\"], # type: ignore [arg-type]\\n minutes=groups[\\\"minutes\\\"], # type: ignore [arg-type]\\n seconds=groups[\\\"seconds\\\"], # type: ignore [arg-type]\\n weeks=groups[\\\"weeks\\\"], # type: ignore [arg-type]\\n )\\n if groups[\\\"sign\\\"] == \\\"-\\\":\\n ret = timedelta(0) - ret\\n else:\\n ret = Duration(\\n # values have been converted to float or Decimal\\n years=groups[\\\"years\\\"], # type: ignore [arg-type]\\n months=groups[\\\"months\\\"], # type: ignore [arg-type]\\n days=groups[\\\"days\\\"], # type: ignore [arg-type]\\n hours=groups[\\\"hours\\\"], # type: ignore [arg-type]\\n minutes=groups[\\\"minutes\\\"], # type: ignore [arg-type]\\n seconds=groups[\\\"seconds\\\"], # type: ignore [arg-type]\\n weeks=groups[\\\"weeks\\\"], # type: ignore [arg-type]\\n )\\n if groups[\\\"sign\\\"] == \\\"-\\\":\\n ret = Duration(0) - ret\\n return ret\\n\\n\\ndef duration_isoformat(\\n tduration: Union[timedelta, Duration, time, date], format: str = D_DEFAULT\\n) -> str:\\n \\\"\\\"\\\"Format duration strings.\\n\\n This method is just a wrapper around isodate.isostrf.strftime and uses\\n P%P (D_DEFAULT) as default format.\\n \\\"\\\"\\\"\\n # TODO: implement better decision for negative Durations.\\n # should be done in Duration class in consistent way with timedelta.\\n if (\\n isinstance(tduration, Duration)\\n and (tduration.years < 0 or tduration.months < 0 or tduration.tdelta < timedelta(0))\\n ) or (isinstance(tduration, timedelta) and (tduration < timedelta(0))):\\n ret = \\\"-\\\"\\n else:\\n ret = \\\"\\\"\\n ret += strftime(tduration, format)\\n return ret\\n\\n[end of src/isodate/isoduration.py]\",\n \"filename\": \"src/isodate/isoduration.py\",\n \"id\": \"13\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This module provides an alternative strftime method.\\n\\nThe strftime method in this module allows only a subset of Python's strftime\\nformat codes, plus a few additional. It supports the full range of date values\\npossible with standard Python date/time objects. Furthermore there are several\\npr-defined format strings in this module to make ease producing of ISO 8601\\nconforming strings.\\n\\\"\\\"\\\"\\n\\nimport re\\nfrom datetime import date, time, timedelta\\nfrom typing import Callable, Union\\n\\nfrom isodate.duration import Duration\\nfrom isodate.isotzinfo import tz_isoformat\\n\\n# Date specific format strings\\nDATE_BAS_COMPLETE = \\\"%Y%m%d\\\"\\nDATE_EXT_COMPLETE = \\\"%Y-%m-%d\\\"\\nDATE_BAS_WEEK_COMPLETE = \\\"%YW%W%w\\\"\\nDATE_EXT_WEEK_COMPLETE = \\\"%Y-W%W-%w\\\"\\nDATE_BAS_ORD_COMPLETE = \\\"%Y%j\\\"\\nDATE_EXT_ORD_COMPLETE = \\\"%Y-%j\\\"\\nDATE_BAS_WEEK = \\\"%YW%W\\\"\\nDATE_EXT_WEEK = \\\"%Y-W%W\\\"\\nDATE_BAS_MONTH = \\\"%Y%m\\\"\\nDATE_EXT_MONTH = \\\"%Y-%m\\\"\\nDATE_YEAR = \\\"%Y\\\"\\nDATE_CENTURY = \\\"%C\\\"\\n\\n# Time specific format strings\\nTIME_BAS_COMPLETE = \\\"%H%M%S\\\"\\nTIME_EXT_COMPLETE = \\\"%H:%M:%S\\\"\\nTIME_BAS_MINUTE = \\\"%H%M\\\"\\nTIME_EXT_MINUTE = \\\"%H:%M\\\"\\nTIME_HOUR = \\\"%H\\\"\\n\\n# Time zone formats\\nTZ_BAS = \\\"%z\\\"\\nTZ_EXT = \\\"%Z\\\"\\nTZ_HOUR = \\\"%h\\\"\\n\\n# DateTime formats\\nDT_EXT_COMPLETE = DATE_EXT_COMPLETE + \\\"T\\\" + TIME_EXT_COMPLETE + TZ_EXT\\nDT_BAS_COMPLETE = DATE_BAS_COMPLETE + \\\"T\\\" + TIME_BAS_COMPLETE + TZ_BAS\\nDT_EXT_ORD_COMPLETE = DATE_EXT_ORD_COMPLETE + \\\"T\\\" + TIME_EXT_COMPLETE + TZ_EXT\\nDT_BAS_ORD_COMPLETE = DATE_BAS_ORD_COMPLETE + \\\"T\\\" + TIME_BAS_COMPLETE + TZ_BAS\\nDT_EXT_WEEK_COMPLETE = DATE_EXT_WEEK_COMPLETE + \\\"T\\\" + TIME_EXT_COMPLETE + TZ_EXT\\nDT_BAS_WEEK_COMPLETE = DATE_BAS_WEEK_COMPLETE + \\\"T\\\" + TIME_BAS_COMPLETE + TZ_BAS\\n\\n# Duration formts\\nD_DEFAULT = \\\"P%P\\\"\\nD_WEEK = \\\"P%p\\\"\\nD_ALT_EXT = \\\"P\\\" + DATE_EXT_COMPLETE + \\\"T\\\" + TIME_EXT_COMPLETE\\nD_ALT_BAS = \\\"P\\\" + DATE_BAS_COMPLETE + \\\"T\\\" + TIME_BAS_COMPLETE\\nD_ALT_EXT_ORD = \\\"P\\\" + DATE_EXT_ORD_COMPLETE + \\\"T\\\" + TIME_EXT_COMPLETE\\nD_ALT_BAS_ORD = \\\"P\\\" + DATE_BAS_ORD_COMPLETE + \\\"T\\\" + TIME_BAS_COMPLETE\\n\\nSTRF_DT_MAP: dict[str, Callable[[Union[time, date], int], str]] = {\\n \\\"%d\\\": lambda tdt, yds: \\\"%02d\\\" % tdt.day, # type: ignore [union-attr]\\n \\\"%f\\\": lambda tdt, yds: \\\"%06d\\\" % tdt.microsecond, # type: ignore [union-attr]\\n \\\"%H\\\": lambda tdt, yds: \\\"%02d\\\" % tdt.hour, # type: ignore [union-attr]\\n \\\"%j\\\": lambda tdt, yds: \\\"%03d\\\" % (tdt.toordinal() - date(tdt.year, 1, 1).toordinal() + 1), # type: ignore [union-attr, operator] # noqa: E501\\n \\\"%m\\\": lambda tdt, yds: \\\"%02d\\\" % tdt.month, # type: ignore [union-attr]\\n \\\"%M\\\": lambda tdt, yds: \\\"%02d\\\" % tdt.minute, # type: ignore [union-attr]\\n \\\"%S\\\": lambda tdt, yds: \\\"%02d\\\" % tdt.second, # type: ignore [union-attr]\\n \\\"%w\\\": lambda tdt, yds: \\\"%1d\\\" % tdt.isoweekday(), # type: ignore [union-attr]\\n \\\"%W\\\": lambda tdt, yds: \\\"%02d\\\" % tdt.isocalendar()[1], # type: ignore [union-attr]\\n \\\"%Y\\\": lambda tdt, yds: (((yds != 4) and \\\"+\\\") or \\\"\\\") + ((\\\"%%0%dd\\\" % yds) % tdt.year), # type: ignore [union-attr] # noqa: E501\\n \\\"%C\\\": lambda tdt, yds: (((yds != 4) and \\\"+\\\") or \\\"\\\") # type: ignore [union-attr]\\n + ((\\\"%%0%dd\\\" % (yds - 2)) % (tdt.year / 100)), # type: ignore [union-attr]\\n \\\"%h\\\": lambda tdt, yds: tz_isoformat(tdt, \\\"%h\\\"), # type: ignore [arg-type]\\n \\\"%Z\\\": lambda tdt, yds: tz_isoformat(tdt, \\\"%Z\\\"), # type: ignore [arg-type]\\n \\\"%z\\\": lambda tdt, yds: tz_isoformat(tdt, \\\"%z\\\"), # type: ignore [arg-type]\\n \\\"%%\\\": lambda tdt, yds: \\\"%\\\",\\n}\\n\\nSTRF_D_MAP: dict[str, Callable[[Union[timedelta, Duration], int], str]] = {\\n \\\"%d\\\": lambda tdt, yds: \\\"%02d\\\" % tdt.days,\\n \\\"%f\\\": lambda tdt, yds: \\\"%06d\\\" % tdt.microseconds,\\n \\\"%H\\\": lambda tdt, yds: \\\"%02d\\\" % (tdt.seconds / 60 / 60),\\n \\\"%m\\\": lambda tdt, yds: \\\"%02d\\\" % tdt.months, # type: ignore [union-attr]\\n \\\"%M\\\": lambda tdt, yds: \\\"%02d\\\" % ((tdt.seconds / 60) % 60),\\n \\\"%S\\\": lambda tdt, yds: \\\"%02d\\\" % (tdt.seconds % 60),\\n \\\"%W\\\": lambda tdt, yds: \\\"%02d\\\" % (abs(tdt.days / 7)),\\n \\\"%Y\\\": lambda tdt, yds: (((yds != 4) and \\\"+\\\") or \\\"\\\") + ((\\\"%%0%dd\\\" % yds) % tdt.years), # type: ignore [union-attr] # noqa: E501\\n \\\"%C\\\": lambda tdt, yds: (((yds != 4) and \\\"+\\\") or \\\"\\\")\\n + ((\\\"%%0%dd\\\" % (yds - 2)) % (tdt.years / 100)), # type: ignore [union-attr]\\n \\\"%%\\\": lambda tdt, yds: \\\"%\\\",\\n}\\n\\n\\ndef _strfduration(tdt: Union[timedelta, Duration], format: str, yeardigits: int = 4) -> str:\\n \\\"\\\"\\\"This is the work method for timedelta and Duration instances.\\n\\n See strftime for more details.\\n \\\"\\\"\\\"\\n\\n def repl(match: re.Match[str]) -> str:\\n \\\"\\\"\\\"Lookup format command and return corresponding replacement.\\\"\\\"\\\"\\n if match.group(0) in STRF_D_MAP:\\n return STRF_D_MAP[match.group(0)](tdt, yeardigits)\\n elif match.group(0) == \\\"%P\\\":\\n ret: list[str] = []\\n if isinstance(tdt, Duration):\\n if tdt.years:\\n ret.append(\\\"%sY\\\" % abs(tdt.years))\\n if tdt.months:\\n ret.append(\\\"%sM\\\" % abs(tdt.months))\\n usecs = abs((tdt.days * 24 * 60 * 60 + tdt.seconds) * 1000000 + tdt.microseconds)\\n seconds, usecs = divmod(usecs, 1000000)\\n minutes, seconds = divmod(seconds, 60)\\n hours, minutes = divmod(minutes, 60)\\n days, hours = divmod(hours, 24)\\n if days:\\n ret.append(\\\"%sD\\\" % days)\\n if hours or minutes or seconds or usecs:\\n ret.append(\\\"T\\\")\\n if hours:\\n ret.append(\\\"%sH\\\" % hours)\\n if minutes:\\n ret.append(\\\"%sM\\\" % minutes)\\n if seconds or usecs:\\n if usecs:\\n ret.append((\\\"%d.%06d\\\" % (seconds, usecs)).rstrip(\\\"0\\\"))\\n else:\\n ret.append(\\\"%d\\\" % seconds)\\n ret.append(\\\"S\\\")\\n # at least one component has to be there.\\n return \\\"\\\".join(ret) if ret else \\\"0D\\\"\\n elif match.group(0) == \\\"%p\\\":\\n return str(abs(tdt.days // 7)) + \\\"W\\\"\\n return match.group(0)\\n\\n return re.sub(\\\"%d|%f|%H|%m|%M|%S|%W|%Y|%C|%%|%P|%p\\\", repl, format)\\n\\n\\ndef _strfdt(tdt: Union[time, date], format: str, yeardigits: int = 4) -> str:\\n \\\"\\\"\\\"This is the work method for time and date instances.\\n\\n See strftime for more details.\\n \\\"\\\"\\\"\\n\\n def repl(match: re.Match[str]) -> str:\\n \\\"\\\"\\\"Lookup format command and return corresponding replacement.\\\"\\\"\\\"\\n if match.group(0) in STRF_DT_MAP:\\n return STRF_DT_MAP[match.group(0)](tdt, yeardigits)\\n return match.group(0)\\n\\n return re.sub(\\\"%d|%f|%H|%j|%m|%M|%S|%w|%W|%Y|%C|%z|%Z|%h|%%\\\", repl, format)\\n\\n\\ndef strftime(tdt: Union[timedelta, Duration, time, date], format: str, yeardigits: int = 4) -> str:\\n \\\"\\\"\\\"Directive Meaning Notes.\\n\\n %d Day of the month as a decimal number [01,31].\\n %f Microsecond as a decimal number [0,999999], zero-padded\\n on the left (1)\\n %H Hour (24-hour clock) as a decimal number [00,23].\\n %j Day of the year as a decimal number [001,366].\\n %m Month as a decimal number [01,12].\\n %M Minute as a decimal number [00,59].\\n %S Second as a decimal number [00,61]. (3)\\n %w Weekday as a decimal number [0(Monday),6].\\n %W Week number of the year (Monday as the first day of the week)\\n as a decimal number [00,53]. All days in a new year preceding the\\n first Monday are considered to be in week 0. (4)\\n %Y Year with century as a decimal number. [0000,9999]\\n %C Century as a decimal number. [00,99]\\n %z UTC offset in the form +HHMM or -HHMM (empty string if the\\n object is naive). (5)\\n %Z Time zone name (empty string if the object is naive).\\n %P ISO8601 duration format.\\n %p ISO8601 duration format in weeks.\\n %% A literal '%' character.\\n\\n \\\"\\\"\\\"\\n if isinstance(tdt, (timedelta, Duration)):\\n return _strfduration(tdt, format, yeardigits)\\n return _strfdt(tdt, format, yeardigits)\\n\\n[end of src/isodate/isostrf.py]\",\n \"filename\": \"src/isodate/isostrf.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This module defines all exception classes in the whole package.\\\"\\\"\\\"\\n\\n\\nclass ISO8601Error(ValueError):\\n \\\"\\\"\\\"Raised when the given ISO string can not be parsed.\\\"\\\"\\\"\\n\\n[end of src/isodate/isoerror.py]\",\n \"filename\": \"src/isodate/isoerror.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This modules provides a method to parse an ISO 8601:2004 time string to a\\nPython datetime.time instance.\\n\\nIt supports all basic and extended formats including time zone specifications\\nas described in the ISO standard.\\n\\\"\\\"\\\"\\n\\nimport re\\nfrom datetime import date, time, timedelta\\nfrom decimal import ROUND_FLOOR, Decimal\\nfrom typing import Union\\n\\nfrom isodate.duration import Duration\\nfrom isodate.isoerror import ISO8601Error\\nfrom isodate.isostrf import TIME_EXT_COMPLETE, TZ_EXT, strftime\\nfrom isodate.isotzinfo import TZ_REGEX, build_tzinfo\\n\\nTIME_REGEX_CACHE: list[re.Pattern[str]] = []\\n# used to cache regular expressions to parse ISO time strings.\\n\\n\\ndef build_time_regexps() -> list[re.Pattern[str]]:\\n \\\"\\\"\\\"Build regular expressions to parse ISO time string.\\n\\n The regular expressions are compiled and stored in TIME_REGEX_CACHE\\n for later reuse.\\n \\\"\\\"\\\"\\n if not TIME_REGEX_CACHE:\\n # ISO 8601 time representations allow decimal fractions on least\\n # significant time component. Command and Full Stop are both valid\\n # fraction separators.\\n # The letter 'T' is allowed as time designator in front of a time\\n # expression.\\n # Immediately after a time expression, a time zone definition is\\n # allowed.\\n # a TZ may be missing (local time), be a 'Z' for UTC or a string of\\n # +-hh:mm where the ':mm' part can be skipped.\\n # TZ information patterns:\\n # ''\\n # Z\\n # +-hh:mm\\n # +-hhmm\\n # +-hh =>\\n # isotzinfo.TZ_REGEX\\n def add_re(regex_text: str) -> None:\\n TIME_REGEX_CACHE.append(re.compile(r\\\"\\\\A\\\" + regex_text + TZ_REGEX + r\\\"\\\\Z\\\"))\\n\\n # 1. complete time:\\n # hh:mm:ss.ss ... extended format\\n add_re(\\n r\\\"T?(?P<hour>[0-9]{2}):\\\"\\n r\\\"(?P<minute>[0-9]{2}):\\\"\\n r\\\"(?P<second>[0-9]{2}\\\"\\n r\\\"([,.][0-9]+)?)\\\"\\n )\\n # hhmmss.ss ... basic format\\n add_re(\\n r\\\"T?(?P<hour>[0-9]{2})\\\" r\\\"(?P<minute>[0-9]{2})\\\" r\\\"(?P<second>[0-9]{2}\\\" r\\\"([,.][0-9]+)?)\\\"\\n )\\n # 2. reduced accuracy:\\n # hh:mm.mm ... extended format\\n add_re(r\\\"T?(?P<hour>[0-9]{2}):\\\" r\\\"(?P<minute>[0-9]{2}\\\" r\\\"([,.][0-9]+)?)\\\")\\n # hhmm.mm ... basic format\\n add_re(r\\\"T?(?P<hour>[0-9]{2})\\\" r\\\"(?P<minute>[0-9]{2}\\\" r\\\"([,.][0-9]+)?)\\\")\\n # hh.hh ... basic format\\n add_re(r\\\"T?(?P<hour>[0-9]{2}\\\" r\\\"([,.][0-9]+)?)\\\")\\n return TIME_REGEX_CACHE\\n\\n\\ndef parse_time(timestring: str) -> time:\\n \\\"\\\"\\\"Parses ISO 8601 times into datetime.time objects.\\n\\n Following ISO 8601 formats are supported:\\n (as decimal separator a ',' or a '.' is allowed)\\n hhmmss.ssTZD basic complete time\\n hh:mm:ss.ssTZD extended complete time\\n hhmm.mmTZD basic reduced accuracy time\\n hh:mm.mmTZD extended reduced accuracy time\\n hh.hhTZD basic reduced accuracy time\\n TZD is the time zone designator which can be in the following format:\\n no designator indicates local time zone\\n Z UTC\\n +-hhmm basic hours and minutes\\n +-hh:mm extended hours and minutes\\n +-hh hours\\n \\\"\\\"\\\"\\n isotimes = build_time_regexps()\\n for pattern in isotimes:\\n match = pattern.match(timestring)\\n if match:\\n groups = match.groupdict()\\n for key, value in groups.items():\\n if value is not None:\\n groups[key] = value.replace(\\\",\\\", \\\".\\\")\\n tzinfo = build_tzinfo(\\n groups[\\\"tzname\\\"],\\n groups[\\\"tzsign\\\"],\\n int(groups[\\\"tzhour\\\"] or 0),\\n int(groups[\\\"tzmin\\\"] or 0),\\n )\\n if \\\"second\\\" in groups:\\n second = Decimal(groups[\\\"second\\\"]).quantize(\\n Decimal(\\\".000001\\\"), rounding=ROUND_FLOOR\\n )\\n microsecond = (second - int(second)) * int(1e6)\\n # int(...) ... no rounding\\n # to_integral() ... rounding\\n return time(\\n int(groups[\\\"hour\\\"]),\\n int(groups[\\\"minute\\\"]),\\n int(second),\\n int(microsecond.to_integral()),\\n tzinfo,\\n )\\n if \\\"minute\\\" in groups:\\n minute = Decimal(groups[\\\"minute\\\"])\\n second = Decimal((minute - int(minute)) * 60).quantize(\\n Decimal(\\\".000001\\\"), rounding=ROUND_FLOOR\\n )\\n microsecond = (second - int(second)) * int(1e6)\\n return time(\\n int(groups[\\\"hour\\\"]),\\n int(minute),\\n int(second),\\n int(microsecond.to_integral()),\\n tzinfo,\\n )\\n else:\\n microsecond, second, minute = Decimal(0), Decimal(0), Decimal(0)\\n hour = Decimal(groups[\\\"hour\\\"])\\n minute = (hour - int(hour)) * 60\\n second = Decimal((minute - int(minute)) * 60)\\n microsecond = (second - int(second)) * int(1e6)\\n return time(\\n int(hour),\\n int(minute),\\n int(second),\\n int(microsecond.to_integral()),\\n tzinfo,\\n )\\n raise ISO8601Error(\\\"Unrecognised ISO 8601 time format: %r\\\" % timestring)\\n\\n\\ndef time_isoformat(\\n ttime: Union[timedelta, Duration, time, date], format: str = TIME_EXT_COMPLETE + TZ_EXT\\n) -> str:\\n \\\"\\\"\\\"Format time strings.\\n\\n This method is just a wrapper around isodate.isostrf.strftime and uses\\n Time-Extended-Complete with extended time zone as default format.\\n \\\"\\\"\\\"\\n return strftime(ttime, format)\\n\\n[end of src/isodate/isotime.py]\",\n \"filename\": \"src/isodate/isotime.py\",\n \"id\": \"16\"\n },\n {\n \"content\": \"[end of src/isodate/py.typed]\",\n \"filename\": \"src/isodate/py.typed\",\n \"id\": \"17\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This module provides an ISO 8601:2004 time zone info parser.\\n\\nIt offers a function to parse the time zone offset as specified by ISO 8601.\\n\\\"\\\"\\\"\\n\\nimport re\\nfrom datetime import datetime, tzinfo\\nfrom typing import Union\\n\\nfrom isodate.isoerror import ISO8601Error\\nfrom isodate.tzinfo import UTC, ZERO, FixedOffset, Utc\\n\\nTZ_REGEX = r\\\"(?P<tzname>(Z|(?P<tzsign>[+-])\\\" r\\\"(?P<tzhour>[0-9]{2})(:?(?P<tzmin>[0-9]{2}))?)?)\\\"\\n\\nTZ_RE = re.compile(TZ_REGEX)\\n\\n\\ndef build_tzinfo(\\n tzname: Union[str, None], tzsign: str = \\\"+\\\", tzhour: float = 0, tzmin: float = 0\\n) -> Union[FixedOffset, Utc, None]:\\n \\\"\\\"\\\"\\n create a tzinfo instance according to given parameters.\\n\\n tzname:\\n 'Z' ... return UTC\\n '' | None ... return None\\n other ... return FixedOffset\\n \\\"\\\"\\\"\\n if tzname is None or tzname == \\\"\\\":\\n return None\\n if tzname == \\\"Z\\\":\\n return UTC\\n tzsignum = ((tzsign == \\\"-\\\") and -1) or 1\\n return FixedOffset(tzsignum * tzhour, tzsignum * tzmin, tzname)\\n\\n\\ndef parse_tzinfo(tzstring: str) -> Union[tzinfo, None]:\\n \\\"\\\"\\\"Parses ISO 8601 time zone designators to tzinfo objects.\\n\\n A time zone designator can be in the following format:\\n no designator indicates local time zone\\n Z UTC\\n +-hhmm basic hours and minutes\\n +-hh:mm extended hours and minutes\\n +-hh hours\\n \\\"\\\"\\\"\\n match = TZ_RE.match(tzstring)\\n if match:\\n groups = match.groupdict()\\n return build_tzinfo(\\n groups[\\\"tzname\\\"],\\n groups[\\\"tzsign\\\"],\\n int(groups[\\\"tzhour\\\"] or 0),\\n int(groups[\\\"tzmin\\\"] or 0),\\n )\\n raise ISO8601Error(\\\"%s not a valid time zone info\\\" % tzstring)\\n\\n\\ndef tz_isoformat(dt: datetime, format: str = \\\"%Z\\\") -> str:\\n \\\"\\\"\\\"Return time zone offset ISO 8601 formatted.\\n\\n The various ISO formats can be chosen with the format parameter.\\n\\n if tzinfo is None returns ''\\n if tzinfo is UTC returns 'Z'\\n else the offset is rendered to the given format.\\n format:\\n %h ... +-HH\\n %z ... +-HHMM\\n %Z ... +-HH:MM\\n \\\"\\\"\\\"\\n tzinfo = dt.tzinfo\\n if (tzinfo is None) or (tzinfo.utcoffset(dt) is None):\\n return \\\"\\\"\\n if tzinfo.utcoffset(dt) == ZERO and tzinfo.dst(dt) == ZERO:\\n return \\\"Z\\\"\\n tdelta = tzinfo.utcoffset(dt)\\n if tdelta is None:\\n return \\\"\\\"\\n seconds = tdelta.days * 24 * 60 * 60 + tdelta.seconds\\n sign = ((seconds < 0) and \\\"-\\\") or \\\"+\\\"\\n seconds = abs(seconds)\\n minutes, seconds = divmod(seconds, 60)\\n hours, minutes = divmod(minutes, 60)\\n if hours > 99:\\n raise OverflowError(\\\"can not handle differences > 99 hours\\\")\\n if format == \\\"%Z\\\":\\n return \\\"%s%02d:%02d\\\" % (sign, hours, minutes)\\n elif format == \\\"%z\\\":\\n return \\\"%s%02d%02d\\\" % (sign, hours, minutes)\\n elif format == \\\"%h\\\":\\n return \\\"%s%02d\\\" % (sign, hours)\\n raise ValueError('unknown format string \\\"%s\\\"' % format)\\n\\n[end of src/isodate/isotzinfo.py]\",\n \"filename\": \"src/isodate/isotzinfo.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"\\\"\\\"\\\"This module defines a method to parse an ISO 8601:2004 date time string.\\n\\nFor this job it uses the parse_date and parse_time methods defined in date\\nand time module.\\n\\\"\\\"\\\"\\n\\nfrom __future__ import annotations\\n\\nfrom datetime import date, datetime, time, timedelta\\n\\nimport isodate\\nfrom isodate.isodates import parse_date\\nfrom isodate.isoerror import ISO8601Error\\nfrom isodate.isostrf import DATE_EXT_COMPLETE, TIME_EXT_COMPLETE, TZ_EXT, strftime\\nfrom isodate.isotime import parse_time\\n\\n\\ndef parse_datetime(datetimestring: str) -> datetime:\\n \\\"\\\"\\\"Parses ISO 8601 date-times into datetime.datetime objects.\\n\\n This function uses parse_date and parse_time to do the job, so it allows\\n more combinations of date and time representations, than the actual\\n ISO 8601:2004 standard allows.\\n \\\"\\\"\\\"\\n try:\\n datestring, timestring = datetimestring.split(\\\"T\\\")\\n except ValueError:\\n raise ISO8601Error(\\n \\\"ISO 8601 time designator 'T' missing. Unable to\\\"\\n \\\" parse datetime string %r\\\" % datetimestring\\n )\\n tmpdate = parse_date(datestring)\\n tmptime = parse_time(timestring)\\n return datetime.combine(tmpdate, tmptime)\\n\\n\\ndef datetime_isoformat(\\n tdt: timedelta | isodate.isoduration.Duration | time | date,\\n format: str = DATE_EXT_COMPLETE + \\\"T\\\" + TIME_EXT_COMPLETE + TZ_EXT,\\n) -> str:\\n \\\"\\\"\\\"Format datetime strings.\\n\\n This method is just a wrapper around isodate.isostrf.strftime and uses\\n Extended-Complete as default format.\\n \\\"\\\"\\\"\\n return strftime(tdt, format)\\n\\n[end of src/isodate/isodatetime.py]\",\n \"filename\": \"src/isodate/isodatetime.py\",\n \"id\": \"19\"\n }\n]","isConversational":false}}},{"rowIdx":58,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 58,\n \"num_files\": 16,\n \"repo_id\": \"repo_0058\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"[package]\nname = \"rpds-py\"\nversion = \"0.23.1\"\nedition = \"2021\"\n\n[lib]\nname = \"rpds\"\ncrate-type = [\"cdylib\"]\n\n[dependencies]\nrpds = \"1.1.0\"\narchery = \"1.2.1\"\n\n[dependencies.pyo3]\nversion = \"0.23.4\"\n# To build extension for PyPy on Windows, \"generate-import-lib\" is needed:\n# https://github.com/PyO3/maturin-action/issues/267#issuecomment-2106844429\nfeatures = [\"extension-module\", \"generate-import-lib\"]\n\n[end of Cargo.toml]","filename":"Cargo.toml","id":"0"},{"content":"Copyright (c) 2023 Julian Berman\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"ci:\n skip:\n # pre-commit.ci doesn't have Rust installed\n - fmt\n - clippy\n - zizmor\n\nrepos:\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: check-ast\n - id: check-docstring-first\n - id: check-toml\n - id: check-vcs-permalinks\n - id: check-yaml\n - id: debug-statements\n - id: end-of-file-fixer\n - id: mixed-line-ending\n args: [--fix, lf]\n - id: trailing-whitespace\n - repo: https://github.com/doublify/pre-commit-rust\n rev: \"v1.0\"\n hooks:\n - id: fmt\n - id: clippy\n - repo: https://github.com/psf/black\n rev: 25.1.0\n hooks:\n - id: black\n - repo: https://github.com/pre-commit/mirrors-prettier\n rev: \"v4.0.0-alpha.8\"\n hooks:\n - id: prettier\n - repo: https://github.com/woodruffw/zizmor\n rev: v0.8.0\n hooks:\n - id: zizmor\n\n[end of .pre-commit-config.yaml]","filename":".pre-commit-config.yaml","id":"2"},{"content":"[build-system]\nrequires = [\"maturin>=1.2,<2.0\"]\nbuild-backend = \"maturin\"\n\n[project]\nname = \"rpds-py\"\ndescription = \"Python bindings to Rust's persistent data structures (rpds)\"\nrequires-python = \">=3.9\"\nreadme = \"README.rst\"\nlicense = \"MIT\"\nlicense-files = [\"LICENSE\"]\nkeywords = [\"data structures\", \"rust\", \"persistent\"]\nauthors = [\n { name = \"Julian Berman\", email = \"Julian+rpds@GrayVines.com\" },\n]\nclassifiers = [\n \"Development Status :: 3 - Alpha\",\n \"Intended Audience :: Developers\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Rust\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: Implementation :: CPython\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n]\ndynamic = [\"version\"]\n\n[project.urls]\nDocumentation = \"https://rpds.readthedocs.io/\"\nHomepage = \"https://github.com/crate-py/rpds\"\nIssues = \"https://github.com/crate-py/rpds/issues/\"\nFunding = \"https://github.com/sponsors/Julian\"\nTidelift = \"https://tidelift.com/subscription/pkg/pypi-rpds-py?utm_source=pypi-rpds-py&utm_medium=referral&utm_campaign=pypi-link\"\nSource = \"https://github.com/crate-py/rpds\"\nUpstream = \"https://github.com/orium/rpds\"\n\n[tool.black]\nline-length = 79\n\n[tool.coverage.html]\nshow_contexts = true\nskip_covered = false\n\n[tool.coverage.run]\nbranch = true\ndynamic_context = \"test_function\"\n\n[tool.coverage.report]\nexclude_also = [\n \"if TYPE_CHECKING:\",\n \"\\\\s*\\\\.\\\\.\\\\.\\\\s*\",\n]\nfail_under = 100\nshow_missing = true\nskip_covered = true\n\n[tool.doc8]\nignore = [\n \"D000\", # see PyCQA/doc8#125\n \"D001\", # one sentence per line, so max length doesn't make sense\n]\n\n[tool.maturin]\nfeatures = [\"pyo3/extension-module\"]\n\n[tool.pyright]\nreportUnnecessaryTypeIgnoreComment = true\nstrict = [\"**/*\"]\nexclude = [\n \"**/tests/__init__.py\",\n \"**/tests/test_*.py\",\n]\n\n[tool.ruff]\nline-length = 79\n\n[tool.ruff.lint]\nselect = [\"ALL\"]\nignore = [\n \"A001\", # It's fine to shadow builtins\n \"A002\",\n \"A003\",\n \"A005\",\n \"ARG\", # This is all wrong whenever an interface is involved\n \"ANN\", # Just let the type checker do this\n \"B006\", # Mutable arguments require care but are OK if you don't abuse them\n \"B008\", # It's totally OK to call functions for default arguments.\n \"B904\", # raise SomeException(...) is fine.\n \"B905\", # No need for explicit strict, this is simply zip's default behavior\n \"C408\", # Calling dict is fine when it saves quoting the keys\n \"C901\", # Not really something to focus on\n \"D105\", # It's fine to not have docstrings for magic methods.\n \"D107\", # __init__ especially doesn't need a docstring\n \"D200\", # This rule makes diffs uglier when expanding docstrings\n \"D203\", # No blank lines before docstrings.\n \"D212\", # Start docstrings on the second line.\n \"D400\", # This rule misses sassy docstrings ending with ! or ?\n \"D401\", # This rule is too flaky.\n \"D406\", # Section headers should end with a colon not a newline\n \"D407\", # Underlines aren't needed\n \"D412\", # Plz spaces after section headers\n \"EM101\", # These don't bother me, it's fine there's some duplication.\n \"EM102\",\n \"FBT\", # It's worth avoiding boolean args but I don't care to enforce it\n \"FIX\", # Yes thanks, if I could it wouldn't be there\n \"N\", # These naming rules are silly\n \"PLR0912\", # These metrics are fine to be aware of but not to enforce\n \"PLR0913\",\n \"PLR0915\",\n \"PLW2901\", # Shadowing for loop variables is occasionally fine.\n \"PT006\", # pytest parametrize takes strings as well\n \"PYI025\", # wat, I'm not confused, thanks.\n \"RET502\", # Returning None implicitly is fine\n \"RET503\",\n \"RET505\", # These push you to use `if` instead of `elif`, but for no reason\n \"RET506\",\n \"RSE102\", # Ha, what, who even knew you could leave the parens off. But no.\n \"SIM300\", # Not sure what heuristic this uses, but it's easily incorrect\n \"SLF001\", # Private usage within this package itself is fine\n \"TD\", # These TODO style rules are also silly\n \"UP007\", # We support 3.9\n]\n\n[tool.ruff.lint.flake8-pytest-style]\nmark-parentheses = false\n\n[tool.ruff.lint.flake8-quotes]\ndocstring-quotes = \"double\"\n\n[tool.ruff.lint.isort]\ncombine-as-imports = true\nfrom-first = true\nknown-first-party = [\"rpds\"]\n\n[tool.ruff.lint.per-file-ignores]\n\"noxfile.py\" = [\"ANN\", \"D100\", \"S101\", \"T201\"]\n\"docs/*\" = [\"ANN\", \"D\", \"INP001\"]\n\"tests/*\" = [\"ANN\", \"B018\", \"D\", \"PLR\", \"RUF012\", \"S\", \"SIM\", \"TRY\"]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"from typing import (\n ItemsView,\n Iterable,\n Iterator,\n KeysView,\n Mapping,\n TypeVar,\n ValuesView,\n)\n\n_T = TypeVar(\"_T\")\n_KT_co = TypeVar(\"_KT_co\", covariant=True)\n_VT_co = TypeVar(\"_VT_co\", covariant=True)\n_KU_co = TypeVar(\"_KU_co\", covariant=True)\n_VU_co = TypeVar(\"_VU_co\", covariant=True)\n\nclass HashTrieMap(Mapping[_KT_co, _VT_co]):\n def __init__(\n self,\n value: Mapping[_KT_co, _VT_co] | Iterable[tuple[_KT_co, _VT_co]] = {},\n **kwds: Mapping[_KT_co, _VT_co],\n ): ...\n def __getitem__(self, key: _KT_co) -> _VT_co: ...\n def __iter__(self) -> Iterator[_KT_co]: ...\n def __len__(self) -> int: ...\n def discard(self, key: _KT_co) -> HashTrieMap[_KT_co, _VT_co]: ...\n def items(self) -> ItemsView[_KT_co, _VT_co]: ...\n def keys(self) -> KeysView[_KT_co]: ...\n def values(self) -> ValuesView[_VT_co]: ...\n def remove(self, key: _KT_co) -> HashTrieMap[_KT_co, _VT_co]: ...\n def insert(\n self,\n key: _KT_co,\n val: _VT_co,\n ) -> HashTrieMap[_KT_co, _VT_co]: ...\n def update(\n self,\n *args: Mapping[_KU_co, _VU_co] | Iterable[tuple[_KU_co, _VU_co]],\n ) -> HashTrieMap[_KT_co | _KU_co, _VT_co | _VU_co]: ...\n @classmethod\n def convert(\n cls,\n value: Mapping[_KT_co, _VT_co] | Iterable[tuple[_KT_co, _VT_co]],\n ) -> HashTrieMap[_KT_co, _VT_co]: ...\n @classmethod\n def fromkeys(\n cls,\n keys: Iterable[_KT_co],\n value: _VT_co = None,\n ) -> HashTrieMap[_KT_co, _VT_co]: ...\n\nclass HashTrieSet(frozenset[_T]):\n def __init__(self, value: Iterable[_T] = ()): ...\n def __iter__(self) -> Iterator[_T]: ...\n def __len__(self) -> int: ...\n def discard(self, value: _T) -> HashTrieSet[_T]: ...\n def remove(self, value: _T) -> HashTrieSet[_T]: ...\n def insert(self, value: _T) -> HashTrieSet[_T]: ...\n def update(self, *args: Iterable[_T]) -> HashTrieSet[_T]: ...\n\nclass List(Iterable[_T]):\n def __init__(self, value: Iterable[_T] = (), *more: _T): ...\n def __iter__(self) -> Iterator[_T]: ...\n def __len__(self) -> int: ...\n def push_front(self, value: _T) -> List[_T]: ...\n def drop_first(self) -> List[_T]: ...\n\nclass Queue(Iterable[_T]):\n def __init__(self, value: Iterable[_T] = (), *more: _T): ...\n def __iter__(self) -> Iterator[_T]: ...\n def __len__(self) -> int: ...\n def enqueue(self, value: _T) -> Queue[_T]: ...\n def dequeue(self, value: _T) -> Queue[_T]: ...\n @property\n def is_empty(self) -> _T: ...\n @property\n def peek(self) -> _T: ...\n\n[end of rpds.pyi]","filename":"rpds.pyi","id":"4"},{"content":"# This file is automatically @generated by Cargo.\n# It is not intended for manual editing.\nversion = 4\n\n[[package]]\nname = \"archery\"\nversion = \"1.2.1\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"eae2ed21cd55021f05707a807a5fc85695dafb98832921f6cfa06db67ca5b869\"\ndependencies = [\n \"triomphe\",\n]\n\n[[package]]\nname = \"autocfg\"\nversion = \"1.3.0\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0\"\n\n[[package]]\nname = \"cc\"\nversion = \"1.0.90\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"8cd6604a82acf3039f1144f54b8eb34e91ffba622051189e71b781822d5ee1f5\"\n\n[[package]]\nname = \"cfg-if\"\nversion = \"1.0.0\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd\"\n\n[[package]]\nname = \"heck\"\nversion = \"0.5.0\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea\"\n\n[[package]]\nname = \"indoc\"\nversion = \"2.0.5\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"b248f5224d1d606005e02c97f5aa4e88eeb230488bcc03bc9ca4d7991399f2b5\"\n\n[[package]]\nname = \"libc\"\nversion = \"0.2.155\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c\"\n\n[[package]]\nname = \"memoffset\"\nversion = \"0.9.1\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a\"\ndependencies = [\n \"autocfg\",\n]\n\n[[package]]\nname = \"once_cell\"\nversion = \"1.19.0\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92\"\n\n[[package]]\nname = \"portable-atomic\"\nversion = \"1.6.0\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"7170ef9988bc169ba16dd36a7fa041e5c4cbeb6a35b76d4c03daded371eae7c0\"\n\n[[package]]\nname = \"proc-macro2\"\nversion = \"1.0.86\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77\"\ndependencies = [\n \"unicode-ident\",\n]\n\n[[package]]\nname = \"pyo3\"\nversion = \"0.23.4\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"57fe09249128b3173d092de9523eaa75136bf7ba85e0d69eca241c7939c933cc\"\ndependencies = [\n \"cfg-if\",\n \"indoc\",\n \"libc\",\n \"memoffset\",\n \"once_cell\",\n \"portable-atomic\",\n \"pyo3-build-config\",\n \"pyo3-ffi\",\n \"pyo3-macros\",\n \"unindent\",\n]\n\n[[package]]\nname = \"pyo3-build-config\"\nversion = \"0.23.4\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"1cd3927b5a78757a0d71aa9dff669f903b1eb64b54142a9bd9f757f8fde65fd7\"\ndependencies = [\n \"once_cell\",\n \"python3-dll-a\",\n \"target-lexicon\",\n]\n\n[[package]]\nname = \"pyo3-ffi\"\nversion = \"0.23.4\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"dab6bb2102bd8f991e7749f130a70d05dd557613e39ed2deeee8e9ca0c4d548d\"\ndependencies = [\n \"libc\",\n \"pyo3-build-config\",\n]\n\n[[package]]\nname = \"pyo3-macros\"\nversion = \"0.23.4\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"91871864b353fd5ffcb3f91f2f703a22a9797c91b9ab497b1acac7b07ae509c7\"\ndependencies = [\n \"proc-macro2\",\n \"pyo3-macros-backend\",\n \"quote\",\n \"syn\",\n]\n\n[[package]]\nname = \"pyo3-macros-backend\"\nversion = \"0.23.4\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"43abc3b80bc20f3facd86cd3c60beed58c3e2aa26213f3cda368de39c60a27e4\"\ndependencies = [\n \"heck\",\n \"proc-macro2\",\n \"pyo3-build-config\",\n \"quote\",\n \"syn\",\n]\n\n[[package]]\nname = \"python3-dll-a\"\nversion = \"0.2.12\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"9b66f9171950e674e64bad3456e11bb3cca108e5c34844383cfe277f45c8a7a8\"\ndependencies = [\n \"cc\",\n]\n\n[[package]]\nname = \"quote\"\nversion = \"1.0.36\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7\"\ndependencies = [\n \"proc-macro2\",\n]\n\n[[package]]\nname = \"rpds\"\nversion = \"1.1.0\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"a0e15515d3ce3313324d842629ea4905c25a13f81953eadb88f85516f59290a4\"\ndependencies = [\n \"archery\",\n]\n\n[[package]]\nname = \"rpds-py\"\nversion = \"0.23.1\"\ndependencies = [\n \"archery\",\n \"pyo3\",\n \"rpds\",\n]\n\n[[package]]\nname = \"syn\"\nversion = \"2.0.69\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"201fcda3845c23e8212cd466bfebf0bd20694490fc0356ae8e428e0824a915a6\"\ndependencies = [\n \"proc-macro2\",\n \"quote\",\n \"unicode-ident\",\n]\n\n[[package]]\nname = \"target-lexicon\"\nversion = \"0.12.14\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"e1fc403891a21bcfb7c37834ba66a547a8f402146eba7265b5a6d88059c9ff2f\"\n\n[[package]]\nname = \"triomphe\"\nversion = \"0.1.13\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"e6631e42e10b40c0690bf92f404ebcfe6e1fdb480391d15f17cc8e96eeed5369\"\n\n[[package]]\nname = \"unicode-ident\"\nversion = \"1.0.12\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b\"\n\n[[package]]\nname = \"unindent\"\nversion = \"0.2.3\"\nsource = \"registry+https://github.com/rust-lang/crates.io-index\"\nchecksum = \"c7de7d73e1754487cb58364ee906a499937a0dfabd86bcb980fa99ec8c8fa2ce\"\n\n[end of Cargo.lock]","filename":"Cargo.lock","id":"5"},{"content":"version: 2\n\nbuild:\n os: ubuntu-22.04\n tools:\n python: \"3.11\"\n rust: \"1.70\"\n\nsphinx:\n builder: dirhtml\n configuration: docs/conf.py\n fail_on_warning: true\n\nformats: all\n\npython:\n install:\n - requirements: docs/requirements.txt\n\n[end of .readthedocs.yml]","filename":".readthedocs.yml","id":"6"},{"content":"===========\n``rpds.py``\n===========\n\n|PyPI| |Pythons| |CI|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/rpds-py.svg\n :alt: PyPI version\n :target: https://pypi.org/project/rpds-py/\n\n.. |Pythons| image:: https://img.shields.io/pypi/pyversions/rpds-py.svg\n :alt: Supported Python versions\n :target: https://pypi.org/project/rpds-py/\n\n.. |CI| image:: https://github.com/crate-py/rpds/workflows/CI/badge.svg\n :alt: Build status\n :target: https://github.com/crate-py/rpds/actions?query=workflow%3ACI\n\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/referencing/badge/?version=stable&style=flat\n :alt: ReadTheDocs status\n :target: https://referencing.readthedocs.io/en/stable/\n\n\nPython bindings to the `Rust rpds crate <https://docs.rs/rpds/>`_ for persistent data structures.\n\nWhat's here is quite minimal (in transparency, it was written initially to support replacing ``pyrsistent`` in the `referencing library <https://github.com/python-jsonschema/referencing>`_).\nIf you see something missing (which is very likely), a PR is definitely welcome to add it.\n\nInstallation\n------------\n\nThe distribution on PyPI is named ``rpds.py`` (equivalently ``rpds-py``), and thus can be installed via e.g.:\n\n.. code:: sh\n\n $ pip install rpds-py\n\nNote that if you install ``rpds-py`` from source, you will need a Rust toolchain installed, as it is a build-time dependency.\nAn example of how to do so in a ``Dockerfile`` can be found `here <https://github.com/bowtie-json-schema/bowtie/blob/e77fd93598cb6e7dc1b8b1f53c00e5aa410c201a/implementations/python-jsonschema/Dockerfile#L1-L8>`_.\n\nIf you believe you are on a common platform which should have wheels built (i.e. and not need to compile from source), feel free to file an issue or pull request modifying the GitHub action used here to build wheels via ``maturin``.\n\nUsage\n-----\n\nMethods in general are named similarly to their ``rpds`` counterparts (rather than ``pyrsistent``\\ 's conventions, though probably a full drop-in ``pyrsistent``\\ -compatible wrapper module is a good addition at some point).\n\n.. code:: python\n\n >>> from rpds import HashTrieMap, HashTrieSet, List\n\n >>> m = HashTrieMap({\"foo\": \"bar\", \"baz\": \"quux\"})\n >>> m.insert(\"spam\", 37) == HashTrieMap({\"foo\": \"bar\", \"baz\": \"quux\", \"spam\": 37})\n True\n >>> m.remove(\"foo\") == HashTrieMap({\"baz\": \"quux\"})\n True\n\n >>> s = HashTrieSet({\"foo\", \"bar\", \"baz\", \"quux\"})\n >>> s.insert(\"spam\") == HashTrieSet({\"foo\", \"bar\", \"baz\", \"quux\", \"spam\"})\n True\n >>> s.remove(\"foo\") == HashTrieSet({\"bar\", \"baz\", \"quux\"})\n True\n\n >>> L = List([1, 3, 5])\n >>> L.push_front(-1) == List([-1, 1, 3, 5])\n True\n >>> L.rest == List([3, 5])\n True\n\n[end of README.rst]","filename":"README.rst","id":"7"},{"content":"from pathlib import Path\nfrom tempfile import TemporaryDirectory\nimport os\n\nimport nox\n\nROOT = Path(__file__).parent\nPYPROJECT = ROOT / \"pyproject.toml\"\nDOCS = ROOT / \"docs\"\nTESTS = ROOT / \"tests\"\n\nREQUIREMENTS = dict(\n docs=DOCS / \"requirements.txt\",\n tests=TESTS / \"requirements.txt\",\n)\nREQUIREMENTS_IN = [ # this is actually ordered, as files depend on each other\n (path.parent / f\"{path.stem}.in\", path) for path in REQUIREMENTS.values()\n]\n\nSUPPORTED = [\"3.9\", \"3.10\", \"pypy3.10\", \"3.11\", \"3.12\", \"3.13\", \"3.13t\"]\nLATEST = \"3.13\"\n\nnox.options.default_venv_backend = \"uv|virtualenv\"\nnox.options.sessions = []\n\n\ndef session(default=True, python=LATEST, **kwargs): # noqa: D103\n def _session(fn):\n if default:\n nox.options.sessions.append(kwargs.get(\"name\", fn.__name__))\n return nox.session(python=python, **kwargs)(fn)\n\n return _session\n\n\n@session(python=SUPPORTED)\ndef tests(session):\n \"\"\"\n Run the test suite with a corresponding Python version.\n \"\"\"\n # Really we want --profile=test here (for\n # https://github.com/crate-py/rpds/pull/87#issuecomment-2291409297)\n # but it produces strange symbol errors saying:\n # dynamic module does not define module export function (PyInit_rpds)\n # so OK, dev it is.\n session.install(\n \"--config-settings\",\n \"build-args=--profile=dev\",\n \"--no-cache\",\n \"-r\",\n REQUIREMENTS[\"tests\"],\n )\n\n if session.posargs and session.posargs[0] == \"coverage\":\n if len(session.posargs) > 1 and session.posargs[1] == \"github\":\n github = Path(os.environ[\"GITHUB_STEP_SUMMARY\"])\n else:\n github = None\n\n session.install(\"coverage[toml]\")\n session.run(\"coverage\", \"run\", \"-m\", \"pytest\", TESTS)\n if github is None:\n session.run(\"coverage\", \"report\")\n else:\n with github.open(\"a\") as summary:\n summary.write(\"### Coverage\\n\\n\")\n summary.flush() # without a flush, output seems out of order.\n session.run(\n \"coverage\",\n \"report\",\n \"--format=markdown\",\n stdout=summary,\n )\n else:\n session.run(\"pytest\", \"--parallel-threads=10\", *session.posargs, TESTS)\n\n\n@session()\ndef audit(session):\n \"\"\"\n Audit dependencies for vulnerabilities.\n \"\"\"\n session.install(\"pip-audit\", ROOT)\n session.run(\"python\", \"-m\", \"pip_audit\")\n\n\n@session(tags=[\"build\"])\ndef build(session):\n \"\"\"\n Build a distribution suitable for PyPI and check its validity.\n \"\"\"\n session.install(\"build\", \"twine\")\n with TemporaryDirectory() as tmpdir:\n session.run(\"python\", \"-m\", \"build\", ROOT, \"--outdir\", tmpdir)\n session.run(\"twine\", \"check\", \"--strict\", tmpdir + \"/*\")\n\n\n@session(tags=[\"style\"])\ndef style(session):\n \"\"\"\n Check Python code style.\n \"\"\"\n session.install(\"ruff\")\n session.run(\"ruff\", \"check\", TESTS, __file__)\n\n\n@session()\ndef typing(session):\n \"\"\"\n Check the codebase using pyright by type checking the test suite.\n \"\"\"\n session.install(\"pyright\", ROOT, \"-r\", REQUIREMENTS[\"tests\"])\n session.run(\"pyright\", TESTS)\n\n\n@session(tags=[\"docs\"])\n@nox.parametrize(\n \"builder\",\n [\n nox.param(name, id=name)\n for name in [\n \"dirhtml\",\n \"doctest\",\n \"linkcheck\",\n \"man\",\n \"spelling\",\n ]\n ],\n)\ndef docs(session, builder):\n \"\"\"\n Build the documentation using a specific Sphinx builder.\n \"\"\"\n session.install(\"-r\", REQUIREMENTS[\"docs\"])\n with TemporaryDirectory() as tmpdir_str:\n tmpdir = Path(tmpdir_str)\n argv = [\"-n\", \"-T\", \"-W\"]\n if builder != \"spelling\":\n argv += [\"-q\"]\n posargs = session.posargs or [tmpdir / builder]\n session.run(\n \"python\",\n \"-m\",\n \"sphinx\",\n \"-b\",\n builder,\n DOCS,\n *argv,\n *posargs,\n )\n\n\n@session(tags=[\"docs\", \"style\"], name=\"docs(style)\")\ndef docs_style(session):\n \"\"\"\n Check the documentation style.\n \"\"\"\n session.install(\n \"doc8\",\n \"pygments\",\n \"pygments-github-lexers\",\n )\n session.run(\"python\", \"-m\", \"doc8\", \"--config\", PYPROJECT, DOCS)\n\n\n@session(default=False)\ndef requirements(session):\n \"\"\"\n Update the project's pinned requirements.\n\n You should commit the result afterwards.\n \"\"\"\n if session.venv_backend == \"uv\":\n cmd = [\"uv\", \"pip\", \"compile\"]\n else:\n session.install(\"pip-tools\")\n cmd = [\"pip-compile\", \"--resolver\", \"backtracking\", \"--strip-extras\"]\n\n for each, out in REQUIREMENTS_IN:\n # otherwise output files end up with silly absolute path comments...\n relative = each.relative_to(ROOT)\n session.run(*cmd, \"--upgrade\", \"--output-file\", out, relative)\n\n[end of noxfile.py]","filename":"noxfile.py","id":"8"},{"content":"Python bindings to the `Rust rpds crate <https://docs.rs/rpds/>`_ for persistent data structures.\n\nWhat's here is quite minimal (in transparency, it was written initially to support replacing ``pyrsistent`` in the `referencing library <https://github.com/python-jsonschema/referencing>`_).\nIf you see something missing (which is very likely), a PR is definitely welcome to add it.\n\nInstallation\n------------\n\nThe distribution on PyPI is named ``rpds.py`` (equivalently ``rpds-py``), and thus can be installed via e.g.:\n\n.. code:: sh\n\n $ pip install rpds-py\n\nNote that if you install ``rpds-py`` from source, you will need a Rust toolchain installed, as it is a build-time dependency.\nAn example of how to do so in a ``Dockerfile`` can be found `here <https://github.com/bowtie-json-schema/bowtie/blob/e77fd93598cb6e7dc1b8b1f53c00e5aa410c201a/implementations/python-jsonschema/Dockerfile#L1-L8>`_.\n\nIf you believe you are on a common platform which should have wheels built (i.e. and not need to compile from source), feel free to file an issue or pull request modifying the GitHub action used here to build wheels via ``maturin``.\n\nUsage\n-----\n\nMethods in general are named similarly to their ``rpds`` counterparts (rather than ``pyrsistent``\\ 's conventions, though probably a full drop-in ``pyrsistent``\\ -compatible wrapper module is a good addition at some point).\n\n.. code:: python\n\n >>> from rpds import HashTrieMap, HashTrieSet, List\n\n >>> m = HashTrieMap({\"foo\": \"bar\", \"baz\": \"quux\"})\n >>> m.insert(\"spam\", 37) == HashTrieMap({\"foo\": \"bar\", \"baz\": \"quux\", \"spam\": 37})\n True\n >>> m.remove(\"foo\") == HashTrieMap({\"baz\": \"quux\"})\n True\n\n >>> s = HashTrieSet({\"foo\", \"bar\", \"baz\", \"quux\"})\n >>> s.insert(\"spam\") == HashTrieSet({\"foo\", \"bar\", \"baz\", \"quux\", \"spam\"})\n True\n >>> s.remove(\"foo\") == HashTrieSet({\"bar\", \"baz\", \"quux\"})\n True\n\n >>> L = List([1, 3, 5])\n >>> L.push_front(-1) == List([-1, 1, 3, 5])\n True\n >>> L.rest == List([3, 5])\n True\n\n\n.. toctree::\n :glob:\n :hidden:\n\n api\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"9"},{"content":"# This file was autogenerated by uv via the following command:\n# uv pip compile --output-file /Users/julian/Development/rpds.py/docs/requirements.txt docs/requirements.in\nalabaster==1.0.0\n # via sphinx\nbabel==2.17.0\n # via sphinx\nbeautifulsoup4==4.13.3\n # via furo\ncertifi==2025.1.31\n # via requests\ncharset-normalizer==3.4.1\n # via requests\ndocutils==0.21.2\n # via sphinx\nfuro==2024.8.6\n # via -r docs/requirements.in\nidna==3.10\n # via requests\nimagesize==1.4.1\n # via sphinx\njinja2==3.1.5\n # via sphinx\nmarkupsafe==3.0.2\n # via jinja2\npackaging==24.2\n # via sphinx\npyenchant==3.2.2\n # via sphinxcontrib-spelling\npygments==2.19.1\n # via\n # furo\n # pygments-github-lexers\n # sphinx\npygments-github-lexers==0.0.5\n # via -r docs/requirements.in\nrequests==2.32.3\n # via\n # sphinx\n # sphinxcontrib-spelling\nrpds-py @ file:.#egg=rpds-py\n # via -r docs/requirements.in\nsnowballstemmer==2.2.0\n # via sphinx\nsoupsieve==2.6\n # via beautifulsoup4\nsphinx==8.1.3\n # via\n # -r docs/requirements.in\n # furo\n # sphinx-basic-ng\n # sphinx-copybutton\n # sphinxcontrib-spelling\n # sphinxext-opengraph\nsphinx-basic-ng==1.0.0b2\n # via furo\nsphinx-copybutton==0.5.2\n # via -r docs/requirements.in\nsphinxcontrib-applehelp==2.0.0\n # via sphinx\nsphinxcontrib-devhelp==2.0.0\n # via sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via sphinx\nsphinxcontrib-jsmath==1.0.1\n # via sphinx\nsphinxcontrib-qthelp==2.0.0\n # via sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via sphinx\nsphinxcontrib-spelling==8.0.1\n # via -r docs/requirements.in\nsphinxext-opengraph==0.9.1\n # via -r docs/requirements.in\ntyping-extensions==4.12.2\n # via beautifulsoup4\nurl-py==0.14.1\n # via -r docs/requirements.in\nurllib3==2.3.0\n # via requests\n\n[end of docs/requirements.txt]","filename":"docs/requirements.txt","id":"10"},{"content":"import importlib.metadata\nimport re\n\nfrom url import URL\n\nGITHUB = URL.parse(\"https://github.com/\")\nHOMEPAGE = GITHUB / \"crate-py/rpds\"\n\nproject = \"rpds.py\"\nauthor = \"Julian Berman\"\ncopyright = f\"2023, {author}\"\n\nrelease = importlib.metadata.version(\"rpds.py\")\nversion = release.partition(\"-\")[0]\n\nlanguage = \"en\"\ndefault_role = \"any\"\n\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.autosectionlabel\",\n \"sphinx.ext.coverage\",\n \"sphinx.ext.doctest\",\n \"sphinx.ext.extlinks\",\n \"sphinx.ext.intersphinx\",\n \"sphinx.ext.napoleon\",\n \"sphinx.ext.todo\",\n \"sphinx.ext.viewcode\",\n \"sphinx_copybutton\",\n \"sphinxcontrib.spelling\",\n \"sphinxext.opengraph\",\n]\n\npygments_style = \"lovelace\"\npygments_dark_style = \"one-dark\"\n\nhtml_theme = \"furo\"\n\n\ndef entire_domain(host):\n return r\"http.?://\" + re.escape(host) + r\"($|/.*)\"\n\n\nlinkcheck_ignore = [\n entire_domain(\"img.shields.io\"),\n f\"{GITHUB}.*#.*\",\n str(HOMEPAGE / \"actions\"),\n str(HOMEPAGE / \"workflows/CI/badge.svg\"),\n]\n\n# = Extensions =\n\n# -- autodoc --\n\nautodoc_default_options = {\n \"members\": True,\n \"member-order\": \"bysource\",\n}\n\n# -- autosectionlabel --\n\nautosectionlabel_prefix_document = True\n\n# -- intersphinx --\n\nintersphinx_mapping = {\n \"python\": (\"https://docs.python.org/\", None),\n}\n\n# -- extlinks --\n\nextlinks = {\n \"gh\": (str(HOMEPAGE) + \"/%s\", None),\n \"github\": (str(GITHUB) + \"/%s\", None),\n}\nextlinks_detect_hardcoded_links = True\n\n# -- sphinx-copybutton --\n\ncopybutton_prompt_text = r\">>> |\\.\\.\\. |\\$\"\ncopybutton_prompt_is_regexp = True\n\n# -- sphinxcontrib-spelling --\n\nspelling_word_list_filename = \"spelling-wordlist.txt\"\nspelling_show_suggestions = True\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"11"},{"content":"iter\nlen\ntoolchain\n\n[end of docs/spelling-wordlist.txt]","filename":"docs/spelling-wordlist.txt","id":"12"},{"content":"API Reference\n=============\n\n.. automodule:: rpds\n :members:\n :undoc-members:\n :imported-members:\n :special-members: __iter__, __getitem__, __len__, __rmatmul__\n\n[end of docs/api.rst]","filename":"docs/api.rst","id":"13"},{"content":"file:.#egg=rpds-py\nfuro\npygments-github-lexers\nsphinx-copybutton\nsphinx>5\nsphinxcontrib-spelling>5\nsphinxext-opengraph\nurl.py\n\n[end of docs/requirements.in]","filename":"docs/requirements.in","id":"14"},{"content":"use pyo3::exceptions::{PyIndexError, PyTypeError};\nuse pyo3::pyclass::CompareOp;\nuse pyo3::types::{PyDict, PyIterator, PyTuple, PyType};\nuse pyo3::{exceptions::PyKeyError, types::PyMapping, types::PyTupleMethods};\nuse pyo3::{prelude::*, AsPyPointer, BoundObject, PyTypeInfo};\nuse rpds::{\n HashTrieMap, HashTrieMapSync, HashTrieSet, HashTrieSetSync, List, ListSync, Queue, QueueSync,\n};\nuse std::collections::hash_map::DefaultHasher;\nuse std::hash::{Hash, Hasher};\n\nfn hash_shuffle_bits(h: usize) -> usize {\n ((h ^ 89869747) ^ (h << 16)).wrapping_mul(3644798167)\n}\n\n#[derive(Debug)]\nstruct Key {\n hash: isize,\n inner: PyObject,\n}\n\nimpl<'py> IntoPyObject<'py> for Key {\n type Target = PyAny;\n type Output = Bound<'py, Self::Target>;\n type Error = std::convert::Infallible;\n\n fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error> {\n Ok(self.inner.into_bound(py))\n }\n}\n\nimpl<'a, 'py> IntoPyObject<'py> for &'a Key {\n type Target = PyAny;\n type Output = Borrowed<'a, 'py, Self::Target>;\n type Error = std::convert::Infallible;\n\n fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error> {\n Ok(self.inner.bind_borrowed(py))\n }\n}\n\nimpl Hash for Key {\n fn hash<H: Hasher>(&self, state: &mut H) {\n state.write_isize(self.hash);\n }\n}\n\nimpl Eq for Key {}\n\nimpl PartialEq for Key {\n fn eq(&self, other: &Self) -> bool {\n Python::with_gil(|py| {\n self.inner\n .call_method1(py, \"__eq__\", (&other.inner,))\n .and_then(|value| value.extract(py))\n .expect(\"__eq__ failed!\")\n })\n }\n}\n\nimpl Key {\n fn clone_ref(&self, py: Python<'_>) -> Self {\n Key {\n hash: self.hash,\n inner: self.inner.clone_ref(py),\n }\n }\n}\n\nunsafe impl AsPyPointer for Key {\n fn as_ptr(&self) -> *mut pyo3::ffi::PyObject {\n self.inner.as_ptr()\n }\n}\n\nimpl<'source> FromPyObject<'source> for Key {\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\n Ok(Key {\n hash: ob.hash()?,\n inner: ob.clone().unbind(),\n })\n }\n}\n\n#[repr(transparent)]\n#[pyclass(name = \"HashTrieMap\", module = \"rpds\", frozen, mapping)]\nstruct HashTrieMapPy {\n inner: HashTrieMapSync<Key, PyObject>,\n}\n\nimpl From<HashTrieMapSync<Key, PyObject>> for HashTrieMapPy {\n fn from(map: HashTrieMapSync<Key, PyObject>) -> Self {\n HashTrieMapPy { inner: map }\n }\n}\n\nimpl<'source> FromPyObject<'source> for HashTrieMapPy {\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\n let mut ret = HashTrieMap::new_sync();\n if let Ok(mapping) = ob.downcast::<PyMapping>() {\n for each in mapping.items()?.iter() {\n let (k, v): (Key, PyObject) = each.extract()?;\n ret.insert_mut(k, v);\n }\n } else {\n for each in ob.try_iter()? {\n let (k, v) = each?.extract()?;\n ret.insert_mut(k, v);\n }\n }\n Ok(HashTrieMapPy { inner: ret })\n }\n}\n\n#[pymethods]\nimpl HashTrieMapPy {\n #[new]\n #[pyo3(signature = (value=None, ** kwds))]\n fn init(value: Option<HashTrieMapPy>, kwds: Option<&Bound<'_, PyDict>>) -> PyResult<Self> {\n let mut map: HashTrieMapPy;\n if let Some(value) = value {\n map = value;\n } else {\n map = HashTrieMapPy {\n inner: HashTrieMap::new_sync(),\n };\n }\n if let Some(kwds) = kwds {\n for (k, v) in kwds {\n map.inner.insert_mut(Key::extract_bound(&k)?, v.into());\n }\n }\n Ok(map)\n }\n\n fn __contains__(&self, key: Key) -> bool {\n self.inner.contains_key(&key)\n }\n\n fn __iter__(slf: PyRef<'_, Self>) -> KeysIterator {\n KeysIterator {\n inner: slf.inner.clone(),\n }\n }\n\n fn __getitem__(&self, key: Key, py: Python) -> PyResult<PyObject> {\n match self.inner.get(&key) {\n Some(value) => Ok(value.clone_ref(py)),\n None => Err(PyKeyError::new_err(key)),\n }\n }\n\n fn __len__(&self) -> usize {\n self.inner.size()\n }\n\n fn __repr__(&self, py: Python) -> String {\n let contents = self.inner.into_iter().map(|(k, v)| {\n format!(\n \"{}: {}\",\n k.inner\n .call_method0(py, \"__repr__\")\n .and_then(|r| r.extract(py))\n .unwrap_or(\"<repr error>\".to_owned()),\n v.call_method0(py, \"__repr__\")\n .and_then(|r| r.extract(py))\n .unwrap_or(\"<repr error>\".to_owned())\n )\n });\n format!(\n \"HashTrieMap({{{}}})\",\n contents.collect::<Vec<_>>().join(\", \")\n )\n }\n\n fn __richcmp__<'py>(&self, other: &Self, op: CompareOp, py: Python<'py>) -> PyResult<PyObject> {\n match op {\n CompareOp::Eq => (self.inner.size() == other.inner.size()\n && self\n .inner\n .iter()\n .map(|(k1, v1)| (v1, other.inner.get(k1)))\n .map(|(v1, v2)| v1.bind(py).eq(v2))\n .all(|r| r.unwrap_or(false)))\n .into_pyobject(py)\n .map_err(Into::into)\n .map(BoundObject::into_any)\n .map(BoundObject::unbind),\n CompareOp::Ne => (self.inner.size() != other.inner.size()\n || self\n .inner\n .iter()\n .map(|(k1, v1)| (v1, other.inner.get(k1)))\n .map(|(v1, v2)| v1.bind(py).ne(v2))\n .all(|r| r.unwrap_or(true)))\n .into_pyobject(py)\n .map_err(Into::into)\n .map(BoundObject::into_any)\n .map(BoundObject::unbind),\n _ => Ok(py.NotImplemented()),\n }\n }\n\n fn __hash__(&self, py: Python) -> PyResult<isize> {\n // modified from https://github.com/python/cpython/blob/d69529d31ccd1510843cfac1ab53bb8cb027541f/Objects/setobject.c#L715\n\n let mut hash_val = self\n .inner\n .iter()\n .map(|(key, val)| {\n let mut hasher = DefaultHasher::new();\n let val_bound = val.bind(py);\n\n let key_hash = key.hash;\n let val_hash = val_bound.hash().map_err(|_| {\n PyTypeError::new_err(format!(\n \"Unhashable type in HashTrieMap of key {}: {}\",\n key.inner\n .bind(py)\n .repr()\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr> error\".to_string()),\n val_bound\n .repr()\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr> error\".to_string())\n ))\n })?;\n\n hasher.write_isize(key_hash);\n hasher.write_isize(val_hash);\n\n Ok(hasher.finish() as usize)\n })\n .try_fold(0, |acc: usize, x: PyResult<usize>| {\n PyResult::<usize>::Ok(acc ^ hash_shuffle_bits(x?))\n })?;\n\n // factor in the number of entries in the collection\n hash_val ^= self.inner.size().wrapping_add(1).wrapping_mul(1927868237);\n\n // dispense patterns in the hash value\n hash_val ^= (hash_val >> 11) ^ (hash_val >> 25);\n hash_val = hash_val.wrapping_mul(69069).wrapping_add(907133923);\n\n Ok(hash_val as isize)\n }\n\n fn __reduce__(slf: PyRef<Self>) -> (Bound<'_, PyType>, (Vec<(Key, PyObject)>,)) {\n (\n HashTrieMapPy::type_object(slf.py()),\n (slf.inner\n .iter()\n .map(|(k, v)| (k.clone_ref(slf.py()), v.clone_ref(slf.py())))\n .collect(),),\n )\n }\n\n #[classmethod]\n fn convert(\n _cls: &Bound<'_, PyType>,\n value: Bound<'_, PyAny>,\n py: Python,\n ) -> PyResult<PyObject> {\n if value.is_instance_of::<HashTrieMapPy>() {\n Ok(value.unbind())\n } else {\n HashTrieMapPy::extract_bound(&value)?\n .into_pyobject(py)\n .map(BoundObject::into_any)\n .map(BoundObject::unbind)\n }\n }\n\n #[classmethod]\n #[pyo3(signature = (keys, val=None))]\n fn fromkeys(\n _cls: &Bound<'_, PyType>,\n keys: &Bound<'_, PyAny>,\n val: Option<&Bound<'_, PyAny>>,\n py: Python,\n ) -> PyResult<HashTrieMapPy> {\n let mut inner = HashTrieMap::new_sync();\n let none = py.None().into_bound(py);\n let value = val.unwrap_or(&none);\n for each in keys.try_iter()? {\n let key = Key::extract_bound(&each?)?;\n inner.insert_mut(key, value.clone().unbind());\n }\n Ok(HashTrieMapPy { inner })\n }\n\n #[pyo3(signature = (key, default=None))]\n fn get(&self, key: Key, default: Option<PyObject>, py: Python) -> Option<PyObject> {\n if let Some(value) = self.inner.get(&key) {\n Some(value.clone_ref(py))\n } else {\n default\n }\n }\n\n fn keys(&self) -> KeysView {\n KeysView {\n inner: self.inner.clone(),\n }\n }\n\n fn values(&self) -> ValuesView {\n ValuesView {\n inner: self.inner.clone(),\n }\n }\n\n fn items(&self) -> ItemsView {\n ItemsView {\n inner: self.inner.clone(),\n }\n }\n\n fn discard(&self, key: Key) -> PyResult<HashTrieMapPy> {\n match self.inner.contains_key(&key) {\n true => Ok(HashTrieMapPy {\n inner: self.inner.remove(&key),\n }),\n false => Ok(HashTrieMapPy {\n inner: self.inner.clone(),\n }),\n }\n }\n\n fn insert(&self, key: Key, value: Bound<'_, PyAny>) -> HashTrieMapPy {\n HashTrieMapPy {\n inner: self.inner.insert(key, value.unbind()),\n }\n }\n\n fn remove(&self, key: Key) -> PyResult<HashTrieMapPy> {\n match self.inner.contains_key(&key) {\n true => Ok(HashTrieMapPy {\n inner: self.inner.remove(&key),\n }),\n false => Err(PyKeyError::new_err(key)),\n }\n }\n\n #[pyo3(signature = (*maps, **kwds))]\n fn update(\n &self,\n maps: &Bound<'_, PyTuple>,\n kwds: Option<&Bound<'_, PyDict>>,\n ) -> PyResult<HashTrieMapPy> {\n let mut inner = self.inner.clone();\n for value in maps {\n let map = HashTrieMapPy::extract_bound(&value)?;\n for (k, v) in &map.inner {\n inner.insert_mut(k.clone_ref(value.py()), v.clone_ref(value.py()));\n }\n }\n if let Some(kwds) = kwds {\n for (k, v) in kwds {\n inner.insert_mut(Key::extract_bound(&k)?, v.extract()?);\n }\n }\n Ok(HashTrieMapPy { inner })\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct KeysIterator {\n inner: HashTrieMapSync<Key, PyObject>,\n}\n\n#[pymethods]\nimpl KeysIterator {\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\n slf\n }\n\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<Key> {\n let first = slf.inner.keys().next()?.clone_ref(slf.py());\n slf.inner = slf.inner.remove(&first);\n Some(first)\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct ValuesIterator {\n inner: HashTrieMapSync<Key, PyObject>,\n}\n\n#[pymethods]\nimpl ValuesIterator {\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\n slf\n }\n\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<PyObject> {\n let kv = slf.inner.iter().next()?;\n let value = kv.1.clone_ref(slf.py());\n slf.inner = slf.inner.remove(kv.0);\n Some(value)\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct ItemsIterator {\n inner: HashTrieMapSync<Key, PyObject>,\n}\n\n#[pymethods]\nimpl ItemsIterator {\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\n slf\n }\n\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<(Key, PyObject)> {\n let kv = slf.inner.iter().next()?;\n let key = kv.0.clone_ref(slf.py());\n let value = kv.1.clone_ref(slf.py());\n\n slf.inner = slf.inner.remove(kv.0);\n\n Some((key, value))\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct KeysView {\n inner: HashTrieMapSync<Key, PyObject>,\n}\n\n#[pymethods]\nimpl KeysView {\n fn __contains__(&self, key: Key) -> bool {\n self.inner.contains_key(&key)\n }\n\n fn __eq__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? != slf.inner.size() {\n return Ok(false);\n }\n for each in other.try_iter()? {\n if !slf.inner.contains_key(&Key::extract_bound(&each?)?) {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __lt__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? <= slf.inner.size() {\n return Ok(false);\n }\n\n for each in slf.inner.keys() {\n if !other.contains(each.inner.clone_ref(slf.py()))? {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __le__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? < slf.inner.size() {\n return Ok(false);\n }\n\n for each in slf.inner.keys() {\n if !other.contains(each.inner.clone_ref(slf.py()))? {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __gt__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? >= slf.inner.size() {\n return Ok(false);\n }\n for each in other.try_iter()? {\n if !slf.inner.contains_key(&Key::extract_bound(&each?)?) {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __ge__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? > slf.inner.size() {\n return Ok(false);\n }\n for each in other.try_iter()? {\n if !slf.inner.contains_key(&Key::extract_bound(&each?)?) {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __iter__(slf: PyRef<'_, Self>) -> KeysIterator {\n KeysIterator {\n inner: slf.inner.clone(),\n }\n }\n\n fn __len__(slf: PyRef<'_, Self>) -> usize {\n slf.inner.size()\n }\n\n fn __and__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>) -> PyResult<HashTrieSetPy> {\n KeysView::intersection(slf, other)\n }\n\n fn __or__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<KeysView> {\n KeysView::union(slf, other, py)\n }\n\n fn __repr__(&self, py: Python) -> PyResult<String> {\n let contents = self.inner.into_iter().map(|(k, _)| {\n Ok(k.clone_ref(py)\n .inner\n .into_pyobject(py)?\n .call_method0(\"__repr__\")\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr failed>\".to_owned()))\n });\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\n Ok(format!(\"keys_view({{{}}})\", contents.join(\", \")))\n }\n\n fn intersection(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>) -> PyResult<HashTrieSetPy> {\n // TODO: iterate over the shorter one if it's got a length\n let mut inner = HashTrieSet::new_sync();\n for each in other.try_iter()? {\n let key = Key::extract_bound(&each?)?;\n if slf.inner.contains_key(&key) {\n inner.insert_mut(key);\n }\n }\n Ok(HashTrieSetPy { inner })\n }\n\n fn union(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<KeysView> {\n // There doesn't seem to be a low-effort way to get a HashTrieSet out of a map,\n // so we just keep our map and add values we'll ignore.\n let mut inner = slf.inner.clone();\n for each in other.try_iter()? {\n inner.insert_mut(Key::extract_bound(&each?)?, py.None());\n }\n Ok(KeysView { inner })\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct ValuesView {\n inner: HashTrieMapSync<Key, PyObject>,\n}\n\n#[pymethods]\nimpl ValuesView {\n fn __iter__(slf: PyRef<'_, Self>) -> ValuesIterator {\n ValuesIterator {\n inner: slf.inner.clone(),\n }\n }\n\n fn __len__(slf: PyRef<'_, Self>) -> usize {\n slf.inner.size()\n }\n\n fn __repr__(&self, py: Python) -> PyResult<String> {\n let contents = self.inner.into_iter().map(|(_, v)| {\n Ok(v.into_pyobject(py)?\n .call_method0(\"__repr__\")\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr failed>\".to_owned()))\n });\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\n Ok(format!(\"values_view([{}])\", contents.join(\", \")))\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct ItemsView {\n inner: HashTrieMapSync<Key, PyObject>,\n}\n\n#[derive(FromPyObject)]\nstruct ItemViewQuery(Key, PyObject);\n\n#[pymethods]\nimpl ItemsView {\n fn __contains__(slf: PyRef<'_, Self>, item: ItemViewQuery) -> PyResult<bool> {\n if let Some(value) = slf.inner.get(&item.0) {\n return item.1.bind(slf.py()).eq(value);\n }\n\n Ok(false)\n }\n\n fn __iter__(slf: PyRef<'_, Self>) -> ItemsIterator {\n ItemsIterator {\n inner: slf.inner.clone(),\n }\n }\n\n fn __len__(slf: PyRef<'_, Self>) -> usize {\n slf.inner.size()\n }\n\n fn __eq__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? != slf.inner.size() {\n return Ok(false);\n }\n for (k, v) in slf.inner.iter() {\n if !other.contains((k.inner.clone_ref(slf.py()), v))? {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __repr__(&self, py: Python) -> PyResult<String> {\n let contents = self.inner.into_iter().map(|(k, v)| {\n let tuple = PyTuple::new(py, [k.inner.clone_ref(py), v.clone_ref(py)])?;\n Ok(format!(\"{:?}\", tuple))\n });\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\n Ok(format!(\"items_view([{}])\", contents.join(\", \")))\n }\n\n fn __lt__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? <= slf.inner.size() {\n return Ok(false);\n }\n for (k, v) in slf.inner.iter() {\n let pair = PyTuple::new(py, [k.inner.clone_ref(py), v.clone_ref(py)])?;\n // FIXME: needs to compare\n if !other.contains(pair)? {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __le__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? < slf.inner.size() {\n return Ok(false);\n }\n for (k, v) in slf.inner.iter() {\n let pair = PyTuple::new(py, [k.inner.clone_ref(py), v.clone_ref(py)])?;\n // FIXME: needs to compare\n if !other.contains(pair)? {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __gt__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? >= slf.inner.size() {\n return Ok(false);\n }\n for each in other.try_iter()? {\n let kv = each?;\n let k = kv.get_item(0)?;\n match slf.inner.get(&Key::extract_bound(&k)?) {\n Some(value) => {\n let pair = PyTuple::new(py, [k, value.bind(py).clone()])?;\n if !pair.eq(kv)? {\n return Ok(false);\n }\n }\n None => return Ok(false),\n }\n }\n Ok(true)\n }\n\n fn __ge__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? > slf.inner.size() {\n return Ok(false);\n }\n for each in other.try_iter()? {\n let kv = each?;\n let k = kv.get_item(0)?;\n match slf.inner.get(&Key::extract_bound(&k)?) {\n Some(value) => {\n let pair = PyTuple::new(py, [k, value.bind(py).clone()])?;\n if !pair.eq(kv)? {\n return Ok(false);\n }\n }\n None => return Ok(false),\n }\n }\n Ok(true)\n }\n\n fn __and__(\n slf: PyRef<'_, Self>,\n other: &Bound<'_, PyAny>,\n py: Python,\n ) -> PyResult<HashTrieSetPy> {\n ItemsView::intersection(slf, other, py)\n }\n\n fn __or__(\n slf: PyRef<'_, Self>,\n other: &Bound<'_, PyAny>,\n py: Python,\n ) -> PyResult<HashTrieSetPy> {\n ItemsView::union(slf, other, py)\n }\n\n fn intersection(\n slf: PyRef<'_, Self>,\n other: &Bound<'_, PyAny>,\n py: Python,\n ) -> PyResult<HashTrieSetPy> {\n // TODO: iterate over the shorter one if it's got a length\n let mut inner = HashTrieSet::new_sync();\n for each in other.try_iter()? {\n let kv = each?;\n let k = kv.get_item(0)?;\n if let Some(value) = slf.inner.get(&Key::extract_bound(&k)?) {\n let pair = PyTuple::new(py, [k, value.bind(py).clone()])?;\n if pair.eq(kv)? {\n inner.insert_mut(Key::extract_bound(&pair)?);\n }\n }\n }\n Ok(HashTrieSetPy { inner })\n }\n\n fn union(\n slf: PyRef<'_, Self>,\n other: &Bound<'_, PyAny>,\n py: Python,\n ) -> PyResult<HashTrieSetPy> {\n // TODO: this is very inefficient, but again can't seem to get a HashTrieSet out of ourself\n let mut inner = HashTrieSet::new_sync();\n for (k, v) in slf.inner.iter() {\n let pair = PyTuple::new(py, [k.inner.clone_ref(py), v.clone_ref(py)])?;\n inner.insert_mut(Key::extract_bound(&pair)?);\n }\n for each in other.try_iter()? {\n inner.insert_mut(Key::extract_bound(&each?)?);\n }\n Ok(HashTrieSetPy { inner })\n }\n}\n\n#[repr(transparent)]\n#[pyclass(name = \"HashTrieSet\", module = \"rpds\", frozen)]\nstruct HashTrieSetPy {\n inner: HashTrieSetSync<Key>,\n}\n\nimpl<'source> FromPyObject<'source> for HashTrieSetPy {\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\n let mut ret = HashTrieSet::new_sync();\n for each in ob.try_iter()? {\n let k: Key = each?.extract()?;\n ret.insert_mut(k);\n }\n Ok(HashTrieSetPy { inner: ret })\n }\n}\n\n#[pymethods]\nimpl HashTrieSetPy {\n #[new]\n #[pyo3(signature = (value=None))]\n fn init(value: Option<HashTrieSetPy>) -> Self {\n if let Some(value) = value {\n value\n } else {\n HashTrieSetPy {\n inner: HashTrieSet::new_sync(),\n }\n }\n }\n\n fn __contains__(&self, key: Key) -> bool {\n self.inner.contains(&key)\n }\n\n fn __and__(&self, other: &Self, py: Python) -> Self {\n self.intersection(other, py)\n }\n\n fn __or__(&self, other: &Self, py: Python) -> Self {\n self.union(other, py)\n }\n\n fn __sub__(&self, other: &Self) -> Self {\n self.difference(other)\n }\n\n fn __xor__(&self, other: &Self, py: Python) -> Self {\n self.symmetric_difference(other, py)\n }\n\n fn __iter__(slf: PyRef<'_, Self>) -> SetIterator {\n SetIterator {\n inner: slf.inner.clone(),\n }\n }\n\n fn __len__(&self) -> usize {\n self.inner.size()\n }\n\n fn __repr__(&self, py: Python) -> PyResult<String> {\n let contents = self.inner.into_iter().map(|k| {\n Ok(k.clone_ref(py)\n .into_pyobject(py)?\n .call_method0(\"__repr__\")\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr failed>\".to_owned()))\n });\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\n Ok(format!(\"HashTrieSet({{{}}})\", contents.join(\", \")))\n }\n\n fn __eq__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? != slf.inner.size() {\n return Ok(false);\n }\n for each in other.try_iter()? {\n if !slf.inner.contains(&Key::extract_bound(&each?)?) {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __hash__(&self) -> PyResult<isize> {\n // modified from https://github.com/python/cpython/blob/d69529d31ccd1510843cfac1ab53bb8cb027541f/Objects/setobject.c#L715\n\n let mut hash_val = self\n .inner\n .iter()\n .map(|k| k.hash as usize)\n .fold(0, |acc: usize, x: usize| acc ^ hash_shuffle_bits(x));\n\n // factor in the number of entries in the collection\n hash_val ^= self.inner.size().wrapping_add(1).wrapping_mul(1927868237);\n\n // dispense patterns in the hash value\n hash_val ^= (hash_val >> 11) ^ (hash_val >> 25);\n hash_val = hash_val.wrapping_mul(69069).wrapping_add(907133923);\n\n Ok(hash_val as isize)\n }\n\n fn __lt__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? <= slf.inner.size() {\n return Ok(false);\n }\n for each in slf.inner.iter() {\n if !other.contains(each.inner.clone_ref(py))? {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __le__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? < slf.inner.size() {\n return Ok(false);\n }\n for each in slf.inner.iter() {\n if !other.contains(each.inner.clone_ref(slf.py()))? {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __gt__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? >= slf.inner.size() {\n return Ok(false);\n }\n for each in other.try_iter()? {\n if !slf.inner.contains(&Key::extract_bound(&each?)?) {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __ge__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\n let abc = PyModule::import(py, \"collections.abc\")?;\n if !other.is_instance(&abc.getattr(\"Set\")?)? || other.len()? > slf.inner.size() {\n return Ok(false);\n }\n for each in other.try_iter()? {\n if !slf.inner.contains(&Key::extract_bound(&each?)?) {\n return Ok(false);\n }\n }\n Ok(true)\n }\n\n fn __reduce__(slf: PyRef<Self>) -> (Bound<'_, PyType>, (Vec<Key>,)) {\n (\n HashTrieSetPy::type_object(slf.py()),\n (slf.inner.iter().map(|e| e.clone_ref(slf.py())).collect(),),\n )\n }\n\n fn insert(&self, value: Key) -> HashTrieSetPy {\n HashTrieSetPy {\n inner: self.inner.insert(value),\n }\n }\n\n fn discard(&self, value: Key) -> PyResult<HashTrieSetPy> {\n match self.inner.contains(&value) {\n true => Ok(HashTrieSetPy {\n inner: self.inner.remove(&value),\n }),\n false => Ok(HashTrieSetPy {\n inner: self.inner.clone(),\n }),\n }\n }\n\n fn remove(&self, value: Key) -> PyResult<HashTrieSetPy> {\n match self.inner.contains(&value) {\n true => Ok(HashTrieSetPy {\n inner: self.inner.remove(&value),\n }),\n false => Err(PyKeyError::new_err(value)),\n }\n }\n\n fn difference(&self, other: &Self) -> HashTrieSetPy {\n let mut inner = self.inner.clone();\n for value in other.inner.iter() {\n inner.remove_mut(value);\n }\n HashTrieSetPy { inner }\n }\n\n fn intersection(&self, other: &Self, py: Python) -> HashTrieSetPy {\n let mut inner: HashTrieSetSync<Key> = HashTrieSet::new_sync();\n let larger: &HashTrieSetSync<Key>;\n let iter;\n if self.inner.size() > other.inner.size() {\n larger = &self.inner;\n iter = other.inner.iter();\n } else {\n larger = &other.inner;\n iter = self.inner.iter();\n }\n for value in iter {\n if larger.contains(value) {\n inner.insert_mut(value.clone_ref(py));\n }\n }\n HashTrieSetPy { inner }\n }\n\n fn symmetric_difference(&self, other: &Self, py: Python) -> HashTrieSetPy {\n let mut inner: HashTrieSetSync<Key>;\n let iter;\n if self.inner.size() > other.inner.size() {\n inner = self.inner.clone();\n iter = other.inner.iter();\n } else {\n inner = other.inner.clone();\n iter = self.inner.iter();\n }\n for value in iter {\n if inner.contains(value) {\n inner.remove_mut(value);\n } else {\n inner.insert_mut(value.clone_ref(py));\n }\n }\n HashTrieSetPy { inner }\n }\n\n fn union(&self, other: &Self, py: Python) -> HashTrieSetPy {\n let mut inner: HashTrieSetSync<Key>;\n let iter;\n if self.inner.size() > other.inner.size() {\n inner = self.inner.clone();\n iter = other.inner.iter();\n } else {\n inner = other.inner.clone();\n iter = self.inner.iter();\n }\n for value in iter {\n inner.insert_mut(value.clone_ref(py));\n }\n HashTrieSetPy { inner }\n }\n\n #[pyo3(signature = (*iterables))]\n fn update(&self, iterables: Bound<'_, PyTuple>) -> PyResult<HashTrieSetPy> {\n let mut inner = self.inner.clone();\n for each in iterables {\n let iter = each.try_iter()?;\n for value in iter {\n inner.insert_mut(Key::extract_bound(&value?)?);\n }\n }\n Ok(HashTrieSetPy { inner })\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct SetIterator {\n inner: HashTrieSetSync<Key>,\n}\n\n#[pymethods]\nimpl SetIterator {\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\n slf\n }\n\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<Key> {\n let first = slf.inner.iter().next()?.clone_ref(slf.py());\n slf.inner = slf.inner.remove(&first);\n Some(first)\n }\n}\n\n#[repr(transparent)]\n#[pyclass(name = \"List\", module = \"rpds\", frozen, sequence)]\nstruct ListPy {\n inner: ListSync<PyObject>,\n}\n\nimpl From<ListSync<PyObject>> for ListPy {\n fn from(elements: ListSync<PyObject>) -> Self {\n ListPy { inner: elements }\n }\n}\n\nimpl<'source> FromPyObject<'source> for ListPy {\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\n let mut ret = List::new_sync();\n let reversed = PyModule::import(ob.py(), \"builtins\")?.getattr(\"reversed\")?;\n let rob: Bound<'_, PyIterator> = reversed.call1((ob,))?.try_iter()?;\n for each in rob {\n ret.push_front_mut(each?.extract()?);\n }\n Ok(ListPy { inner: ret })\n }\n}\n\n#[pymethods]\nimpl ListPy {\n #[new]\n #[pyo3(signature = (*elements))]\n fn init(elements: &Bound<'_, PyTuple>) -> PyResult<Self> {\n let mut ret: ListPy;\n if elements.len() == 1 {\n ret = elements.get_item(0)?.extract()?;\n } else {\n ret = ListPy {\n inner: List::new_sync(),\n };\n if elements.len() > 1 {\n for each in (0..elements.len()).rev() {\n ret.inner\n .push_front_mut(elements.get_item(each)?.extract()?);\n }\n }\n }\n Ok(ret)\n }\n\n fn __len__(&self) -> usize {\n self.inner.len()\n }\n\n fn __repr__(&self, py: Python) -> PyResult<String> {\n let contents = self.inner.into_iter().map(|k| {\n Ok(k.into_pyobject(py)?\n .call_method0(\"__repr__\")\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr failed>\".to_owned()))\n });\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\n Ok(format!(\"List([{}])\", contents.join(\", \")))\n }\n\n fn __richcmp__(&self, other: &Self, op: CompareOp, py: Python<'_>) -> PyResult<PyObject> {\n match op {\n CompareOp::Eq => (self.inner.len() == other.inner.len()\n && self\n .inner\n .iter()\n .zip(other.inner.iter())\n .map(|(e1, e2)| e1.bind(py).eq(e2))\n .all(|r| r.unwrap_or(false)))\n .into_pyobject(py)\n .map_err(Into::into)\n .map(BoundObject::into_any)\n .map(BoundObject::unbind),\n CompareOp::Ne => (self.inner.len() != other.inner.len()\n || self\n .inner\n .iter()\n .zip(other.inner.iter())\n .map(|(e1, e2)| e1.bind(py).ne(e2))\n .any(|r| r.unwrap_or(true)))\n .into_pyobject(py)\n .map_err(Into::into)\n .map(BoundObject::into_any)\n .map(BoundObject::unbind),\n _ => Ok(py.NotImplemented()),\n }\n }\n\n fn __hash__(&self, py: Python) -> PyResult<u64> {\n let mut hasher = DefaultHasher::new();\n\n self.inner\n .iter()\n .enumerate()\n .try_for_each(|(index, each)| {\n each.bind(py)\n .hash()\n .map_err(|_| {\n PyTypeError::new_err(format!(\n \"Unhashable type at {} element in List: {}\",\n index,\n each.bind(py)\n .repr()\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr> error\".to_string())\n ))\n })\n .map(|x| hasher.write_isize(x))\n })?;\n\n Ok(hasher.finish())\n }\n\n fn __iter__(slf: PyRef<'_, Self>) -> ListIterator {\n ListIterator {\n inner: slf.inner.clone(),\n }\n }\n\n fn __reversed__(&self) -> ListPy {\n ListPy {\n inner: self.inner.reverse(),\n }\n }\n\n fn __reduce__(slf: PyRef<Self>) -> (Bound<'_, PyType>, (Vec<PyObject>,)) {\n (\n ListPy::type_object(slf.py()),\n (slf.inner.iter().map(|e| e.clone_ref(slf.py())).collect(),),\n )\n }\n\n #[getter]\n fn first(&self) -> PyResult<&PyObject> {\n self.inner\n .first()\n .ok_or_else(|| PyIndexError::new_err(\"empty list has no first element\"))\n }\n\n #[getter]\n fn rest(&self) -> ListPy {\n let mut inner = self.inner.clone();\n inner.drop_first_mut();\n ListPy { inner }\n }\n\n fn push_front(&self, other: PyObject) -> ListPy {\n ListPy {\n inner: self.inner.push_front(other),\n }\n }\n\n fn drop_first(&self) -> PyResult<ListPy> {\n if let Some(inner) = self.inner.drop_first() {\n Ok(ListPy { inner })\n } else {\n Err(PyIndexError::new_err(\"empty list has no first element\"))\n }\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct ListIterator {\n inner: ListSync<PyObject>,\n}\n\n#[pymethods]\nimpl ListIterator {\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\n slf\n }\n\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<PyObject> {\n let first_op = slf.inner.first()?;\n let first = first_op.clone_ref(slf.py());\n\n slf.inner = slf.inner.drop_first()?;\n\n Some(first)\n }\n}\n\n#[pyclass(module = \"rpds\")]\nstruct QueueIterator {\n inner: QueueSync<PyObject>,\n}\n\n#[pymethods]\nimpl QueueIterator {\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\n slf\n }\n\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<PyObject> {\n let first_op = slf.inner.peek()?;\n let first = first_op.clone_ref(slf.py());\n slf.inner = slf.inner.dequeue()?;\n Some(first)\n }\n}\n\n#[repr(transparent)]\n#[pyclass(name = \"Queue\", module = \"rpds\", frozen, sequence)]\nstruct QueuePy {\n inner: QueueSync<PyObject>,\n}\n\nimpl From<QueueSync<PyObject>> for QueuePy {\n fn from(elements: QueueSync<PyObject>) -> Self {\n QueuePy { inner: elements }\n }\n}\n\nimpl<'source> FromPyObject<'source> for QueuePy {\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\n let mut ret = Queue::new_sync();\n for each in ob.try_iter()? {\n ret.enqueue_mut(each?.extract()?);\n }\n Ok(QueuePy { inner: ret })\n }\n}\n\n#[pymethods]\nimpl QueuePy {\n #[new]\n #[pyo3(signature = (*elements))]\n fn init(elements: &Bound<'_, PyTuple>, py: Python<'_>) -> PyResult<Self> {\n let mut ret: QueuePy;\n if elements.len() == 1 {\n ret = elements.get_item(0)?.extract()?;\n } else {\n ret = QueuePy {\n inner: Queue::new_sync(),\n };\n if elements.len() > 1 {\n for each in elements {\n ret.inner.enqueue_mut(each.into_pyobject(py)?.unbind());\n }\n }\n }\n Ok(ret)\n }\n\n fn __eq__(&self, other: &Self, py: Python<'_>) -> bool {\n (self.inner.len() == other.inner.len())\n && self\n .inner\n .iter()\n .zip(other.inner.iter())\n .map(|(e1, e2)| e1.bind(py).eq(e2))\n .all(|r| r.unwrap_or(false))\n }\n\n fn __hash__(&self, py: Python<'_>) -> PyResult<u64> {\n let mut hasher = DefaultHasher::new();\n\n self.inner\n .iter()\n .enumerate()\n .try_for_each(|(index, each)| {\n each.bind(py)\n .hash()\n .map_err(|_| {\n PyTypeError::new_err(format!(\n \"Unhashable type at {} element in Queue: {}\",\n index,\n each.bind(py)\n .repr()\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr> error\".to_string())\n ))\n })\n .map(|x| hasher.write_isize(x))\n })?;\n\n Ok(hasher.finish())\n }\n\n fn __ne__(&self, other: &Self, py: Python<'_>) -> bool {\n (self.inner.len() != other.inner.len())\n || self\n .inner\n .iter()\n .zip(other.inner.iter())\n .map(|(e1, e2)| e1.bind(py).ne(e2))\n .any(|r| r.unwrap_or(true))\n }\n\n fn __iter__(slf: PyRef<'_, Self>) -> QueueIterator {\n QueueIterator {\n inner: slf.inner.clone(),\n }\n }\n\n fn __len__(&self) -> usize {\n self.inner.len()\n }\n\n fn __repr__(&self, py: Python) -> PyResult<String> {\n let contents = self.inner.into_iter().map(|k| {\n Ok(k.into_pyobject(py)?\n .call_method0(\"__repr__\")\n .and_then(|r| r.extract())\n .unwrap_or(\"<repr failed>\".to_owned()))\n });\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\n Ok(format!(\"Queue([{}])\", contents.join(\", \")))\n }\n\n #[getter]\n fn peek(&self, py: Python) -> PyResult<PyObject> {\n if let Some(peeked) = self.inner.peek() {\n Ok(peeked.clone_ref(py))\n } else {\n Err(PyIndexError::new_err(\"peeked an empty queue\"))\n }\n }\n\n #[getter]\n fn is_empty(&self) -> bool {\n self.inner.is_empty()\n }\n\n fn enqueue(&self, value: Bound<'_, PyAny>) -> Self {\n QueuePy {\n inner: self.inner.enqueue(value.into()),\n }\n }\n\n fn dequeue(&self) -> PyResult<QueuePy> {\n if let Some(inner) = self.inner.dequeue() {\n Ok(QueuePy { inner })\n } else {\n Err(PyIndexError::new_err(\"dequeued an empty queue\"))\n }\n }\n}\n\n#[pymodule(gil_used = false)]\n#[pyo3(name = \"rpds\")]\nfn rpds_py(py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {\n m.add_class::<HashTrieMapPy>()?;\n m.add_class::<HashTrieSetPy>()?;\n m.add_class::<ListPy>()?;\n m.add_class::<QueuePy>()?;\n\n PyMapping::register::<HashTrieMapPy>(py)?;\n\n let abc = PyModule::import(py, \"collections.abc\")?;\n\n abc.getattr(\"Set\")?\n .call_method1(\"register\", (HashTrieSetPy::type_object(py),))?;\n\n abc.getattr(\"MappingView\")?\n .call_method1(\"register\", (KeysView::type_object(py),))?;\n abc.getattr(\"MappingView\")?\n .call_method1(\"register\", (ValuesView::type_object(py),))?;\n abc.getattr(\"MappingView\")?\n .call_method1(\"register\", (ItemsView::type_object(py),))?;\n\n abc.getattr(\"KeysView\")?\n .call_method1(\"register\", (KeysView::type_object(py),))?;\n abc.getattr(\"ValuesView\")?\n .call_method1(\"register\", (ValuesView::type_object(py),))?;\n abc.getattr(\"ItemsView\")?\n .call_method1(\"register\", (ItemsView::type_object(py),))?;\n\n Ok(())\n}\n\n[end of src/lib.rs]","filename":"src/lib.rs","id":"15"}],"string":"[\n {\n \"content\": \"[package]\\nname = \\\"rpds-py\\\"\\nversion = \\\"0.23.1\\\"\\nedition = \\\"2021\\\"\\n\\n[lib]\\nname = \\\"rpds\\\"\\ncrate-type = [\\\"cdylib\\\"]\\n\\n[dependencies]\\nrpds = \\\"1.1.0\\\"\\narchery = \\\"1.2.1\\\"\\n\\n[dependencies.pyo3]\\nversion = \\\"0.23.4\\\"\\n# To build extension for PyPy on Windows, \\\"generate-import-lib\\\" is needed:\\n# https://github.com/PyO3/maturin-action/issues/267#issuecomment-2106844429\\nfeatures = [\\\"extension-module\\\", \\\"generate-import-lib\\\"]\\n\\n[end of Cargo.toml]\",\n \"filename\": \"Cargo.toml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"Copyright (c) 2023 Julian Berman\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"ci:\\n skip:\\n # pre-commit.ci doesn't have Rust installed\\n - fmt\\n - clippy\\n - zizmor\\n\\nrepos:\\n - repo: https://github.com/pre-commit/pre-commit-hooks\\n rev: v5.0.0\\n hooks:\\n - id: check-ast\\n - id: check-docstring-first\\n - id: check-toml\\n - id: check-vcs-permalinks\\n - id: check-yaml\\n - id: debug-statements\\n - id: end-of-file-fixer\\n - id: mixed-line-ending\\n args: [--fix, lf]\\n - id: trailing-whitespace\\n - repo: https://github.com/doublify/pre-commit-rust\\n rev: \\\"v1.0\\\"\\n hooks:\\n - id: fmt\\n - id: clippy\\n - repo: https://github.com/psf/black\\n rev: 25.1.0\\n hooks:\\n - id: black\\n - repo: https://github.com/pre-commit/mirrors-prettier\\n rev: \\\"v4.0.0-alpha.8\\\"\\n hooks:\\n - id: prettier\\n - repo: https://github.com/woodruffw/zizmor\\n rev: v0.8.0\\n hooks:\\n - id: zizmor\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"maturin>=1.2,<2.0\\\"]\\nbuild-backend = \\\"maturin\\\"\\n\\n[project]\\nname = \\\"rpds-py\\\"\\ndescription = \\\"Python bindings to Rust's persistent data structures (rpds)\\\"\\nrequires-python = \\\">=3.9\\\"\\nreadme = \\\"README.rst\\\"\\nlicense = \\\"MIT\\\"\\nlicense-files = [\\\"LICENSE\\\"]\\nkeywords = [\\\"data structures\\\", \\\"rust\\\", \\\"persistent\\\"]\\nauthors = [\\n { name = \\\"Julian Berman\\\", email = \\\"Julian+rpds@GrayVines.com\\\" },\\n]\\nclassifiers = [\\n \\\"Development Status :: 3 - Alpha\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Programming Language :: Rust\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Programming Language :: Python :: 3.10\\\",\\n \\\"Programming Language :: Python :: 3.11\\\",\\n \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: Implementation :: CPython\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n]\\ndynamic = [\\\"version\\\"]\\n\\n[project.urls]\\nDocumentation = \\\"https://rpds.readthedocs.io/\\\"\\nHomepage = \\\"https://github.com/crate-py/rpds\\\"\\nIssues = \\\"https://github.com/crate-py/rpds/issues/\\\"\\nFunding = \\\"https://github.com/sponsors/Julian\\\"\\nTidelift = \\\"https://tidelift.com/subscription/pkg/pypi-rpds-py?utm_source=pypi-rpds-py&utm_medium=referral&utm_campaign=pypi-link\\\"\\nSource = \\\"https://github.com/crate-py/rpds\\\"\\nUpstream = \\\"https://github.com/orium/rpds\\\"\\n\\n[tool.black]\\nline-length = 79\\n\\n[tool.coverage.html]\\nshow_contexts = true\\nskip_covered = false\\n\\n[tool.coverage.run]\\nbranch = true\\ndynamic_context = \\\"test_function\\\"\\n\\n[tool.coverage.report]\\nexclude_also = [\\n \\\"if TYPE_CHECKING:\\\",\\n \\\"\\\\\\\\s*\\\\\\\\.\\\\\\\\.\\\\\\\\.\\\\\\\\s*\\\",\\n]\\nfail_under = 100\\nshow_missing = true\\nskip_covered = true\\n\\n[tool.doc8]\\nignore = [\\n \\\"D000\\\", # see PyCQA/doc8#125\\n \\\"D001\\\", # one sentence per line, so max length doesn't make sense\\n]\\n\\n[tool.maturin]\\nfeatures = [\\\"pyo3/extension-module\\\"]\\n\\n[tool.pyright]\\nreportUnnecessaryTypeIgnoreComment = true\\nstrict = [\\\"**/*\\\"]\\nexclude = [\\n \\\"**/tests/__init__.py\\\",\\n \\\"**/tests/test_*.py\\\",\\n]\\n\\n[tool.ruff]\\nline-length = 79\\n\\n[tool.ruff.lint]\\nselect = [\\\"ALL\\\"]\\nignore = [\\n \\\"A001\\\", # It's fine to shadow builtins\\n \\\"A002\\\",\\n \\\"A003\\\",\\n \\\"A005\\\",\\n \\\"ARG\\\", # This is all wrong whenever an interface is involved\\n \\\"ANN\\\", # Just let the type checker do this\\n \\\"B006\\\", # Mutable arguments require care but are OK if you don't abuse them\\n \\\"B008\\\", # It's totally OK to call functions for default arguments.\\n \\\"B904\\\", # raise SomeException(...) is fine.\\n \\\"B905\\\", # No need for explicit strict, this is simply zip's default behavior\\n \\\"C408\\\", # Calling dict is fine when it saves quoting the keys\\n \\\"C901\\\", # Not really something to focus on\\n \\\"D105\\\", # It's fine to not have docstrings for magic methods.\\n \\\"D107\\\", # __init__ especially doesn't need a docstring\\n \\\"D200\\\", # This rule makes diffs uglier when expanding docstrings\\n \\\"D203\\\", # No blank lines before docstrings.\\n \\\"D212\\\", # Start docstrings on the second line.\\n \\\"D400\\\", # This rule misses sassy docstrings ending with ! or ?\\n \\\"D401\\\", # This rule is too flaky.\\n \\\"D406\\\", # Section headers should end with a colon not a newline\\n \\\"D407\\\", # Underlines aren't needed\\n \\\"D412\\\", # Plz spaces after section headers\\n \\\"EM101\\\", # These don't bother me, it's fine there's some duplication.\\n \\\"EM102\\\",\\n \\\"FBT\\\", # It's worth avoiding boolean args but I don't care to enforce it\\n \\\"FIX\\\", # Yes thanks, if I could it wouldn't be there\\n \\\"N\\\", # These naming rules are silly\\n \\\"PLR0912\\\", # These metrics are fine to be aware of but not to enforce\\n \\\"PLR0913\\\",\\n \\\"PLR0915\\\",\\n \\\"PLW2901\\\", # Shadowing for loop variables is occasionally fine.\\n \\\"PT006\\\", # pytest parametrize takes strings as well\\n \\\"PYI025\\\", # wat, I'm not confused, thanks.\\n \\\"RET502\\\", # Returning None implicitly is fine\\n \\\"RET503\\\",\\n \\\"RET505\\\", # These push you to use `if` instead of `elif`, but for no reason\\n \\\"RET506\\\",\\n \\\"RSE102\\\", # Ha, what, who even knew you could leave the parens off. But no.\\n \\\"SIM300\\\", # Not sure what heuristic this uses, but it's easily incorrect\\n \\\"SLF001\\\", # Private usage within this package itself is fine\\n \\\"TD\\\", # These TODO style rules are also silly\\n \\\"UP007\\\", # We support 3.9\\n]\\n\\n[tool.ruff.lint.flake8-pytest-style]\\nmark-parentheses = false\\n\\n[tool.ruff.lint.flake8-quotes]\\ndocstring-quotes = \\\"double\\\"\\n\\n[tool.ruff.lint.isort]\\ncombine-as-imports = true\\nfrom-first = true\\nknown-first-party = [\\\"rpds\\\"]\\n\\n[tool.ruff.lint.per-file-ignores]\\n\\\"noxfile.py\\\" = [\\\"ANN\\\", \\\"D100\\\", \\\"S101\\\", \\\"T201\\\"]\\n\\\"docs/*\\\" = [\\\"ANN\\\", \\\"D\\\", \\\"INP001\\\"]\\n\\\"tests/*\\\" = [\\\"ANN\\\", \\\"B018\\\", \\\"D\\\", \\\"PLR\\\", \\\"RUF012\\\", \\\"S\\\", \\\"SIM\\\", \\\"TRY\\\"]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"from typing import (\\n ItemsView,\\n Iterable,\\n Iterator,\\n KeysView,\\n Mapping,\\n TypeVar,\\n ValuesView,\\n)\\n\\n_T = TypeVar(\\\"_T\\\")\\n_KT_co = TypeVar(\\\"_KT_co\\\", covariant=True)\\n_VT_co = TypeVar(\\\"_VT_co\\\", covariant=True)\\n_KU_co = TypeVar(\\\"_KU_co\\\", covariant=True)\\n_VU_co = TypeVar(\\\"_VU_co\\\", covariant=True)\\n\\nclass HashTrieMap(Mapping[_KT_co, _VT_co]):\\n def __init__(\\n self,\\n value: Mapping[_KT_co, _VT_co] | Iterable[tuple[_KT_co, _VT_co]] = {},\\n **kwds: Mapping[_KT_co, _VT_co],\\n ): ...\\n def __getitem__(self, key: _KT_co) -> _VT_co: ...\\n def __iter__(self) -> Iterator[_KT_co]: ...\\n def __len__(self) -> int: ...\\n def discard(self, key: _KT_co) -> HashTrieMap[_KT_co, _VT_co]: ...\\n def items(self) -> ItemsView[_KT_co, _VT_co]: ...\\n def keys(self) -> KeysView[_KT_co]: ...\\n def values(self) -> ValuesView[_VT_co]: ...\\n def remove(self, key: _KT_co) -> HashTrieMap[_KT_co, _VT_co]: ...\\n def insert(\\n self,\\n key: _KT_co,\\n val: _VT_co,\\n ) -> HashTrieMap[_KT_co, _VT_co]: ...\\n def update(\\n self,\\n *args: Mapping[_KU_co, _VU_co] | Iterable[tuple[_KU_co, _VU_co]],\\n ) -> HashTrieMap[_KT_co | _KU_co, _VT_co | _VU_co]: ...\\n @classmethod\\n def convert(\\n cls,\\n value: Mapping[_KT_co, _VT_co] | Iterable[tuple[_KT_co, _VT_co]],\\n ) -> HashTrieMap[_KT_co, _VT_co]: ...\\n @classmethod\\n def fromkeys(\\n cls,\\n keys: Iterable[_KT_co],\\n value: _VT_co = None,\\n ) -> HashTrieMap[_KT_co, _VT_co]: ...\\n\\nclass HashTrieSet(frozenset[_T]):\\n def __init__(self, value: Iterable[_T] = ()): ...\\n def __iter__(self) -> Iterator[_T]: ...\\n def __len__(self) -> int: ...\\n def discard(self, value: _T) -> HashTrieSet[_T]: ...\\n def remove(self, value: _T) -> HashTrieSet[_T]: ...\\n def insert(self, value: _T) -> HashTrieSet[_T]: ...\\n def update(self, *args: Iterable[_T]) -> HashTrieSet[_T]: ...\\n\\nclass List(Iterable[_T]):\\n def __init__(self, value: Iterable[_T] = (), *more: _T): ...\\n def __iter__(self) -> Iterator[_T]: ...\\n def __len__(self) -> int: ...\\n def push_front(self, value: _T) -> List[_T]: ...\\n def drop_first(self) -> List[_T]: ...\\n\\nclass Queue(Iterable[_T]):\\n def __init__(self, value: Iterable[_T] = (), *more: _T): ...\\n def __iter__(self) -> Iterator[_T]: ...\\n def __len__(self) -> int: ...\\n def enqueue(self, value: _T) -> Queue[_T]: ...\\n def dequeue(self, value: _T) -> Queue[_T]: ...\\n @property\\n def is_empty(self) -> _T: ...\\n @property\\n def peek(self) -> _T: ...\\n\\n[end of rpds.pyi]\",\n \"filename\": \"rpds.pyi\",\n \"id\": \"4\"\n },\n {\n \"content\": \"# This file is automatically @generated by Cargo.\\n# It is not intended for manual editing.\\nversion = 4\\n\\n[[package]]\\nname = \\\"archery\\\"\\nversion = \\\"1.2.1\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"eae2ed21cd55021f05707a807a5fc85695dafb98832921f6cfa06db67ca5b869\\\"\\ndependencies = [\\n \\\"triomphe\\\",\\n]\\n\\n[[package]]\\nname = \\\"autocfg\\\"\\nversion = \\\"1.3.0\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0\\\"\\n\\n[[package]]\\nname = \\\"cc\\\"\\nversion = \\\"1.0.90\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"8cd6604a82acf3039f1144f54b8eb34e91ffba622051189e71b781822d5ee1f5\\\"\\n\\n[[package]]\\nname = \\\"cfg-if\\\"\\nversion = \\\"1.0.0\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd\\\"\\n\\n[[package]]\\nname = \\\"heck\\\"\\nversion = \\\"0.5.0\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea\\\"\\n\\n[[package]]\\nname = \\\"indoc\\\"\\nversion = \\\"2.0.5\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"b248f5224d1d606005e02c97f5aa4e88eeb230488bcc03bc9ca4d7991399f2b5\\\"\\n\\n[[package]]\\nname = \\\"libc\\\"\\nversion = \\\"0.2.155\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c\\\"\\n\\n[[package]]\\nname = \\\"memoffset\\\"\\nversion = \\\"0.9.1\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a\\\"\\ndependencies = [\\n \\\"autocfg\\\",\\n]\\n\\n[[package]]\\nname = \\\"once_cell\\\"\\nversion = \\\"1.19.0\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92\\\"\\n\\n[[package]]\\nname = \\\"portable-atomic\\\"\\nversion = \\\"1.6.0\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"7170ef9988bc169ba16dd36a7fa041e5c4cbeb6a35b76d4c03daded371eae7c0\\\"\\n\\n[[package]]\\nname = \\\"proc-macro2\\\"\\nversion = \\\"1.0.86\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77\\\"\\ndependencies = [\\n \\\"unicode-ident\\\",\\n]\\n\\n[[package]]\\nname = \\\"pyo3\\\"\\nversion = \\\"0.23.4\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"57fe09249128b3173d092de9523eaa75136bf7ba85e0d69eca241c7939c933cc\\\"\\ndependencies = [\\n \\\"cfg-if\\\",\\n \\\"indoc\\\",\\n \\\"libc\\\",\\n \\\"memoffset\\\",\\n \\\"once_cell\\\",\\n \\\"portable-atomic\\\",\\n \\\"pyo3-build-config\\\",\\n \\\"pyo3-ffi\\\",\\n \\\"pyo3-macros\\\",\\n \\\"unindent\\\",\\n]\\n\\n[[package]]\\nname = \\\"pyo3-build-config\\\"\\nversion = \\\"0.23.4\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"1cd3927b5a78757a0d71aa9dff669f903b1eb64b54142a9bd9f757f8fde65fd7\\\"\\ndependencies = [\\n \\\"once_cell\\\",\\n \\\"python3-dll-a\\\",\\n \\\"target-lexicon\\\",\\n]\\n\\n[[package]]\\nname = \\\"pyo3-ffi\\\"\\nversion = \\\"0.23.4\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"dab6bb2102bd8f991e7749f130a70d05dd557613e39ed2deeee8e9ca0c4d548d\\\"\\ndependencies = [\\n \\\"libc\\\",\\n \\\"pyo3-build-config\\\",\\n]\\n\\n[[package]]\\nname = \\\"pyo3-macros\\\"\\nversion = \\\"0.23.4\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"91871864b353fd5ffcb3f91f2f703a22a9797c91b9ab497b1acac7b07ae509c7\\\"\\ndependencies = [\\n \\\"proc-macro2\\\",\\n \\\"pyo3-macros-backend\\\",\\n \\\"quote\\\",\\n \\\"syn\\\",\\n]\\n\\n[[package]]\\nname = \\\"pyo3-macros-backend\\\"\\nversion = \\\"0.23.4\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"43abc3b80bc20f3facd86cd3c60beed58c3e2aa26213f3cda368de39c60a27e4\\\"\\ndependencies = [\\n \\\"heck\\\",\\n \\\"proc-macro2\\\",\\n \\\"pyo3-build-config\\\",\\n \\\"quote\\\",\\n \\\"syn\\\",\\n]\\n\\n[[package]]\\nname = \\\"python3-dll-a\\\"\\nversion = \\\"0.2.12\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"9b66f9171950e674e64bad3456e11bb3cca108e5c34844383cfe277f45c8a7a8\\\"\\ndependencies = [\\n \\\"cc\\\",\\n]\\n\\n[[package]]\\nname = \\\"quote\\\"\\nversion = \\\"1.0.36\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7\\\"\\ndependencies = [\\n \\\"proc-macro2\\\",\\n]\\n\\n[[package]]\\nname = \\\"rpds\\\"\\nversion = \\\"1.1.0\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"a0e15515d3ce3313324d842629ea4905c25a13f81953eadb88f85516f59290a4\\\"\\ndependencies = [\\n \\\"archery\\\",\\n]\\n\\n[[package]]\\nname = \\\"rpds-py\\\"\\nversion = \\\"0.23.1\\\"\\ndependencies = [\\n \\\"archery\\\",\\n \\\"pyo3\\\",\\n \\\"rpds\\\",\\n]\\n\\n[[package]]\\nname = \\\"syn\\\"\\nversion = \\\"2.0.69\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"201fcda3845c23e8212cd466bfebf0bd20694490fc0356ae8e428e0824a915a6\\\"\\ndependencies = [\\n \\\"proc-macro2\\\",\\n \\\"quote\\\",\\n \\\"unicode-ident\\\",\\n]\\n\\n[[package]]\\nname = \\\"target-lexicon\\\"\\nversion = \\\"0.12.14\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"e1fc403891a21bcfb7c37834ba66a547a8f402146eba7265b5a6d88059c9ff2f\\\"\\n\\n[[package]]\\nname = \\\"triomphe\\\"\\nversion = \\\"0.1.13\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"e6631e42e10b40c0690bf92f404ebcfe6e1fdb480391d15f17cc8e96eeed5369\\\"\\n\\n[[package]]\\nname = \\\"unicode-ident\\\"\\nversion = \\\"1.0.12\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b\\\"\\n\\n[[package]]\\nname = \\\"unindent\\\"\\nversion = \\\"0.2.3\\\"\\nsource = \\\"registry+https://github.com/rust-lang/crates.io-index\\\"\\nchecksum = \\\"c7de7d73e1754487cb58364ee906a499937a0dfabd86bcb980fa99ec8c8fa2ce\\\"\\n\\n[end of Cargo.lock]\",\n \"filename\": \"Cargo.lock\",\n \"id\": \"5\"\n },\n {\n \"content\": \"version: 2\\n\\nbuild:\\n os: ubuntu-22.04\\n tools:\\n python: \\\"3.11\\\"\\n rust: \\\"1.70\\\"\\n\\nsphinx:\\n builder: dirhtml\\n configuration: docs/conf.py\\n fail_on_warning: true\\n\\nformats: all\\n\\npython:\\n install:\\n - requirements: docs/requirements.txt\\n\\n[end of .readthedocs.yml]\",\n \"filename\": \".readthedocs.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"===========\\n``rpds.py``\\n===========\\n\\n|PyPI| |Pythons| |CI|\\n\\n.. |PyPI| image:: https://img.shields.io/pypi/v/rpds-py.svg\\n :alt: PyPI version\\n :target: https://pypi.org/project/rpds-py/\\n\\n.. |Pythons| image:: https://img.shields.io/pypi/pyversions/rpds-py.svg\\n :alt: Supported Python versions\\n :target: https://pypi.org/project/rpds-py/\\n\\n.. |CI| image:: https://github.com/crate-py/rpds/workflows/CI/badge.svg\\n :alt: Build status\\n :target: https://github.com/crate-py/rpds/actions?query=workflow%3ACI\\n\\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/referencing/badge/?version=stable&style=flat\\n :alt: ReadTheDocs status\\n :target: https://referencing.readthedocs.io/en/stable/\\n\\n\\nPython bindings to the `Rust rpds crate <https://docs.rs/rpds/>`_ for persistent data structures.\\n\\nWhat's here is quite minimal (in transparency, it was written initially to support replacing ``pyrsistent`` in the `referencing library <https://github.com/python-jsonschema/referencing>`_).\\nIf you see something missing (which is very likely), a PR is definitely welcome to add it.\\n\\nInstallation\\n------------\\n\\nThe distribution on PyPI is named ``rpds.py`` (equivalently ``rpds-py``), and thus can be installed via e.g.:\\n\\n.. code:: sh\\n\\n $ pip install rpds-py\\n\\nNote that if you install ``rpds-py`` from source, you will need a Rust toolchain installed, as it is a build-time dependency.\\nAn example of how to do so in a ``Dockerfile`` can be found `here <https://github.com/bowtie-json-schema/bowtie/blob/e77fd93598cb6e7dc1b8b1f53c00e5aa410c201a/implementations/python-jsonschema/Dockerfile#L1-L8>`_.\\n\\nIf you believe you are on a common platform which should have wheels built (i.e. and not need to compile from source), feel free to file an issue or pull request modifying the GitHub action used here to build wheels via ``maturin``.\\n\\nUsage\\n-----\\n\\nMethods in general are named similarly to their ``rpds`` counterparts (rather than ``pyrsistent``\\\\ 's conventions, though probably a full drop-in ``pyrsistent``\\\\ -compatible wrapper module is a good addition at some point).\\n\\n.. code:: python\\n\\n >>> from rpds import HashTrieMap, HashTrieSet, List\\n\\n >>> m = HashTrieMap({\\\"foo\\\": \\\"bar\\\", \\\"baz\\\": \\\"quux\\\"})\\n >>> m.insert(\\\"spam\\\", 37) == HashTrieMap({\\\"foo\\\": \\\"bar\\\", \\\"baz\\\": \\\"quux\\\", \\\"spam\\\": 37})\\n True\\n >>> m.remove(\\\"foo\\\") == HashTrieMap({\\\"baz\\\": \\\"quux\\\"})\\n True\\n\\n >>> s = HashTrieSet({\\\"foo\\\", \\\"bar\\\", \\\"baz\\\", \\\"quux\\\"})\\n >>> s.insert(\\\"spam\\\") == HashTrieSet({\\\"foo\\\", \\\"bar\\\", \\\"baz\\\", \\\"quux\\\", \\\"spam\\\"})\\n True\\n >>> s.remove(\\\"foo\\\") == HashTrieSet({\\\"bar\\\", \\\"baz\\\", \\\"quux\\\"})\\n True\\n\\n >>> L = List([1, 3, 5])\\n >>> L.push_front(-1) == List([-1, 1, 3, 5])\\n True\\n >>> L.rest == List([3, 5])\\n True\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"from pathlib import Path\\nfrom tempfile import TemporaryDirectory\\nimport os\\n\\nimport nox\\n\\nROOT = Path(__file__).parent\\nPYPROJECT = ROOT / \\\"pyproject.toml\\\"\\nDOCS = ROOT / \\\"docs\\\"\\nTESTS = ROOT / \\\"tests\\\"\\n\\nREQUIREMENTS = dict(\\n docs=DOCS / \\\"requirements.txt\\\",\\n tests=TESTS / \\\"requirements.txt\\\",\\n)\\nREQUIREMENTS_IN = [ # this is actually ordered, as files depend on each other\\n (path.parent / f\\\"{path.stem}.in\\\", path) for path in REQUIREMENTS.values()\\n]\\n\\nSUPPORTED = [\\\"3.9\\\", \\\"3.10\\\", \\\"pypy3.10\\\", \\\"3.11\\\", \\\"3.12\\\", \\\"3.13\\\", \\\"3.13t\\\"]\\nLATEST = \\\"3.13\\\"\\n\\nnox.options.default_venv_backend = \\\"uv|virtualenv\\\"\\nnox.options.sessions = []\\n\\n\\ndef session(default=True, python=LATEST, **kwargs): # noqa: D103\\n def _session(fn):\\n if default:\\n nox.options.sessions.append(kwargs.get(\\\"name\\\", fn.__name__))\\n return nox.session(python=python, **kwargs)(fn)\\n\\n return _session\\n\\n\\n@session(python=SUPPORTED)\\ndef tests(session):\\n \\\"\\\"\\\"\\n Run the test suite with a corresponding Python version.\\n \\\"\\\"\\\"\\n # Really we want --profile=test here (for\\n # https://github.com/crate-py/rpds/pull/87#issuecomment-2291409297)\\n # but it produces strange symbol errors saying:\\n # dynamic module does not define module export function (PyInit_rpds)\\n # so OK, dev it is.\\n session.install(\\n \\\"--config-settings\\\",\\n \\\"build-args=--profile=dev\\\",\\n \\\"--no-cache\\\",\\n \\\"-r\\\",\\n REQUIREMENTS[\\\"tests\\\"],\\n )\\n\\n if session.posargs and session.posargs[0] == \\\"coverage\\\":\\n if len(session.posargs) > 1 and session.posargs[1] == \\\"github\\\":\\n github = Path(os.environ[\\\"GITHUB_STEP_SUMMARY\\\"])\\n else:\\n github = None\\n\\n session.install(\\\"coverage[toml]\\\")\\n session.run(\\\"coverage\\\", \\\"run\\\", \\\"-m\\\", \\\"pytest\\\", TESTS)\\n if github is None:\\n session.run(\\\"coverage\\\", \\\"report\\\")\\n else:\\n with github.open(\\\"a\\\") as summary:\\n summary.write(\\\"### Coverage\\\\n\\\\n\\\")\\n summary.flush() # without a flush, output seems out of order.\\n session.run(\\n \\\"coverage\\\",\\n \\\"report\\\",\\n \\\"--format=markdown\\\",\\n stdout=summary,\\n )\\n else:\\n session.run(\\\"pytest\\\", \\\"--parallel-threads=10\\\", *session.posargs, TESTS)\\n\\n\\n@session()\\ndef audit(session):\\n \\\"\\\"\\\"\\n Audit dependencies for vulnerabilities.\\n \\\"\\\"\\\"\\n session.install(\\\"pip-audit\\\", ROOT)\\n session.run(\\\"python\\\", \\\"-m\\\", \\\"pip_audit\\\")\\n\\n\\n@session(tags=[\\\"build\\\"])\\ndef build(session):\\n \\\"\\\"\\\"\\n Build a distribution suitable for PyPI and check its validity.\\n \\\"\\\"\\\"\\n session.install(\\\"build\\\", \\\"twine\\\")\\n with TemporaryDirectory() as tmpdir:\\n session.run(\\\"python\\\", \\\"-m\\\", \\\"build\\\", ROOT, \\\"--outdir\\\", tmpdir)\\n session.run(\\\"twine\\\", \\\"check\\\", \\\"--strict\\\", tmpdir + \\\"/*\\\")\\n\\n\\n@session(tags=[\\\"style\\\"])\\ndef style(session):\\n \\\"\\\"\\\"\\n Check Python code style.\\n \\\"\\\"\\\"\\n session.install(\\\"ruff\\\")\\n session.run(\\\"ruff\\\", \\\"check\\\", TESTS, __file__)\\n\\n\\n@session()\\ndef typing(session):\\n \\\"\\\"\\\"\\n Check the codebase using pyright by type checking the test suite.\\n \\\"\\\"\\\"\\n session.install(\\\"pyright\\\", ROOT, \\\"-r\\\", REQUIREMENTS[\\\"tests\\\"])\\n session.run(\\\"pyright\\\", TESTS)\\n\\n\\n@session(tags=[\\\"docs\\\"])\\n@nox.parametrize(\\n \\\"builder\\\",\\n [\\n nox.param(name, id=name)\\n for name in [\\n \\\"dirhtml\\\",\\n \\\"doctest\\\",\\n \\\"linkcheck\\\",\\n \\\"man\\\",\\n \\\"spelling\\\",\\n ]\\n ],\\n)\\ndef docs(session, builder):\\n \\\"\\\"\\\"\\n Build the documentation using a specific Sphinx builder.\\n \\\"\\\"\\\"\\n session.install(\\\"-r\\\", REQUIREMENTS[\\\"docs\\\"])\\n with TemporaryDirectory() as tmpdir_str:\\n tmpdir = Path(tmpdir_str)\\n argv = [\\\"-n\\\", \\\"-T\\\", \\\"-W\\\"]\\n if builder != \\\"spelling\\\":\\n argv += [\\\"-q\\\"]\\n posargs = session.posargs or [tmpdir / builder]\\n session.run(\\n \\\"python\\\",\\n \\\"-m\\\",\\n \\\"sphinx\\\",\\n \\\"-b\\\",\\n builder,\\n DOCS,\\n *argv,\\n *posargs,\\n )\\n\\n\\n@session(tags=[\\\"docs\\\", \\\"style\\\"], name=\\\"docs(style)\\\")\\ndef docs_style(session):\\n \\\"\\\"\\\"\\n Check the documentation style.\\n \\\"\\\"\\\"\\n session.install(\\n \\\"doc8\\\",\\n \\\"pygments\\\",\\n \\\"pygments-github-lexers\\\",\\n )\\n session.run(\\\"python\\\", \\\"-m\\\", \\\"doc8\\\", \\\"--config\\\", PYPROJECT, DOCS)\\n\\n\\n@session(default=False)\\ndef requirements(session):\\n \\\"\\\"\\\"\\n Update the project's pinned requirements.\\n\\n You should commit the result afterwards.\\n \\\"\\\"\\\"\\n if session.venv_backend == \\\"uv\\\":\\n cmd = [\\\"uv\\\", \\\"pip\\\", \\\"compile\\\"]\\n else:\\n session.install(\\\"pip-tools\\\")\\n cmd = [\\\"pip-compile\\\", \\\"--resolver\\\", \\\"backtracking\\\", \\\"--strip-extras\\\"]\\n\\n for each, out in REQUIREMENTS_IN:\\n # otherwise output files end up with silly absolute path comments...\\n relative = each.relative_to(ROOT)\\n session.run(*cmd, \\\"--upgrade\\\", \\\"--output-file\\\", out, relative)\\n\\n[end of noxfile.py]\",\n \"filename\": \"noxfile.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"Python bindings to the `Rust rpds crate <https://docs.rs/rpds/>`_ for persistent data structures.\\n\\nWhat's here is quite minimal (in transparency, it was written initially to support replacing ``pyrsistent`` in the `referencing library <https://github.com/python-jsonschema/referencing>`_).\\nIf you see something missing (which is very likely), a PR is definitely welcome to add it.\\n\\nInstallation\\n------------\\n\\nThe distribution on PyPI is named ``rpds.py`` (equivalently ``rpds-py``), and thus can be installed via e.g.:\\n\\n.. code:: sh\\n\\n $ pip install rpds-py\\n\\nNote that if you install ``rpds-py`` from source, you will need a Rust toolchain installed, as it is a build-time dependency.\\nAn example of how to do so in a ``Dockerfile`` can be found `here <https://github.com/bowtie-json-schema/bowtie/blob/e77fd93598cb6e7dc1b8b1f53c00e5aa410c201a/implementations/python-jsonschema/Dockerfile#L1-L8>`_.\\n\\nIf you believe you are on a common platform which should have wheels built (i.e. and not need to compile from source), feel free to file an issue or pull request modifying the GitHub action used here to build wheels via ``maturin``.\\n\\nUsage\\n-----\\n\\nMethods in general are named similarly to their ``rpds`` counterparts (rather than ``pyrsistent``\\\\ 's conventions, though probably a full drop-in ``pyrsistent``\\\\ -compatible wrapper module is a good addition at some point).\\n\\n.. code:: python\\n\\n >>> from rpds import HashTrieMap, HashTrieSet, List\\n\\n >>> m = HashTrieMap({\\\"foo\\\": \\\"bar\\\", \\\"baz\\\": \\\"quux\\\"})\\n >>> m.insert(\\\"spam\\\", 37) == HashTrieMap({\\\"foo\\\": \\\"bar\\\", \\\"baz\\\": \\\"quux\\\", \\\"spam\\\": 37})\\n True\\n >>> m.remove(\\\"foo\\\") == HashTrieMap({\\\"baz\\\": \\\"quux\\\"})\\n True\\n\\n >>> s = HashTrieSet({\\\"foo\\\", \\\"bar\\\", \\\"baz\\\", \\\"quux\\\"})\\n >>> s.insert(\\\"spam\\\") == HashTrieSet({\\\"foo\\\", \\\"bar\\\", \\\"baz\\\", \\\"quux\\\", \\\"spam\\\"})\\n True\\n >>> s.remove(\\\"foo\\\") == HashTrieSet({\\\"bar\\\", \\\"baz\\\", \\\"quux\\\"})\\n True\\n\\n >>> L = List([1, 3, 5])\\n >>> L.push_front(-1) == List([-1, 1, 3, 5])\\n True\\n >>> L.rest == List([3, 5])\\n True\\n\\n\\n.. toctree::\\n :glob:\\n :hidden:\\n\\n api\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# This file was autogenerated by uv via the following command:\\n# uv pip compile --output-file /Users/julian/Development/rpds.py/docs/requirements.txt docs/requirements.in\\nalabaster==1.0.0\\n # via sphinx\\nbabel==2.17.0\\n # via sphinx\\nbeautifulsoup4==4.13.3\\n # via furo\\ncertifi==2025.1.31\\n # via requests\\ncharset-normalizer==3.4.1\\n # via requests\\ndocutils==0.21.2\\n # via sphinx\\nfuro==2024.8.6\\n # via -r docs/requirements.in\\nidna==3.10\\n # via requests\\nimagesize==1.4.1\\n # via sphinx\\njinja2==3.1.5\\n # via sphinx\\nmarkupsafe==3.0.2\\n # via jinja2\\npackaging==24.2\\n # via sphinx\\npyenchant==3.2.2\\n # via sphinxcontrib-spelling\\npygments==2.19.1\\n # via\\n # furo\\n # pygments-github-lexers\\n # sphinx\\npygments-github-lexers==0.0.5\\n # via -r docs/requirements.in\\nrequests==2.32.3\\n # via\\n # sphinx\\n # sphinxcontrib-spelling\\nrpds-py @ file:.#egg=rpds-py\\n # via -r docs/requirements.in\\nsnowballstemmer==2.2.0\\n # via sphinx\\nsoupsieve==2.6\\n # via beautifulsoup4\\nsphinx==8.1.3\\n # via\\n # -r docs/requirements.in\\n # furo\\n # sphinx-basic-ng\\n # sphinx-copybutton\\n # sphinxcontrib-spelling\\n # sphinxext-opengraph\\nsphinx-basic-ng==1.0.0b2\\n # via furo\\nsphinx-copybutton==0.5.2\\n # via -r docs/requirements.in\\nsphinxcontrib-applehelp==2.0.0\\n # via sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via sphinx\\nsphinxcontrib-qthelp==2.0.0\\n # via sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via sphinx\\nsphinxcontrib-spelling==8.0.1\\n # via -r docs/requirements.in\\nsphinxext-opengraph==0.9.1\\n # via -r docs/requirements.in\\ntyping-extensions==4.12.2\\n # via beautifulsoup4\\nurl-py==0.14.1\\n # via -r docs/requirements.in\\nurllib3==2.3.0\\n # via requests\\n\\n[end of docs/requirements.txt]\",\n \"filename\": \"docs/requirements.txt\",\n \"id\": \"10\"\n },\n {\n \"content\": \"import importlib.metadata\\nimport re\\n\\nfrom url import URL\\n\\nGITHUB = URL.parse(\\\"https://github.com/\\\")\\nHOMEPAGE = GITHUB / \\\"crate-py/rpds\\\"\\n\\nproject = \\\"rpds.py\\\"\\nauthor = \\\"Julian Berman\\\"\\ncopyright = f\\\"2023, {author}\\\"\\n\\nrelease = importlib.metadata.version(\\\"rpds.py\\\")\\nversion = release.partition(\\\"-\\\")[0]\\n\\nlanguage = \\\"en\\\"\\ndefault_role = \\\"any\\\"\\n\\nextensions = [\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"sphinx.ext.autosectionlabel\\\",\\n \\\"sphinx.ext.coverage\\\",\\n \\\"sphinx.ext.doctest\\\",\\n \\\"sphinx.ext.extlinks\\\",\\n \\\"sphinx.ext.intersphinx\\\",\\n \\\"sphinx.ext.napoleon\\\",\\n \\\"sphinx.ext.todo\\\",\\n \\\"sphinx.ext.viewcode\\\",\\n \\\"sphinx_copybutton\\\",\\n \\\"sphinxcontrib.spelling\\\",\\n \\\"sphinxext.opengraph\\\",\\n]\\n\\npygments_style = \\\"lovelace\\\"\\npygments_dark_style = \\\"one-dark\\\"\\n\\nhtml_theme = \\\"furo\\\"\\n\\n\\ndef entire_domain(host):\\n return r\\\"http.?://\\\" + re.escape(host) + r\\\"($|/.*)\\\"\\n\\n\\nlinkcheck_ignore = [\\n entire_domain(\\\"img.shields.io\\\"),\\n f\\\"{GITHUB}.*#.*\\\",\\n str(HOMEPAGE / \\\"actions\\\"),\\n str(HOMEPAGE / \\\"workflows/CI/badge.svg\\\"),\\n]\\n\\n# = Extensions =\\n\\n# -- autodoc --\\n\\nautodoc_default_options = {\\n \\\"members\\\": True,\\n \\\"member-order\\\": \\\"bysource\\\",\\n}\\n\\n# -- autosectionlabel --\\n\\nautosectionlabel_prefix_document = True\\n\\n# -- intersphinx --\\n\\nintersphinx_mapping = {\\n \\\"python\\\": (\\\"https://docs.python.org/\\\", None),\\n}\\n\\n# -- extlinks --\\n\\nextlinks = {\\n \\\"gh\\\": (str(HOMEPAGE) + \\\"/%s\\\", None),\\n \\\"github\\\": (str(GITHUB) + \\\"/%s\\\", None),\\n}\\nextlinks_detect_hardcoded_links = True\\n\\n# -- sphinx-copybutton --\\n\\ncopybutton_prompt_text = r\\\">>> |\\\\.\\\\.\\\\. |\\\\$\\\"\\ncopybutton_prompt_is_regexp = True\\n\\n# -- sphinxcontrib-spelling --\\n\\nspelling_word_list_filename = \\\"spelling-wordlist.txt\\\"\\nspelling_show_suggestions = True\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"iter\\nlen\\ntoolchain\\n\\n[end of docs/spelling-wordlist.txt]\",\n \"filename\": \"docs/spelling-wordlist.txt\",\n \"id\": \"12\"\n },\n {\n \"content\": \"API Reference\\n=============\\n\\n.. automodule:: rpds\\n :members:\\n :undoc-members:\\n :imported-members:\\n :special-members: __iter__, __getitem__, __len__, __rmatmul__\\n\\n[end of docs/api.rst]\",\n \"filename\": \"docs/api.rst\",\n \"id\": \"13\"\n },\n {\n \"content\": \"file:.#egg=rpds-py\\nfuro\\npygments-github-lexers\\nsphinx-copybutton\\nsphinx>5\\nsphinxcontrib-spelling>5\\nsphinxext-opengraph\\nurl.py\\n\\n[end of docs/requirements.in]\",\n \"filename\": \"docs/requirements.in\",\n \"id\": \"14\"\n },\n {\n \"content\": \"use pyo3::exceptions::{PyIndexError, PyTypeError};\\nuse pyo3::pyclass::CompareOp;\\nuse pyo3::types::{PyDict, PyIterator, PyTuple, PyType};\\nuse pyo3::{exceptions::PyKeyError, types::PyMapping, types::PyTupleMethods};\\nuse pyo3::{prelude::*, AsPyPointer, BoundObject, PyTypeInfo};\\nuse rpds::{\\n HashTrieMap, HashTrieMapSync, HashTrieSet, HashTrieSetSync, List, ListSync, Queue, QueueSync,\\n};\\nuse std::collections::hash_map::DefaultHasher;\\nuse std::hash::{Hash, Hasher};\\n\\nfn hash_shuffle_bits(h: usize) -> usize {\\n ((h ^ 89869747) ^ (h << 16)).wrapping_mul(3644798167)\\n}\\n\\n#[derive(Debug)]\\nstruct Key {\\n hash: isize,\\n inner: PyObject,\\n}\\n\\nimpl<'py> IntoPyObject<'py> for Key {\\n type Target = PyAny;\\n type Output = Bound<'py, Self::Target>;\\n type Error = std::convert::Infallible;\\n\\n fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error> {\\n Ok(self.inner.into_bound(py))\\n }\\n}\\n\\nimpl<'a, 'py> IntoPyObject<'py> for &'a Key {\\n type Target = PyAny;\\n type Output = Borrowed<'a, 'py, Self::Target>;\\n type Error = std::convert::Infallible;\\n\\n fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error> {\\n Ok(self.inner.bind_borrowed(py))\\n }\\n}\\n\\nimpl Hash for Key {\\n fn hash<H: Hasher>(&self, state: &mut H) {\\n state.write_isize(self.hash);\\n }\\n}\\n\\nimpl Eq for Key {}\\n\\nimpl PartialEq for Key {\\n fn eq(&self, other: &Self) -> bool {\\n Python::with_gil(|py| {\\n self.inner\\n .call_method1(py, \\\"__eq__\\\", (&other.inner,))\\n .and_then(|value| value.extract(py))\\n .expect(\\\"__eq__ failed!\\\")\\n })\\n }\\n}\\n\\nimpl Key {\\n fn clone_ref(&self, py: Python<'_>) -> Self {\\n Key {\\n hash: self.hash,\\n inner: self.inner.clone_ref(py),\\n }\\n }\\n}\\n\\nunsafe impl AsPyPointer for Key {\\n fn as_ptr(&self) -> *mut pyo3::ffi::PyObject {\\n self.inner.as_ptr()\\n }\\n}\\n\\nimpl<'source> FromPyObject<'source> for Key {\\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\\n Ok(Key {\\n hash: ob.hash()?,\\n inner: ob.clone().unbind(),\\n })\\n }\\n}\\n\\n#[repr(transparent)]\\n#[pyclass(name = \\\"HashTrieMap\\\", module = \\\"rpds\\\", frozen, mapping)]\\nstruct HashTrieMapPy {\\n inner: HashTrieMapSync<Key, PyObject>,\\n}\\n\\nimpl From<HashTrieMapSync<Key, PyObject>> for HashTrieMapPy {\\n fn from(map: HashTrieMapSync<Key, PyObject>) -> Self {\\n HashTrieMapPy { inner: map }\\n }\\n}\\n\\nimpl<'source> FromPyObject<'source> for HashTrieMapPy {\\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\\n let mut ret = HashTrieMap::new_sync();\\n if let Ok(mapping) = ob.downcast::<PyMapping>() {\\n for each in mapping.items()?.iter() {\\n let (k, v): (Key, PyObject) = each.extract()?;\\n ret.insert_mut(k, v);\\n }\\n } else {\\n for each in ob.try_iter()? {\\n let (k, v) = each?.extract()?;\\n ret.insert_mut(k, v);\\n }\\n }\\n Ok(HashTrieMapPy { inner: ret })\\n }\\n}\\n\\n#[pymethods]\\nimpl HashTrieMapPy {\\n #[new]\\n #[pyo3(signature = (value=None, ** kwds))]\\n fn init(value: Option<HashTrieMapPy>, kwds: Option<&Bound<'_, PyDict>>) -> PyResult<Self> {\\n let mut map: HashTrieMapPy;\\n if let Some(value) = value {\\n map = value;\\n } else {\\n map = HashTrieMapPy {\\n inner: HashTrieMap::new_sync(),\\n };\\n }\\n if let Some(kwds) = kwds {\\n for (k, v) in kwds {\\n map.inner.insert_mut(Key::extract_bound(&k)?, v.into());\\n }\\n }\\n Ok(map)\\n }\\n\\n fn __contains__(&self, key: Key) -> bool {\\n self.inner.contains_key(&key)\\n }\\n\\n fn __iter__(slf: PyRef<'_, Self>) -> KeysIterator {\\n KeysIterator {\\n inner: slf.inner.clone(),\\n }\\n }\\n\\n fn __getitem__(&self, key: Key, py: Python) -> PyResult<PyObject> {\\n match self.inner.get(&key) {\\n Some(value) => Ok(value.clone_ref(py)),\\n None => Err(PyKeyError::new_err(key)),\\n }\\n }\\n\\n fn __len__(&self) -> usize {\\n self.inner.size()\\n }\\n\\n fn __repr__(&self, py: Python) -> String {\\n let contents = self.inner.into_iter().map(|(k, v)| {\\n format!(\\n \\\"{}: {}\\\",\\n k.inner\\n .call_method0(py, \\\"__repr__\\\")\\n .and_then(|r| r.extract(py))\\n .unwrap_or(\\\"<repr error>\\\".to_owned()),\\n v.call_method0(py, \\\"__repr__\\\")\\n .and_then(|r| r.extract(py))\\n .unwrap_or(\\\"<repr error>\\\".to_owned())\\n )\\n });\\n format!(\\n \\\"HashTrieMap({{{}}})\\\",\\n contents.collect::<Vec<_>>().join(\\\", \\\")\\n )\\n }\\n\\n fn __richcmp__<'py>(&self, other: &Self, op: CompareOp, py: Python<'py>) -> PyResult<PyObject> {\\n match op {\\n CompareOp::Eq => (self.inner.size() == other.inner.size()\\n && self\\n .inner\\n .iter()\\n .map(|(k1, v1)| (v1, other.inner.get(k1)))\\n .map(|(v1, v2)| v1.bind(py).eq(v2))\\n .all(|r| r.unwrap_or(false)))\\n .into_pyobject(py)\\n .map_err(Into::into)\\n .map(BoundObject::into_any)\\n .map(BoundObject::unbind),\\n CompareOp::Ne => (self.inner.size() != other.inner.size()\\n || self\\n .inner\\n .iter()\\n .map(|(k1, v1)| (v1, other.inner.get(k1)))\\n .map(|(v1, v2)| v1.bind(py).ne(v2))\\n .all(|r| r.unwrap_or(true)))\\n .into_pyobject(py)\\n .map_err(Into::into)\\n .map(BoundObject::into_any)\\n .map(BoundObject::unbind),\\n _ => Ok(py.NotImplemented()),\\n }\\n }\\n\\n fn __hash__(&self, py: Python) -> PyResult<isize> {\\n // modified from https://github.com/python/cpython/blob/d69529d31ccd1510843cfac1ab53bb8cb027541f/Objects/setobject.c#L715\\n\\n let mut hash_val = self\\n .inner\\n .iter()\\n .map(|(key, val)| {\\n let mut hasher = DefaultHasher::new();\\n let val_bound = val.bind(py);\\n\\n let key_hash = key.hash;\\n let val_hash = val_bound.hash().map_err(|_| {\\n PyTypeError::new_err(format!(\\n \\\"Unhashable type in HashTrieMap of key {}: {}\\\",\\n key.inner\\n .bind(py)\\n .repr()\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr> error\\\".to_string()),\\n val_bound\\n .repr()\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr> error\\\".to_string())\\n ))\\n })?;\\n\\n hasher.write_isize(key_hash);\\n hasher.write_isize(val_hash);\\n\\n Ok(hasher.finish() as usize)\\n })\\n .try_fold(0, |acc: usize, x: PyResult<usize>| {\\n PyResult::<usize>::Ok(acc ^ hash_shuffle_bits(x?))\\n })?;\\n\\n // factor in the number of entries in the collection\\n hash_val ^= self.inner.size().wrapping_add(1).wrapping_mul(1927868237);\\n\\n // dispense patterns in the hash value\\n hash_val ^= (hash_val >> 11) ^ (hash_val >> 25);\\n hash_val = hash_val.wrapping_mul(69069).wrapping_add(907133923);\\n\\n Ok(hash_val as isize)\\n }\\n\\n fn __reduce__(slf: PyRef<Self>) -> (Bound<'_, PyType>, (Vec<(Key, PyObject)>,)) {\\n (\\n HashTrieMapPy::type_object(slf.py()),\\n (slf.inner\\n .iter()\\n .map(|(k, v)| (k.clone_ref(slf.py()), v.clone_ref(slf.py())))\\n .collect(),),\\n )\\n }\\n\\n #[classmethod]\\n fn convert(\\n _cls: &Bound<'_, PyType>,\\n value: Bound<'_, PyAny>,\\n py: Python,\\n ) -> PyResult<PyObject> {\\n if value.is_instance_of::<HashTrieMapPy>() {\\n Ok(value.unbind())\\n } else {\\n HashTrieMapPy::extract_bound(&value)?\\n .into_pyobject(py)\\n .map(BoundObject::into_any)\\n .map(BoundObject::unbind)\\n }\\n }\\n\\n #[classmethod]\\n #[pyo3(signature = (keys, val=None))]\\n fn fromkeys(\\n _cls: &Bound<'_, PyType>,\\n keys: &Bound<'_, PyAny>,\\n val: Option<&Bound<'_, PyAny>>,\\n py: Python,\\n ) -> PyResult<HashTrieMapPy> {\\n let mut inner = HashTrieMap::new_sync();\\n let none = py.None().into_bound(py);\\n let value = val.unwrap_or(&none);\\n for each in keys.try_iter()? {\\n let key = Key::extract_bound(&each?)?;\\n inner.insert_mut(key, value.clone().unbind());\\n }\\n Ok(HashTrieMapPy { inner })\\n }\\n\\n #[pyo3(signature = (key, default=None))]\\n fn get(&self, key: Key, default: Option<PyObject>, py: Python) -> Option<PyObject> {\\n if let Some(value) = self.inner.get(&key) {\\n Some(value.clone_ref(py))\\n } else {\\n default\\n }\\n }\\n\\n fn keys(&self) -> KeysView {\\n KeysView {\\n inner: self.inner.clone(),\\n }\\n }\\n\\n fn values(&self) -> ValuesView {\\n ValuesView {\\n inner: self.inner.clone(),\\n }\\n }\\n\\n fn items(&self) -> ItemsView {\\n ItemsView {\\n inner: self.inner.clone(),\\n }\\n }\\n\\n fn discard(&self, key: Key) -> PyResult<HashTrieMapPy> {\\n match self.inner.contains_key(&key) {\\n true => Ok(HashTrieMapPy {\\n inner: self.inner.remove(&key),\\n }),\\n false => Ok(HashTrieMapPy {\\n inner: self.inner.clone(),\\n }),\\n }\\n }\\n\\n fn insert(&self, key: Key, value: Bound<'_, PyAny>) -> HashTrieMapPy {\\n HashTrieMapPy {\\n inner: self.inner.insert(key, value.unbind()),\\n }\\n }\\n\\n fn remove(&self, key: Key) -> PyResult<HashTrieMapPy> {\\n match self.inner.contains_key(&key) {\\n true => Ok(HashTrieMapPy {\\n inner: self.inner.remove(&key),\\n }),\\n false => Err(PyKeyError::new_err(key)),\\n }\\n }\\n\\n #[pyo3(signature = (*maps, **kwds))]\\n fn update(\\n &self,\\n maps: &Bound<'_, PyTuple>,\\n kwds: Option<&Bound<'_, PyDict>>,\\n ) -> PyResult<HashTrieMapPy> {\\n let mut inner = self.inner.clone();\\n for value in maps {\\n let map = HashTrieMapPy::extract_bound(&value)?;\\n for (k, v) in &map.inner {\\n inner.insert_mut(k.clone_ref(value.py()), v.clone_ref(value.py()));\\n }\\n }\\n if let Some(kwds) = kwds {\\n for (k, v) in kwds {\\n inner.insert_mut(Key::extract_bound(&k)?, v.extract()?);\\n }\\n }\\n Ok(HashTrieMapPy { inner })\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct KeysIterator {\\n inner: HashTrieMapSync<Key, PyObject>,\\n}\\n\\n#[pymethods]\\nimpl KeysIterator {\\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\\n slf\\n }\\n\\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<Key> {\\n let first = slf.inner.keys().next()?.clone_ref(slf.py());\\n slf.inner = slf.inner.remove(&first);\\n Some(first)\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct ValuesIterator {\\n inner: HashTrieMapSync<Key, PyObject>,\\n}\\n\\n#[pymethods]\\nimpl ValuesIterator {\\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\\n slf\\n }\\n\\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<PyObject> {\\n let kv = slf.inner.iter().next()?;\\n let value = kv.1.clone_ref(slf.py());\\n slf.inner = slf.inner.remove(kv.0);\\n Some(value)\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct ItemsIterator {\\n inner: HashTrieMapSync<Key, PyObject>,\\n}\\n\\n#[pymethods]\\nimpl ItemsIterator {\\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\\n slf\\n }\\n\\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<(Key, PyObject)> {\\n let kv = slf.inner.iter().next()?;\\n let key = kv.0.clone_ref(slf.py());\\n let value = kv.1.clone_ref(slf.py());\\n\\n slf.inner = slf.inner.remove(kv.0);\\n\\n Some((key, value))\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct KeysView {\\n inner: HashTrieMapSync<Key, PyObject>,\\n}\\n\\n#[pymethods]\\nimpl KeysView {\\n fn __contains__(&self, key: Key) -> bool {\\n self.inner.contains_key(&key)\\n }\\n\\n fn __eq__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? != slf.inner.size() {\\n return Ok(false);\\n }\\n for each in other.try_iter()? {\\n if !slf.inner.contains_key(&Key::extract_bound(&each?)?) {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __lt__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? <= slf.inner.size() {\\n return Ok(false);\\n }\\n\\n for each in slf.inner.keys() {\\n if !other.contains(each.inner.clone_ref(slf.py()))? {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __le__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? < slf.inner.size() {\\n return Ok(false);\\n }\\n\\n for each in slf.inner.keys() {\\n if !other.contains(each.inner.clone_ref(slf.py()))? {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __gt__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? >= slf.inner.size() {\\n return Ok(false);\\n }\\n for each in other.try_iter()? {\\n if !slf.inner.contains_key(&Key::extract_bound(&each?)?) {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __ge__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? > slf.inner.size() {\\n return Ok(false);\\n }\\n for each in other.try_iter()? {\\n if !slf.inner.contains_key(&Key::extract_bound(&each?)?) {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __iter__(slf: PyRef<'_, Self>) -> KeysIterator {\\n KeysIterator {\\n inner: slf.inner.clone(),\\n }\\n }\\n\\n fn __len__(slf: PyRef<'_, Self>) -> usize {\\n slf.inner.size()\\n }\\n\\n fn __and__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>) -> PyResult<HashTrieSetPy> {\\n KeysView::intersection(slf, other)\\n }\\n\\n fn __or__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<KeysView> {\\n KeysView::union(slf, other, py)\\n }\\n\\n fn __repr__(&self, py: Python) -> PyResult<String> {\\n let contents = self.inner.into_iter().map(|(k, _)| {\\n Ok(k.clone_ref(py)\\n .inner\\n .into_pyobject(py)?\\n .call_method0(\\\"__repr__\\\")\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr failed>\\\".to_owned()))\\n });\\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\\n Ok(format!(\\\"keys_view({{{}}})\\\", contents.join(\\\", \\\")))\\n }\\n\\n fn intersection(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>) -> PyResult<HashTrieSetPy> {\\n // TODO: iterate over the shorter one if it's got a length\\n let mut inner = HashTrieSet::new_sync();\\n for each in other.try_iter()? {\\n let key = Key::extract_bound(&each?)?;\\n if slf.inner.contains_key(&key) {\\n inner.insert_mut(key);\\n }\\n }\\n Ok(HashTrieSetPy { inner })\\n }\\n\\n fn union(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<KeysView> {\\n // There doesn't seem to be a low-effort way to get a HashTrieSet out of a map,\\n // so we just keep our map and add values we'll ignore.\\n let mut inner = slf.inner.clone();\\n for each in other.try_iter()? {\\n inner.insert_mut(Key::extract_bound(&each?)?, py.None());\\n }\\n Ok(KeysView { inner })\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct ValuesView {\\n inner: HashTrieMapSync<Key, PyObject>,\\n}\\n\\n#[pymethods]\\nimpl ValuesView {\\n fn __iter__(slf: PyRef<'_, Self>) -> ValuesIterator {\\n ValuesIterator {\\n inner: slf.inner.clone(),\\n }\\n }\\n\\n fn __len__(slf: PyRef<'_, Self>) -> usize {\\n slf.inner.size()\\n }\\n\\n fn __repr__(&self, py: Python) -> PyResult<String> {\\n let contents = self.inner.into_iter().map(|(_, v)| {\\n Ok(v.into_pyobject(py)?\\n .call_method0(\\\"__repr__\\\")\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr failed>\\\".to_owned()))\\n });\\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\\n Ok(format!(\\\"values_view([{}])\\\", contents.join(\\\", \\\")))\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct ItemsView {\\n inner: HashTrieMapSync<Key, PyObject>,\\n}\\n\\n#[derive(FromPyObject)]\\nstruct ItemViewQuery(Key, PyObject);\\n\\n#[pymethods]\\nimpl ItemsView {\\n fn __contains__(slf: PyRef<'_, Self>, item: ItemViewQuery) -> PyResult<bool> {\\n if let Some(value) = slf.inner.get(&item.0) {\\n return item.1.bind(slf.py()).eq(value);\\n }\\n\\n Ok(false)\\n }\\n\\n fn __iter__(slf: PyRef<'_, Self>) -> ItemsIterator {\\n ItemsIterator {\\n inner: slf.inner.clone(),\\n }\\n }\\n\\n fn __len__(slf: PyRef<'_, Self>) -> usize {\\n slf.inner.size()\\n }\\n\\n fn __eq__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? != slf.inner.size() {\\n return Ok(false);\\n }\\n for (k, v) in slf.inner.iter() {\\n if !other.contains((k.inner.clone_ref(slf.py()), v))? {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __repr__(&self, py: Python) -> PyResult<String> {\\n let contents = self.inner.into_iter().map(|(k, v)| {\\n let tuple = PyTuple::new(py, [k.inner.clone_ref(py), v.clone_ref(py)])?;\\n Ok(format!(\\\"{:?}\\\", tuple))\\n });\\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\\n Ok(format!(\\\"items_view([{}])\\\", contents.join(\\\", \\\")))\\n }\\n\\n fn __lt__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? <= slf.inner.size() {\\n return Ok(false);\\n }\\n for (k, v) in slf.inner.iter() {\\n let pair = PyTuple::new(py, [k.inner.clone_ref(py), v.clone_ref(py)])?;\\n // FIXME: needs to compare\\n if !other.contains(pair)? {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __le__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? < slf.inner.size() {\\n return Ok(false);\\n }\\n for (k, v) in slf.inner.iter() {\\n let pair = PyTuple::new(py, [k.inner.clone_ref(py), v.clone_ref(py)])?;\\n // FIXME: needs to compare\\n if !other.contains(pair)? {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __gt__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? >= slf.inner.size() {\\n return Ok(false);\\n }\\n for each in other.try_iter()? {\\n let kv = each?;\\n let k = kv.get_item(0)?;\\n match slf.inner.get(&Key::extract_bound(&k)?) {\\n Some(value) => {\\n let pair = PyTuple::new(py, [k, value.bind(py).clone()])?;\\n if !pair.eq(kv)? {\\n return Ok(false);\\n }\\n }\\n None => return Ok(false),\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __ge__(slf: PyRef<'_, Self>, other: &Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? > slf.inner.size() {\\n return Ok(false);\\n }\\n for each in other.try_iter()? {\\n let kv = each?;\\n let k = kv.get_item(0)?;\\n match slf.inner.get(&Key::extract_bound(&k)?) {\\n Some(value) => {\\n let pair = PyTuple::new(py, [k, value.bind(py).clone()])?;\\n if !pair.eq(kv)? {\\n return Ok(false);\\n }\\n }\\n None => return Ok(false),\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __and__(\\n slf: PyRef<'_, Self>,\\n other: &Bound<'_, PyAny>,\\n py: Python,\\n ) -> PyResult<HashTrieSetPy> {\\n ItemsView::intersection(slf, other, py)\\n }\\n\\n fn __or__(\\n slf: PyRef<'_, Self>,\\n other: &Bound<'_, PyAny>,\\n py: Python,\\n ) -> PyResult<HashTrieSetPy> {\\n ItemsView::union(slf, other, py)\\n }\\n\\n fn intersection(\\n slf: PyRef<'_, Self>,\\n other: &Bound<'_, PyAny>,\\n py: Python,\\n ) -> PyResult<HashTrieSetPy> {\\n // TODO: iterate over the shorter one if it's got a length\\n let mut inner = HashTrieSet::new_sync();\\n for each in other.try_iter()? {\\n let kv = each?;\\n let k = kv.get_item(0)?;\\n if let Some(value) = slf.inner.get(&Key::extract_bound(&k)?) {\\n let pair = PyTuple::new(py, [k, value.bind(py).clone()])?;\\n if pair.eq(kv)? {\\n inner.insert_mut(Key::extract_bound(&pair)?);\\n }\\n }\\n }\\n Ok(HashTrieSetPy { inner })\\n }\\n\\n fn union(\\n slf: PyRef<'_, Self>,\\n other: &Bound<'_, PyAny>,\\n py: Python,\\n ) -> PyResult<HashTrieSetPy> {\\n // TODO: this is very inefficient, but again can't seem to get a HashTrieSet out of ourself\\n let mut inner = HashTrieSet::new_sync();\\n for (k, v) in slf.inner.iter() {\\n let pair = PyTuple::new(py, [k.inner.clone_ref(py), v.clone_ref(py)])?;\\n inner.insert_mut(Key::extract_bound(&pair)?);\\n }\\n for each in other.try_iter()? {\\n inner.insert_mut(Key::extract_bound(&each?)?);\\n }\\n Ok(HashTrieSetPy { inner })\\n }\\n}\\n\\n#[repr(transparent)]\\n#[pyclass(name = \\\"HashTrieSet\\\", module = \\\"rpds\\\", frozen)]\\nstruct HashTrieSetPy {\\n inner: HashTrieSetSync<Key>,\\n}\\n\\nimpl<'source> FromPyObject<'source> for HashTrieSetPy {\\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\\n let mut ret = HashTrieSet::new_sync();\\n for each in ob.try_iter()? {\\n let k: Key = each?.extract()?;\\n ret.insert_mut(k);\\n }\\n Ok(HashTrieSetPy { inner: ret })\\n }\\n}\\n\\n#[pymethods]\\nimpl HashTrieSetPy {\\n #[new]\\n #[pyo3(signature = (value=None))]\\n fn init(value: Option<HashTrieSetPy>) -> Self {\\n if let Some(value) = value {\\n value\\n } else {\\n HashTrieSetPy {\\n inner: HashTrieSet::new_sync(),\\n }\\n }\\n }\\n\\n fn __contains__(&self, key: Key) -> bool {\\n self.inner.contains(&key)\\n }\\n\\n fn __and__(&self, other: &Self, py: Python) -> Self {\\n self.intersection(other, py)\\n }\\n\\n fn __or__(&self, other: &Self, py: Python) -> Self {\\n self.union(other, py)\\n }\\n\\n fn __sub__(&self, other: &Self) -> Self {\\n self.difference(other)\\n }\\n\\n fn __xor__(&self, other: &Self, py: Python) -> Self {\\n self.symmetric_difference(other, py)\\n }\\n\\n fn __iter__(slf: PyRef<'_, Self>) -> SetIterator {\\n SetIterator {\\n inner: slf.inner.clone(),\\n }\\n }\\n\\n fn __len__(&self) -> usize {\\n self.inner.size()\\n }\\n\\n fn __repr__(&self, py: Python) -> PyResult<String> {\\n let contents = self.inner.into_iter().map(|k| {\\n Ok(k.clone_ref(py)\\n .into_pyobject(py)?\\n .call_method0(\\\"__repr__\\\")\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr failed>\\\".to_owned()))\\n });\\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\\n Ok(format!(\\\"HashTrieSet({{{}}})\\\", contents.join(\\\", \\\")))\\n }\\n\\n fn __eq__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? != slf.inner.size() {\\n return Ok(false);\\n }\\n for each in other.try_iter()? {\\n if !slf.inner.contains(&Key::extract_bound(&each?)?) {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __hash__(&self) -> PyResult<isize> {\\n // modified from https://github.com/python/cpython/blob/d69529d31ccd1510843cfac1ab53bb8cb027541f/Objects/setobject.c#L715\\n\\n let mut hash_val = self\\n .inner\\n .iter()\\n .map(|k| k.hash as usize)\\n .fold(0, |acc: usize, x: usize| acc ^ hash_shuffle_bits(x));\\n\\n // factor in the number of entries in the collection\\n hash_val ^= self.inner.size().wrapping_add(1).wrapping_mul(1927868237);\\n\\n // dispense patterns in the hash value\\n hash_val ^= (hash_val >> 11) ^ (hash_val >> 25);\\n hash_val = hash_val.wrapping_mul(69069).wrapping_add(907133923);\\n\\n Ok(hash_val as isize)\\n }\\n\\n fn __lt__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? <= slf.inner.size() {\\n return Ok(false);\\n }\\n for each in slf.inner.iter() {\\n if !other.contains(each.inner.clone_ref(py))? {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __le__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? < slf.inner.size() {\\n return Ok(false);\\n }\\n for each in slf.inner.iter() {\\n if !other.contains(each.inner.clone_ref(slf.py()))? {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __gt__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? >= slf.inner.size() {\\n return Ok(false);\\n }\\n for each in other.try_iter()? {\\n if !slf.inner.contains(&Key::extract_bound(&each?)?) {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __ge__(slf: PyRef<'_, Self>, other: Bound<'_, PyAny>, py: Python) -> PyResult<bool> {\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n if !other.is_instance(&abc.getattr(\\\"Set\\\")?)? || other.len()? > slf.inner.size() {\\n return Ok(false);\\n }\\n for each in other.try_iter()? {\\n if !slf.inner.contains(&Key::extract_bound(&each?)?) {\\n return Ok(false);\\n }\\n }\\n Ok(true)\\n }\\n\\n fn __reduce__(slf: PyRef<Self>) -> (Bound<'_, PyType>, (Vec<Key>,)) {\\n (\\n HashTrieSetPy::type_object(slf.py()),\\n (slf.inner.iter().map(|e| e.clone_ref(slf.py())).collect(),),\\n )\\n }\\n\\n fn insert(&self, value: Key) -> HashTrieSetPy {\\n HashTrieSetPy {\\n inner: self.inner.insert(value),\\n }\\n }\\n\\n fn discard(&self, value: Key) -> PyResult<HashTrieSetPy> {\\n match self.inner.contains(&value) {\\n true => Ok(HashTrieSetPy {\\n inner: self.inner.remove(&value),\\n }),\\n false => Ok(HashTrieSetPy {\\n inner: self.inner.clone(),\\n }),\\n }\\n }\\n\\n fn remove(&self, value: Key) -> PyResult<HashTrieSetPy> {\\n match self.inner.contains(&value) {\\n true => Ok(HashTrieSetPy {\\n inner: self.inner.remove(&value),\\n }),\\n false => Err(PyKeyError::new_err(value)),\\n }\\n }\\n\\n fn difference(&self, other: &Self) -> HashTrieSetPy {\\n let mut inner = self.inner.clone();\\n for value in other.inner.iter() {\\n inner.remove_mut(value);\\n }\\n HashTrieSetPy { inner }\\n }\\n\\n fn intersection(&self, other: &Self, py: Python) -> HashTrieSetPy {\\n let mut inner: HashTrieSetSync<Key> = HashTrieSet::new_sync();\\n let larger: &HashTrieSetSync<Key>;\\n let iter;\\n if self.inner.size() > other.inner.size() {\\n larger = &self.inner;\\n iter = other.inner.iter();\\n } else {\\n larger = &other.inner;\\n iter = self.inner.iter();\\n }\\n for value in iter {\\n if larger.contains(value) {\\n inner.insert_mut(value.clone_ref(py));\\n }\\n }\\n HashTrieSetPy { inner }\\n }\\n\\n fn symmetric_difference(&self, other: &Self, py: Python) -> HashTrieSetPy {\\n let mut inner: HashTrieSetSync<Key>;\\n let iter;\\n if self.inner.size() > other.inner.size() {\\n inner = self.inner.clone();\\n iter = other.inner.iter();\\n } else {\\n inner = other.inner.clone();\\n iter = self.inner.iter();\\n }\\n for value in iter {\\n if inner.contains(value) {\\n inner.remove_mut(value);\\n } else {\\n inner.insert_mut(value.clone_ref(py));\\n }\\n }\\n HashTrieSetPy { inner }\\n }\\n\\n fn union(&self, other: &Self, py: Python) -> HashTrieSetPy {\\n let mut inner: HashTrieSetSync<Key>;\\n let iter;\\n if self.inner.size() > other.inner.size() {\\n inner = self.inner.clone();\\n iter = other.inner.iter();\\n } else {\\n inner = other.inner.clone();\\n iter = self.inner.iter();\\n }\\n for value in iter {\\n inner.insert_mut(value.clone_ref(py));\\n }\\n HashTrieSetPy { inner }\\n }\\n\\n #[pyo3(signature = (*iterables))]\\n fn update(&self, iterables: Bound<'_, PyTuple>) -> PyResult<HashTrieSetPy> {\\n let mut inner = self.inner.clone();\\n for each in iterables {\\n let iter = each.try_iter()?;\\n for value in iter {\\n inner.insert_mut(Key::extract_bound(&value?)?);\\n }\\n }\\n Ok(HashTrieSetPy { inner })\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct SetIterator {\\n inner: HashTrieSetSync<Key>,\\n}\\n\\n#[pymethods]\\nimpl SetIterator {\\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\\n slf\\n }\\n\\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<Key> {\\n let first = slf.inner.iter().next()?.clone_ref(slf.py());\\n slf.inner = slf.inner.remove(&first);\\n Some(first)\\n }\\n}\\n\\n#[repr(transparent)]\\n#[pyclass(name = \\\"List\\\", module = \\\"rpds\\\", frozen, sequence)]\\nstruct ListPy {\\n inner: ListSync<PyObject>,\\n}\\n\\nimpl From<ListSync<PyObject>> for ListPy {\\n fn from(elements: ListSync<PyObject>) -> Self {\\n ListPy { inner: elements }\\n }\\n}\\n\\nimpl<'source> FromPyObject<'source> for ListPy {\\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\\n let mut ret = List::new_sync();\\n let reversed = PyModule::import(ob.py(), \\\"builtins\\\")?.getattr(\\\"reversed\\\")?;\\n let rob: Bound<'_, PyIterator> = reversed.call1((ob,))?.try_iter()?;\\n for each in rob {\\n ret.push_front_mut(each?.extract()?);\\n }\\n Ok(ListPy { inner: ret })\\n }\\n}\\n\\n#[pymethods]\\nimpl ListPy {\\n #[new]\\n #[pyo3(signature = (*elements))]\\n fn init(elements: &Bound<'_, PyTuple>) -> PyResult<Self> {\\n let mut ret: ListPy;\\n if elements.len() == 1 {\\n ret = elements.get_item(0)?.extract()?;\\n } else {\\n ret = ListPy {\\n inner: List::new_sync(),\\n };\\n if elements.len() > 1 {\\n for each in (0..elements.len()).rev() {\\n ret.inner\\n .push_front_mut(elements.get_item(each)?.extract()?);\\n }\\n }\\n }\\n Ok(ret)\\n }\\n\\n fn __len__(&self) -> usize {\\n self.inner.len()\\n }\\n\\n fn __repr__(&self, py: Python) -> PyResult<String> {\\n let contents = self.inner.into_iter().map(|k| {\\n Ok(k.into_pyobject(py)?\\n .call_method0(\\\"__repr__\\\")\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr failed>\\\".to_owned()))\\n });\\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\\n Ok(format!(\\\"List([{}])\\\", contents.join(\\\", \\\")))\\n }\\n\\n fn __richcmp__(&self, other: &Self, op: CompareOp, py: Python<'_>) -> PyResult<PyObject> {\\n match op {\\n CompareOp::Eq => (self.inner.len() == other.inner.len()\\n && self\\n .inner\\n .iter()\\n .zip(other.inner.iter())\\n .map(|(e1, e2)| e1.bind(py).eq(e2))\\n .all(|r| r.unwrap_or(false)))\\n .into_pyobject(py)\\n .map_err(Into::into)\\n .map(BoundObject::into_any)\\n .map(BoundObject::unbind),\\n CompareOp::Ne => (self.inner.len() != other.inner.len()\\n || self\\n .inner\\n .iter()\\n .zip(other.inner.iter())\\n .map(|(e1, e2)| e1.bind(py).ne(e2))\\n .any(|r| r.unwrap_or(true)))\\n .into_pyobject(py)\\n .map_err(Into::into)\\n .map(BoundObject::into_any)\\n .map(BoundObject::unbind),\\n _ => Ok(py.NotImplemented()),\\n }\\n }\\n\\n fn __hash__(&self, py: Python) -> PyResult<u64> {\\n let mut hasher = DefaultHasher::new();\\n\\n self.inner\\n .iter()\\n .enumerate()\\n .try_for_each(|(index, each)| {\\n each.bind(py)\\n .hash()\\n .map_err(|_| {\\n PyTypeError::new_err(format!(\\n \\\"Unhashable type at {} element in List: {}\\\",\\n index,\\n each.bind(py)\\n .repr()\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr> error\\\".to_string())\\n ))\\n })\\n .map(|x| hasher.write_isize(x))\\n })?;\\n\\n Ok(hasher.finish())\\n }\\n\\n fn __iter__(slf: PyRef<'_, Self>) -> ListIterator {\\n ListIterator {\\n inner: slf.inner.clone(),\\n }\\n }\\n\\n fn __reversed__(&self) -> ListPy {\\n ListPy {\\n inner: self.inner.reverse(),\\n }\\n }\\n\\n fn __reduce__(slf: PyRef<Self>) -> (Bound<'_, PyType>, (Vec<PyObject>,)) {\\n (\\n ListPy::type_object(slf.py()),\\n (slf.inner.iter().map(|e| e.clone_ref(slf.py())).collect(),),\\n )\\n }\\n\\n #[getter]\\n fn first(&self) -> PyResult<&PyObject> {\\n self.inner\\n .first()\\n .ok_or_else(|| PyIndexError::new_err(\\\"empty list has no first element\\\"))\\n }\\n\\n #[getter]\\n fn rest(&self) -> ListPy {\\n let mut inner = self.inner.clone();\\n inner.drop_first_mut();\\n ListPy { inner }\\n }\\n\\n fn push_front(&self, other: PyObject) -> ListPy {\\n ListPy {\\n inner: self.inner.push_front(other),\\n }\\n }\\n\\n fn drop_first(&self) -> PyResult<ListPy> {\\n if let Some(inner) = self.inner.drop_first() {\\n Ok(ListPy { inner })\\n } else {\\n Err(PyIndexError::new_err(\\\"empty list has no first element\\\"))\\n }\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct ListIterator {\\n inner: ListSync<PyObject>,\\n}\\n\\n#[pymethods]\\nimpl ListIterator {\\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\\n slf\\n }\\n\\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<PyObject> {\\n let first_op = slf.inner.first()?;\\n let first = first_op.clone_ref(slf.py());\\n\\n slf.inner = slf.inner.drop_first()?;\\n\\n Some(first)\\n }\\n}\\n\\n#[pyclass(module = \\\"rpds\\\")]\\nstruct QueueIterator {\\n inner: QueueSync<PyObject>,\\n}\\n\\n#[pymethods]\\nimpl QueueIterator {\\n fn __iter__(slf: PyRef<'_, Self>) -> PyRef<'_, Self> {\\n slf\\n }\\n\\n fn __next__(mut slf: PyRefMut<'_, Self>) -> Option<PyObject> {\\n let first_op = slf.inner.peek()?;\\n let first = first_op.clone_ref(slf.py());\\n slf.inner = slf.inner.dequeue()?;\\n Some(first)\\n }\\n}\\n\\n#[repr(transparent)]\\n#[pyclass(name = \\\"Queue\\\", module = \\\"rpds\\\", frozen, sequence)]\\nstruct QueuePy {\\n inner: QueueSync<PyObject>,\\n}\\n\\nimpl From<QueueSync<PyObject>> for QueuePy {\\n fn from(elements: QueueSync<PyObject>) -> Self {\\n QueuePy { inner: elements }\\n }\\n}\\n\\nimpl<'source> FromPyObject<'source> for QueuePy {\\n fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {\\n let mut ret = Queue::new_sync();\\n for each in ob.try_iter()? {\\n ret.enqueue_mut(each?.extract()?);\\n }\\n Ok(QueuePy { inner: ret })\\n }\\n}\\n\\n#[pymethods]\\nimpl QueuePy {\\n #[new]\\n #[pyo3(signature = (*elements))]\\n fn init(elements: &Bound<'_, PyTuple>, py: Python<'_>) -> PyResult<Self> {\\n let mut ret: QueuePy;\\n if elements.len() == 1 {\\n ret = elements.get_item(0)?.extract()?;\\n } else {\\n ret = QueuePy {\\n inner: Queue::new_sync(),\\n };\\n if elements.len() > 1 {\\n for each in elements {\\n ret.inner.enqueue_mut(each.into_pyobject(py)?.unbind());\\n }\\n }\\n }\\n Ok(ret)\\n }\\n\\n fn __eq__(&self, other: &Self, py: Python<'_>) -> bool {\\n (self.inner.len() == other.inner.len())\\n && self\\n .inner\\n .iter()\\n .zip(other.inner.iter())\\n .map(|(e1, e2)| e1.bind(py).eq(e2))\\n .all(|r| r.unwrap_or(false))\\n }\\n\\n fn __hash__(&self, py: Python<'_>) -> PyResult<u64> {\\n let mut hasher = DefaultHasher::new();\\n\\n self.inner\\n .iter()\\n .enumerate()\\n .try_for_each(|(index, each)| {\\n each.bind(py)\\n .hash()\\n .map_err(|_| {\\n PyTypeError::new_err(format!(\\n \\\"Unhashable type at {} element in Queue: {}\\\",\\n index,\\n each.bind(py)\\n .repr()\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr> error\\\".to_string())\\n ))\\n })\\n .map(|x| hasher.write_isize(x))\\n })?;\\n\\n Ok(hasher.finish())\\n }\\n\\n fn __ne__(&self, other: &Self, py: Python<'_>) -> bool {\\n (self.inner.len() != other.inner.len())\\n || self\\n .inner\\n .iter()\\n .zip(other.inner.iter())\\n .map(|(e1, e2)| e1.bind(py).ne(e2))\\n .any(|r| r.unwrap_or(true))\\n }\\n\\n fn __iter__(slf: PyRef<'_, Self>) -> QueueIterator {\\n QueueIterator {\\n inner: slf.inner.clone(),\\n }\\n }\\n\\n fn __len__(&self) -> usize {\\n self.inner.len()\\n }\\n\\n fn __repr__(&self, py: Python) -> PyResult<String> {\\n let contents = self.inner.into_iter().map(|k| {\\n Ok(k.into_pyobject(py)?\\n .call_method0(\\\"__repr__\\\")\\n .and_then(|r| r.extract())\\n .unwrap_or(\\\"<repr failed>\\\".to_owned()))\\n });\\n let contents = contents.collect::<Result<Vec<_>, PyErr>>()?;\\n Ok(format!(\\\"Queue([{}])\\\", contents.join(\\\", \\\")))\\n }\\n\\n #[getter]\\n fn peek(&self, py: Python) -> PyResult<PyObject> {\\n if let Some(peeked) = self.inner.peek() {\\n Ok(peeked.clone_ref(py))\\n } else {\\n Err(PyIndexError::new_err(\\\"peeked an empty queue\\\"))\\n }\\n }\\n\\n #[getter]\\n fn is_empty(&self) -> bool {\\n self.inner.is_empty()\\n }\\n\\n fn enqueue(&self, value: Bound<'_, PyAny>) -> Self {\\n QueuePy {\\n inner: self.inner.enqueue(value.into()),\\n }\\n }\\n\\n fn dequeue(&self) -> PyResult<QueuePy> {\\n if let Some(inner) = self.inner.dequeue() {\\n Ok(QueuePy { inner })\\n } else {\\n Err(PyIndexError::new_err(\\\"dequeued an empty queue\\\"))\\n }\\n }\\n}\\n\\n#[pymodule(gil_used = false)]\\n#[pyo3(name = \\\"rpds\\\")]\\nfn rpds_py(py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {\\n m.add_class::<HashTrieMapPy>()?;\\n m.add_class::<HashTrieSetPy>()?;\\n m.add_class::<ListPy>()?;\\n m.add_class::<QueuePy>()?;\\n\\n PyMapping::register::<HashTrieMapPy>(py)?;\\n\\n let abc = PyModule::import(py, \\\"collections.abc\\\")?;\\n\\n abc.getattr(\\\"Set\\\")?\\n .call_method1(\\\"register\\\", (HashTrieSetPy::type_object(py),))?;\\n\\n abc.getattr(\\\"MappingView\\\")?\\n .call_method1(\\\"register\\\", (KeysView::type_object(py),))?;\\n abc.getattr(\\\"MappingView\\\")?\\n .call_method1(\\\"register\\\", (ValuesView::type_object(py),))?;\\n abc.getattr(\\\"MappingView\\\")?\\n .call_method1(\\\"register\\\", (ItemsView::type_object(py),))?;\\n\\n abc.getattr(\\\"KeysView\\\")?\\n .call_method1(\\\"register\\\", (KeysView::type_object(py),))?;\\n abc.getattr(\\\"ValuesView\\\")?\\n .call_method1(\\\"register\\\", (ValuesView::type_object(py),))?;\\n abc.getattr(\\\"ItemsView\\\")?\\n .call_method1(\\\"register\\\", (ItemsView::type_object(py),))?;\\n\\n Ok(())\\n}\\n\\n[end of src/lib.rs]\",\n \"filename\": \"src/lib.rs\",\n \"id\": \"15\"\n }\n]","isConversational":false}}},{"rowIdx":59,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 59,\n \"num_files\": 12,\n \"repo_id\": \"repo_0059\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\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[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"BINDIR = $(PWD)/.state/env/bin\n\n.state/env/pyvenv.cfg: requirements/dev.txt\n\trm -rf .state/env\n\tpython -m venv .state/env\n\n\t# install/upgrade general requirements\n\t$(BINDIR)/python -m pip install --upgrade pip setuptools wheel\n\n\t# install various types of requirements\n\t$(BINDIR)/python -m pip install -r requirements/dev.txt\n\ntest: .state/env/pyvenv.cfg\n\t$(BINDIR)/python -m pip install .\n\t$(BINDIR)/pytest\n\t$(BINDIR)/python -m tests.lib\n\nlint: .state/env/pyvenv.cfg\n\t$(BINDIR)/black --check bin setup.py src tests\n\t$(BINDIR)/python bin/sort.py src/trove_classifiers/__init__.py\n\t$(BINDIR)/mypy src\n\nreformat: .state/env/pyvenv.cfg\n\t$(BINDIR)/black tests src\n\n.PHONY: build test lint reformat\n\n[end of Makefile]","filename":"Makefile","id":"1"},{"content":"[build-system]\nrequires = [\"setuptools\", \"calver\"]\nbuild-backend = \"setuptools.build_meta\"\n\n[tool.mypy]\nstrict = true\nwarn_unreachable = true\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"include CONTRIBUTING.md\ninclude Makefile\nrecursive-include bin *.py\nrecursive-include tests *.py\nrecursive-include requirements *\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"3"},{"content":"Canonical source for [classifiers][1] on [PyPI][2].\n\nClassifiers [categorize projects][3] per [PEP 301][4]. Use this package to\nvalidate classifiers in packages for PyPI upload or download.\n\n## Usage\n\nTo install [from PyPI][5]:\n\n```\n$ pip install trove-classifiers\n```\n\nThis package can be invoked as a module to print a list of classifiers:\n\n```\n$ python -m trove_classifiers | grep -Ei pyramid\nFramework :: Pyramid\n```\n\nIn addition, this package's API is two importable objects:\n\n### Classifiers (`trove_classifiers.classifiers`)\nA `set` containing classifiers (as strings). Useful for determining membership.\n\nExample - determine if a classifier is valid:\n\n```python\n>>> from trove_classifiers import classifiers\n>>> 'License :: OSI Approved' in classifiers\nTrue\n>>> 'Fuzzy :: Wuzzy :: Was :: A :: Bear' in classifiers\nFalse\n>>>\n```\n\n### Deprecated classifiers (`trove_classifiers.deprecated_classifiers`)\nA `dict`, mapping a deprecated classifier (string) to a list of classifiers\nwhich replaces it (strings).\n\nExample - determine if a classifier is deprecated:\n\n```python\n>>> from trove_classifiers import deprecated_classifiers\n>>> 'License :: OSI Approved' in deprecated_classifiers\nFalse\n>>> 'Natural Language :: Ukranian' in deprecated_classifiers\nTrue\n>>> deprecated_classifiers[\"Natural Language :: Ukranian\"]\n['Natural Language :: Ukrainian']\n```\n\n[1]: https://pypi.org/classifiers/\n[2]: https://pypi.org\n[3]: https://packaging.python.org/specifications/core-metadata/#classifier-multiple-use\n[4]: https://www.python.org/dev/peps/pep-0301/\n[5]: https://pypi.org/project/trove-classifiers/\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"from io import open\nfrom os import path\n\nfrom setuptools import setup, find_packages\n\nhere = path.abspath(path.dirname(__file__))\n\n# Get the long description from the README file\nwith open(path.join(here, \"README.md\"), encoding=\"utf-8\") as f:\n long_description = f.read()\n\nsetup(\n name=\"trove-classifiers\",\n description=\"Canonical source for classifiers on PyPI (pypi.org).\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n url=\"https://github.com/pypa/trove-classifiers\",\n author=\"The PyPI Admins\",\n author_email=\"admin@pypi.org\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: Apache Software License\",\n \"Programming Language :: Python :: 3\",\n \"Typing :: Typed\",\n ],\n keywords=\"classifiers\",\n package_dir={\"\": \"src\"},\n packages=find_packages(where=\"src\"),\n package_data={\"\": [\"py.typed\"]},\n use_calver=\"%Y.%m.%d.%H\",\n setup_requires=[\"calver\"],\n)\n\n[end of setup.py]","filename":"setup.py","id":"5"},{"content":"# Contributing\nHow to contributing to this package.\n\n## Running tests\nRun `make test`. This checks whether the auto-generated list of classifiers\nmatches the input source.\n\n## Running linting\nRun `make lint`.\n\n## Adding a new classifier\nTo add a new classifier, add to the `classifiers` set in\n`trove_classifiers/__init__.py`.\n\n## Deprecating a classifier\nTo deprecate a classifier, move it from `classifiers` to\n`deprecated_classifiers` in `trove_classifiers/__init__.py`, and list any new\nclassifiers that may replace it.\n\n[end of CONTRIBUTING.md]","filename":"CONTRIBUTING.md","id":"6"},{"content":"import ast\nimport sys\n\nfrom natsort import natsorted\n\n\ndef _test_sort(elements, _type):\n values = [e.value for e in elements]\n for wrong, right in zip(values, natsorted(values)):\n if wrong != right:\n print(f\"{_type} is not sorted, {right!r} should come before {wrong!r}\")\n return True\n return False\n\n\nif len(sys.argv) == 1:\n print(\"Usage: sort.py [filename]\")\n sys.exit(1)\n\n\nwith open(sys.argv[1]) as f:\n contents = f.read()\n\nfail = False\n\nfor node in ast.walk(ast.parse(contents)):\n if type(node) == ast.List:\n fail = _test_sort(node.elts, \"List\") or fail\n if type(node) == ast.Set:\n fail = _test_sort(node.elts, \"Set\") or fail\n if type(node) == ast.Dict:\n fail = _test_sort(node.keys, \"Dict\") or fail\n\nsys.exit(fail)\n\n[end of bin/sort.py]","filename":"bin/sort.py","id":"7"},{"content":"black\njinja2\nnatsort\npytest\nmypy\n\n[end of requirements/dev.txt]","filename":"requirements/dev.txt","id":"8"},{"content":"from typing import Dict, List, Set\n\n# A set of classifier names\nsorted_classifiers: List[str] = [\n \"Development Status :: 1 - Planning\",\n \"Development Status :: 2 - Pre-Alpha\",\n \"Development Status :: 3 - Alpha\",\n \"Development Status :: 4 - Beta\",\n \"Development Status :: 5 - Production/Stable\",\n \"Development Status :: 6 - Mature\",\n \"Development Status :: 7 - Inactive\",\n \"Environment :: Console\",\n \"Environment :: Console :: Curses\",\n \"Environment :: Console :: Framebuffer\",\n \"Environment :: Console :: Newt\",\n \"Environment :: Console :: svgalib\",\n \"Environment :: GPU\",\n \"Environment :: GPU :: NVIDIA CUDA\",\n \"Environment :: GPU :: NVIDIA CUDA :: 1.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 1.1\",\n \"Environment :: GPU :: NVIDIA CUDA :: 2.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 2.1\",\n \"Environment :: GPU :: NVIDIA CUDA :: 2.2\",\n \"Environment :: GPU :: NVIDIA CUDA :: 2.3\",\n \"Environment :: GPU :: NVIDIA CUDA :: 3.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 3.1\",\n \"Environment :: GPU :: NVIDIA CUDA :: 3.2\",\n \"Environment :: GPU :: NVIDIA CUDA :: 4.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 4.1\",\n \"Environment :: GPU :: NVIDIA CUDA :: 4.2\",\n \"Environment :: GPU :: NVIDIA CUDA :: 5.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 5.5\",\n \"Environment :: GPU :: NVIDIA CUDA :: 6.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 6.5\",\n \"Environment :: GPU :: NVIDIA CUDA :: 7.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 7.5\",\n \"Environment :: GPU :: NVIDIA CUDA :: 8.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 9.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 9.1\",\n \"Environment :: GPU :: NVIDIA CUDA :: 9.2\",\n \"Environment :: GPU :: NVIDIA CUDA :: 10.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 10.1\",\n \"Environment :: GPU :: NVIDIA CUDA :: 10.2\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.1\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.2\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.3\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.4\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.5\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.6\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.7\",\n \"Environment :: GPU :: NVIDIA CUDA :: 11.8\",\n \"Environment :: GPU :: NVIDIA CUDA :: 12\",\n \"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.0\",\n \"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.1\",\n \"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.2\",\n \"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.3\",\n \"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.4\",\n \"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.5\",\n \"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.6\",\n \"Environment :: Handhelds/PDA's\",\n \"Environment :: MacOS X\",\n \"Environment :: MacOS X :: Aqua\",\n \"Environment :: MacOS X :: Carbon\",\n \"Environment :: MacOS X :: Cocoa\",\n \"Environment :: No Input/Output (Daemon)\",\n \"Environment :: OpenStack\",\n \"Environment :: Other Environment\",\n \"Environment :: Plugins\",\n \"Environment :: Web Environment\",\n \"Environment :: Web Environment :: Buffet\",\n \"Environment :: Web Environment :: Mozilla\",\n \"Environment :: Web Environment :: ToscaWidgets\",\n \"Environment :: WebAssembly\",\n \"Environment :: WebAssembly :: Emscripten\",\n \"Environment :: WebAssembly :: WASI\",\n \"Environment :: Win32 (MS Windows)\",\n \"Environment :: X11 Applications\",\n \"Environment :: X11 Applications :: GTK\",\n \"Environment :: X11 Applications :: Gnome\",\n \"Environment :: X11 Applications :: KDE\",\n \"Environment :: X11 Applications :: Qt\",\n \"Framework :: AWS CDK\",\n \"Framework :: AWS CDK :: 1\",\n \"Framework :: AWS CDK :: 2\",\n \"Framework :: AiiDA\",\n \"Framework :: Ansible\",\n \"Framework :: AnyIO\",\n \"Framework :: Apache Airflow\",\n \"Framework :: Apache Airflow :: Provider\",\n \"Framework :: AsyncIO\",\n \"Framework :: BEAT\",\n \"Framework :: BFG\",\n \"Framework :: Bob\",\n \"Framework :: Bottle\",\n \"Framework :: Buildout\",\n \"Framework :: Buildout :: Extension\",\n \"Framework :: Buildout :: Recipe\",\n \"Framework :: CastleCMS\",\n \"Framework :: CastleCMS :: Theme\",\n \"Framework :: Celery\",\n \"Framework :: Chandler\",\n \"Framework :: CherryPy\",\n \"Framework :: CubicWeb\",\n \"Framework :: Dash\",\n \"Framework :: Datasette\",\n \"Framework :: Django\",\n \"Framework :: Django :: 1\",\n \"Framework :: Django :: 1.4\",\n \"Framework :: Django :: 1.5\",\n \"Framework :: Django :: 1.6\",\n \"Framework :: Django :: 1.7\",\n \"Framework :: Django :: 1.8\",\n \"Framework :: Django :: 1.9\",\n \"Framework :: Django :: 1.10\",\n \"Framework :: Django :: 1.11\",\n \"Framework :: Django :: 2\",\n \"Framework :: Django :: 2.0\",\n \"Framework :: Django :: 2.1\",\n \"Framework :: Django :: 2.2\",\n \"Framework :: Django :: 3\",\n \"Framework :: Django :: 3.0\",\n \"Framework :: Django :: 3.1\",\n \"Framework :: Django :: 3.2\",\n \"Framework :: Django :: 4\",\n \"Framework :: Django :: 4.0\",\n \"Framework :: Django :: 4.1\",\n \"Framework :: Django :: 4.2\",\n \"Framework :: Django :: 5\",\n \"Framework :: Django :: 5.0\",\n \"Framework :: Django :: 5.1\",\n \"Framework :: Django :: 5.2\",\n \"Framework :: Django CMS\",\n \"Framework :: Django CMS :: 3.4\",\n \"Framework :: Django CMS :: 3.5\",\n \"Framework :: Django CMS :: 3.6\",\n \"Framework :: Django CMS :: 3.7\",\n \"Framework :: Django CMS :: 3.8\",\n \"Framework :: Django CMS :: 3.9\",\n \"Framework :: Django CMS :: 3.10\",\n \"Framework :: Django CMS :: 3.11\",\n \"Framework :: Django CMS :: 4.0\",\n \"Framework :: Django CMS :: 4.1\",\n \"Framework :: Django CMS :: 5.0\",\n \"Framework :: FastAPI\",\n \"Framework :: Flake8\",\n \"Framework :: Flask\",\n \"Framework :: Hatch\",\n \"Framework :: Hypothesis\",\n \"Framework :: IDLE\",\n \"Framework :: IPython\",\n \"Framework :: Jupyter\",\n \"Framework :: Jupyter :: JupyterLab\",\n \"Framework :: Jupyter :: JupyterLab :: 1\",\n \"Framework :: Jupyter :: JupyterLab :: 2\",\n \"Framework :: Jupyter :: JupyterLab :: 3\",\n \"Framework :: Jupyter :: JupyterLab :: 4\",\n \"Framework :: Jupyter :: JupyterLab :: Extensions\",\n \"Framework :: Jupyter :: JupyterLab :: Extensions :: Mime Renderers\",\n \"Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt\",\n \"Framework :: Jupyter :: JupyterLab :: Extensions :: Themes\",\n \"Framework :: Kedro\",\n \"Framework :: Lektor\",\n \"Framework :: Masonite\",\n \"Framework :: Matplotlib\",\n \"Framework :: MkDocs\",\n \"Framework :: Nengo\",\n \"Framework :: Odoo\",\n \"Framework :: Odoo :: 8.0\",\n \"Framework :: Odoo :: 9.0\",\n \"Framework :: Odoo :: 10.0\",\n \"Framework :: Odoo :: 11.0\",\n \"Framework :: Odoo :: 12.0\",\n \"Framework :: Odoo :: 13.0\",\n \"Framework :: Odoo :: 14.0\",\n \"Framework :: Odoo :: 15.0\",\n \"Framework :: Odoo :: 16.0\",\n \"Framework :: Odoo :: 17.0\",\n \"Framework :: Odoo :: 18.0\",\n \"Framework :: OpenTelemetry\",\n \"Framework :: OpenTelemetry :: Distros\",\n \"Framework :: OpenTelemetry :: Exporters\",\n \"Framework :: OpenTelemetry :: Instrumentations\",\n \"Framework :: Opps\",\n \"Framework :: Paste\",\n \"Framework :: Pelican\",\n \"Framework :: Pelican :: Plugins\",\n \"Framework :: Pelican :: Themes\",\n \"Framework :: Plone\",\n \"Framework :: Plone :: 3.2\",\n \"Framework :: Plone :: 3.3\",\n \"Framework :: Plone :: 4.0\",\n \"Framework :: Plone :: 4.1\",\n \"Framework :: Plone :: 4.2\",\n \"Framework :: Plone :: 4.3\",\n \"Framework :: Plone :: 5.0\",\n \"Framework :: Plone :: 5.1\",\n \"Framework :: Plone :: 5.2\",\n \"Framework :: Plone :: 5.3\",\n \"Framework :: Plone :: 6.0\",\n \"Framework :: Plone :: 6.1\",\n \"Framework :: Plone :: 6.2\",\n \"Framework :: Plone :: Addon\",\n \"Framework :: Plone :: Core\",\n \"Framework :: Plone :: Distribution\",\n \"Framework :: Plone :: Theme\",\n \"Framework :: PySimpleGUI\",\n \"Framework :: PySimpleGUI :: 4\",\n \"Framework :: PySimpleGUI :: 5\",\n \"Framework :: Pycsou\",\n \"Framework :: Pydantic\",\n \"Framework :: Pydantic :: 1\",\n \"Framework :: Pydantic :: 2\",\n \"Framework :: Pylons\",\n \"Framework :: Pyodide\",\n \"Framework :: Pyramid\",\n \"Framework :: Pytest\",\n \"Framework :: Review Board\",\n \"Framework :: Robot Framework\",\n \"Framework :: Robot Framework :: Library\",\n \"Framework :: Robot Framework :: Tool\",\n \"Framework :: Scrapy\",\n \"Framework :: Setuptools Plugin\",\n \"Framework :: Sphinx\",\n \"Framework :: Sphinx :: Domain\",\n \"Framework :: Sphinx :: Extension\",\n \"Framework :: Sphinx :: Theme\",\n \"Framework :: Trac\",\n \"Framework :: Trio\",\n \"Framework :: Tryton\",\n \"Framework :: TurboGears\",\n \"Framework :: TurboGears :: Applications\",\n \"Framework :: TurboGears :: Widgets\",\n \"Framework :: Twisted\",\n \"Framework :: Wagtail\",\n \"Framework :: Wagtail :: 1\",\n \"Framework :: Wagtail :: 2\",\n \"Framework :: Wagtail :: 3\",\n \"Framework :: Wagtail :: 4\",\n \"Framework :: Wagtail :: 5\",\n \"Framework :: Wagtail :: 6\",\n \"Framework :: ZODB\",\n \"Framework :: Zope\",\n \"Framework :: Zope2\",\n \"Framework :: Zope3\",\n \"Framework :: Zope :: 2\",\n \"Framework :: Zope :: 3\",\n \"Framework :: Zope :: 4\",\n \"Framework :: Zope :: 5\",\n \"Framework :: aiohttp\",\n \"Framework :: cocotb\",\n \"Framework :: napari\",\n \"Framework :: tox\",\n \"Intended Audience :: Customer Service\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: Education\",\n \"Intended Audience :: End Users/Desktop\",\n \"Intended Audience :: Financial and Insurance Industry\",\n \"Intended Audience :: Healthcare Industry\",\n \"Intended Audience :: Information Technology\",\n \"Intended Audience :: Legal Industry\",\n \"Intended Audience :: Manufacturing\",\n \"Intended Audience :: Other Audience\",\n \"Intended Audience :: Religion\",\n \"Intended Audience :: Science/Research\",\n \"Intended Audience :: System Administrators\",\n \"Intended Audience :: Telecommunications Industry\",\n \"License :: Aladdin Free Public License (AFPL)\",\n \"License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication\",\n \"License :: CeCILL-B Free Software License Agreement (CECILL-B)\",\n \"License :: CeCILL-C Free Software License Agreement (CECILL-C)\",\n \"License :: DFSG approved\",\n \"License :: Eiffel Forum License (EFL)\",\n \"License :: Free For Educational Use\",\n \"License :: Free For Home Use\",\n \"License :: Free To Use But Restricted\",\n \"License :: Free for non-commercial use\",\n \"License :: Freely Distributable\",\n \"License :: Freeware\",\n \"License :: GUST Font License 1.0\",\n \"License :: GUST Font License 2006-09-30\",\n \"License :: Netscape Public License (NPL)\",\n \"License :: Nokia Open Source License (NOKOS)\",\n \"License :: OSI Approved\",\n \"License :: OSI Approved :: Academic Free License (AFL)\",\n \"License :: OSI Approved :: Apache Software License\",\n \"License :: OSI Approved :: Apple Public Source License\",\n \"License :: OSI Approved :: Artistic License\",\n \"License :: OSI Approved :: Attribution Assurance License\",\n \"License :: OSI Approved :: BSD License\",\n \"License :: OSI Approved :: Blue Oak Model License (BlueOak-1.0.0)\",\n \"License :: OSI Approved :: Boost Software License 1.0 (BSL-1.0)\",\n \"License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)\",\n \"License :: OSI Approved :: CMU License (MIT-CMU)\",\n \"License :: OSI Approved :: Common Development and Distribution License 1.0 (CDDL-1.0)\",\n \"License :: OSI Approved :: Common Public License\",\n \"License :: OSI Approved :: Eclipse Public License 1.0 (EPL-1.0)\",\n \"License :: OSI Approved :: Eclipse Public License 2.0 (EPL-2.0)\",\n \"License :: OSI Approved :: Educational Community License, Version 2.0 (ECL-2.0)\",\n \"License :: OSI Approved :: Eiffel Forum License\",\n \"License :: OSI Approved :: European Union Public Licence 1.0 (EUPL 1.0)\",\n \"License :: OSI Approved :: European Union Public Licence 1.1 (EUPL 1.1)\",\n \"License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)\",\n \"License :: OSI Approved :: GNU Affero General Public License v3\",\n \"License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)\",\n \"License :: OSI Approved :: GNU Free Documentation License (FDL)\",\n \"License :: OSI Approved :: GNU General Public License (GPL)\",\n \"License :: OSI Approved :: GNU General Public License v2 (GPLv2)\",\n \"License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)\",\n \"License :: OSI Approved :: GNU General Public License v3 (GPLv3)\",\n \"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)\",\n \"License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)\",\n \"License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)\",\n \"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)\",\n \"License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)\",\n \"License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)\",\n \"License :: OSI Approved :: Historical Permission Notice and Disclaimer (HPND)\",\n \"License :: OSI Approved :: IBM Public License\",\n \"License :: OSI Approved :: ISC License (ISCL)\",\n \"License :: OSI Approved :: MIT License\",\n \"License :: OSI Approved :: MIT No Attribution License (MIT-0)\",\n \"License :: OSI Approved :: MirOS License (MirOS)\",\n \"License :: OSI Approved :: Motosoto License\",\n \"License :: OSI Approved :: Mozilla Public License 1.0 (MPL)\",\n \"License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)\",\n \"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)\",\n \"License :: OSI Approved :: Mulan Permissive Software License v2 (MulanPSL-2.0)\",\n \"License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)\",\n \"License :: OSI Approved :: Nethack General Public License\",\n \"License :: OSI Approved :: Nokia Open Source License\",\n \"License :: OSI Approved :: Open Group Test Suite License\",\n \"License :: OSI Approved :: Open Software License 3.0 (OSL-3.0)\",\n \"License :: OSI Approved :: PostgreSQL License\",\n \"License :: OSI Approved :: Python License (CNRI Python License)\",\n \"License :: OSI Approved :: Python Software Foundation License\",\n \"License :: OSI Approved :: Qt Public License (QPL)\",\n \"License :: OSI Approved :: Ricoh Source Code Public License\",\n \"License :: OSI Approved :: SIL Open Font License 1.1 (OFL-1.1)\",\n \"License :: OSI Approved :: Sleepycat License\",\n \"License :: OSI Approved :: Sun Public License\",\n \"License :: OSI Approved :: The Unlicense (Unlicense)\",\n \"License :: OSI Approved :: Universal Permissive License (UPL)\",\n \"License :: OSI Approved :: University of Illinois/NCSA Open Source License\",\n \"License :: OSI Approved :: Vovida Software License 1.0\",\n \"License :: OSI Approved :: W3C License\",\n \"License :: OSI Approved :: Zero-Clause BSD (0BSD)\",\n \"License :: OSI Approved :: Zope Public License\",\n \"License :: OSI Approved :: zlib/libpng License\",\n \"License :: Other/Proprietary License\",\n \"License :: Public Domain\",\n \"License :: Repoze Public License\",\n \"Natural Language :: Afrikaans\",\n \"Natural Language :: Arabic\",\n \"Natural Language :: Basque\",\n \"Natural Language :: Bengali\",\n \"Natural Language :: Bosnian\",\n \"Natural Language :: Bulgarian\",\n \"Natural Language :: Cantonese\",\n \"Natural Language :: Catalan\",\n \"Natural Language :: Catalan (Valencian)\",\n \"Natural Language :: Chinese (Simplified)\",\n \"Natural Language :: Chinese (Traditional)\",\n \"Natural Language :: Croatian\",\n \"Natural Language :: Czech\",\n \"Natural Language :: Danish\",\n \"Natural Language :: Dutch\",\n \"Natural Language :: English\",\n \"Natural Language :: Esperanto\",\n \"Natural Language :: Finnish\",\n \"Natural Language :: French\",\n \"Natural Language :: Galician\",\n \"Natural Language :: Georgian\",\n \"Natural Language :: German\",\n \"Natural Language :: Greek\",\n \"Natural Language :: Hebrew\",\n \"Natural Language :: Hindi\",\n \"Natural Language :: Hungarian\",\n \"Natural Language :: Icelandic\",\n \"Natural Language :: Indonesian\",\n \"Natural Language :: Irish\",\n \"Natural Language :: Italian\",\n \"Natural Language :: Japanese\",\n \"Natural Language :: Javanese\",\n \"Natural Language :: Korean\",\n \"Natural Language :: Latin\",\n \"Natural Language :: Latvian\",\n \"Natural Language :: Lithuanian\",\n \"Natural Language :: Macedonian\",\n \"Natural Language :: Malay\",\n \"Natural Language :: Marathi\",\n \"Natural Language :: Nepali\",\n \"Natural Language :: Norwegian\",\n \"Natural Language :: Panjabi\",\n \"Natural Language :: Persian\",\n \"Natural Language :: Polish\",\n \"Natural Language :: Portuguese\",\n \"Natural Language :: Portuguese (Brazilian)\",\n \"Natural Language :: Romanian\",\n \"Natural Language :: Russian\",\n \"Natural Language :: Serbian\",\n \"Natural Language :: Slovak\",\n \"Natural Language :: Slovenian\",\n \"Natural Language :: Spanish\",\n \"Natural Language :: Swedish\",\n \"Natural Language :: Tamil\",\n \"Natural Language :: Telugu\",\n \"Natural Language :: Thai\",\n \"Natural Language :: Tibetan\",\n \"Natural Language :: Turkish\",\n \"Natural Language :: Ukrainian\",\n \"Natural Language :: Urdu\",\n \"Natural Language :: Vietnamese\",\n \"Operating System :: Android\",\n \"Operating System :: BeOS\",\n \"Operating System :: MacOS\",\n \"Operating System :: MacOS :: MacOS 9\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Operating System :: Microsoft\",\n \"Operating System :: Microsoft :: MS-DOS\",\n \"Operating System :: Microsoft :: Windows\",\n \"Operating System :: Microsoft :: Windows :: Windows 3.1 or Earlier\",\n \"Operating System :: Microsoft :: Windows :: Windows 7\",\n \"Operating System :: Microsoft :: Windows :: Windows 8\",\n \"Operating System :: Microsoft :: Windows :: Windows 8.1\",\n \"Operating System :: Microsoft :: Windows :: Windows 10\",\n \"Operating System :: Microsoft :: Windows :: Windows 11\",\n \"Operating System :: Microsoft :: Windows :: Windows 95/98/2000\",\n \"Operating System :: Microsoft :: Windows :: Windows CE\",\n \"Operating System :: Microsoft :: Windows :: Windows NT/2000\",\n \"Operating System :: Microsoft :: Windows :: Windows Server 2003\",\n \"Operating System :: Microsoft :: Windows :: Windows Server 2008\",\n \"Operating System :: Microsoft :: Windows :: Windows Vista\",\n \"Operating System :: Microsoft :: Windows :: Windows XP\",\n \"Operating System :: OS Independent\",\n \"Operating System :: OS/2\",\n \"Operating System :: Other OS\",\n \"Operating System :: PDA Systems\",\n \"Operating System :: POSIX\",\n \"Operating System :: POSIX :: AIX\",\n \"Operating System :: POSIX :: BSD\",\n \"Operating System :: POSIX :: BSD :: BSD/OS\",\n \"Operating System :: POSIX :: BSD :: FreeBSD\",\n \"Operating System :: POSIX :: BSD :: NetBSD\",\n \"Operating System :: POSIX :: BSD :: OpenBSD\",\n \"Operating System :: POSIX :: GNU Hurd\",\n \"Operating System :: POSIX :: HP-UX\",\n \"Operating System :: POSIX :: IRIX\",\n \"Operating System :: POSIX :: Linux\",\n \"Operating System :: POSIX :: Other\",\n \"Operating System :: POSIX :: SCO\",\n \"Operating System :: POSIX :: SunOS/Solaris\",\n \"Operating System :: PalmOS\",\n \"Operating System :: RISC OS\",\n \"Operating System :: Unix\",\n \"Operating System :: iOS\",\n \"Programming Language :: APL\",\n \"Programming Language :: ASP\",\n \"Programming Language :: Ada\",\n \"Programming Language :: Assembly\",\n \"Programming Language :: Awk\",\n \"Programming Language :: Basic\",\n \"Programming Language :: C\",\n \"Programming Language :: C#\",\n \"Programming Language :: C++\",\n \"Programming Language :: Cold Fusion\",\n \"Programming Language :: Cython\",\n \"Programming Language :: D\",\n \"Programming Language :: Delphi/Kylix\",\n \"Programming Language :: Dylan\",\n \"Programming Language :: Eiffel\",\n \"Programming Language :: Emacs-Lisp\",\n \"Programming Language :: Erlang\",\n \"Programming Language :: Euler\",\n \"Programming Language :: Euphoria\",\n \"Programming Language :: F#\",\n \"Programming Language :: Forth\",\n \"Programming Language :: Fortran\",\n \"Programming Language :: Go\",\n \"Programming Language :: Haskell\",\n \"Programming Language :: Hy\",\n \"Programming Language :: Java\",\n \"Programming Language :: JavaScript\",\n \"Programming Language :: Kotlin\",\n \"Programming Language :: Lisp\",\n \"Programming Language :: Logo\",\n \"Programming Language :: Lua\",\n \"Programming Language :: ML\",\n \"Programming Language :: Modula\",\n \"Programming Language :: OCaml\",\n \"Programming Language :: Object Pascal\",\n \"Programming Language :: Objective C\",\n \"Programming Language :: Other\",\n \"Programming Language :: Other Scripting Engines\",\n \"Programming Language :: PHP\",\n \"Programming Language :: PL/SQL\",\n \"Programming Language :: PROGRESS\",\n \"Programming Language :: Pascal\",\n \"Programming Language :: Perl\",\n \"Programming Language :: Pike\",\n \"Programming Language :: Pliant\",\n \"Programming Language :: Prolog\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2 :: Only\",\n \"Programming Language :: Python :: 2.3\",\n \"Programming Language :: Python :: 2.4\",\n \"Programming Language :: Python :: 2.5\",\n \"Programming Language :: Python :: 2.6\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3 :: Only\",\n \"Programming Language :: Python :: 3.0\",\n \"Programming Language :: Python :: 3.1\",\n \"Programming Language :: Python :: 3.2\",\n \"Programming Language :: Python :: 3.3\",\n \"Programming Language :: Python :: 3.4\",\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 :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3.14\",\n \"Programming Language :: Python :: Implementation\",\n \"Programming Language :: Python :: Implementation :: CPython\",\n \"Programming Language :: Python :: Implementation :: IronPython\",\n \"Programming Language :: Python :: Implementation :: Jython\",\n \"Programming Language :: Python :: Implementation :: MicroPython\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Programming Language :: Python :: Implementation :: Stackless\",\n \"Programming Language :: R\",\n \"Programming Language :: REBOL\",\n \"Programming Language :: Rexx\",\n \"Programming Language :: Ruby\",\n \"Programming Language :: Rust\",\n \"Programming Language :: SQL\",\n \"Programming Language :: Scheme\",\n \"Programming Language :: Simula\",\n \"Programming Language :: Smalltalk\",\n \"Programming Language :: Tcl\",\n \"Programming Language :: Unix Shell\",\n \"Programming Language :: Visual Basic\",\n \"Programming Language :: XBasic\",\n \"Programming Language :: YACC\",\n \"Programming Language :: Zope\",\n \"Topic :: Adaptive Technologies\",\n \"Topic :: Artistic Software\",\n \"Topic :: Communications\",\n \"Topic :: Communications :: BBS\",\n \"Topic :: Communications :: Chat\",\n \"Topic :: Communications :: Chat :: ICQ\",\n \"Topic :: Communications :: Chat :: Internet Relay Chat\",\n \"Topic :: Communications :: Chat :: Unix Talk\",\n \"Topic :: Communications :: Conferencing\",\n \"Topic :: Communications :: Email\",\n \"Topic :: Communications :: Email :: Address Book\",\n \"Topic :: Communications :: Email :: Email Clients (MUA)\",\n \"Topic :: Communications :: Email :: Filters\",\n \"Topic :: Communications :: Email :: Mail Transport Agents\",\n \"Topic :: Communications :: Email :: Mailing List Servers\",\n \"Topic :: Communications :: Email :: Post-Office\",\n \"Topic :: Communications :: Email :: Post-Office :: IMAP\",\n \"Topic :: Communications :: Email :: Post-Office :: POP3\",\n \"Topic :: Communications :: FIDO\",\n \"Topic :: Communications :: Fax\",\n \"Topic :: Communications :: File Sharing\",\n \"Topic :: Communications :: File Sharing :: Gnutella\",\n \"Topic :: Communications :: File Sharing :: Napster\",\n \"Topic :: Communications :: Ham Radio\",\n \"Topic :: Communications :: Internet Phone\",\n \"Topic :: Communications :: Telephony\",\n \"Topic :: Communications :: Usenet News\",\n \"Topic :: Database\",\n \"Topic :: Database :: Database Engines/Servers\",\n \"Topic :: Database :: Front-Ends\",\n \"Topic :: Desktop Environment\",\n \"Topic :: Desktop Environment :: File Managers\",\n \"Topic :: Desktop Environment :: GNUstep\",\n \"Topic :: Desktop Environment :: Gnome\",\n \"Topic :: Desktop Environment :: K Desktop Environment (KDE)\",\n \"Topic :: Desktop Environment :: K Desktop Environment (KDE) :: Themes\",\n \"Topic :: Desktop Environment :: PicoGUI\",\n \"Topic :: Desktop Environment :: PicoGUI :: Applications\",\n \"Topic :: Desktop Environment :: PicoGUI :: Themes\",\n \"Topic :: Desktop Environment :: Screen Savers\",\n \"Topic :: Desktop Environment :: Window Managers\",\n \"Topic :: Desktop Environment :: Window Managers :: Afterstep\",\n \"Topic :: Desktop Environment :: Window Managers :: Afterstep :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: Applets\",\n \"Topic :: Desktop Environment :: Window Managers :: Blackbox\",\n \"Topic :: Desktop Environment :: Window Managers :: Blackbox :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: CTWM\",\n \"Topic :: Desktop Environment :: Window Managers :: CTWM :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: Enlightenment\",\n \"Topic :: Desktop Environment :: Window Managers :: Enlightenment :: Epplets\",\n \"Topic :: Desktop Environment :: Window Managers :: Enlightenment :: Themes DR15\",\n \"Topic :: Desktop Environment :: Window Managers :: Enlightenment :: Themes DR16\",\n \"Topic :: Desktop Environment :: Window Managers :: Enlightenment :: Themes DR17\",\n \"Topic :: Desktop Environment :: Window Managers :: FVWM\",\n \"Topic :: Desktop Environment :: Window Managers :: FVWM :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: Fluxbox\",\n \"Topic :: Desktop Environment :: Window Managers :: Fluxbox :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: IceWM\",\n \"Topic :: Desktop Environment :: Window Managers :: IceWM :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: MetaCity\",\n \"Topic :: Desktop Environment :: Window Managers :: MetaCity :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: Oroborus\",\n \"Topic :: Desktop Environment :: Window Managers :: Oroborus :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: Sawfish\",\n \"Topic :: Desktop Environment :: Window Managers :: Sawfish :: Themes 0.30\",\n \"Topic :: Desktop Environment :: Window Managers :: Sawfish :: Themes pre-0.30\",\n \"Topic :: Desktop Environment :: Window Managers :: Waimea\",\n \"Topic :: Desktop Environment :: Window Managers :: Waimea :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: Window Maker\",\n \"Topic :: Desktop Environment :: Window Managers :: Window Maker :: Applets\",\n \"Topic :: Desktop Environment :: Window Managers :: Window Maker :: Themes\",\n \"Topic :: Desktop Environment :: Window Managers :: XFCE\",\n \"Topic :: Desktop Environment :: Window Managers :: XFCE :: Themes\",\n \"Topic :: Documentation\",\n \"Topic :: Documentation :: Sphinx\",\n \"Topic :: Education\",\n \"Topic :: Education :: Computer Aided Instruction (CAI)\",\n \"Topic :: Education :: Testing\",\n \"Topic :: File Formats\",\n \"Topic :: File Formats :: JSON\",\n \"Topic :: File Formats :: JSON :: JSON Schema\",\n \"Topic :: Games/Entertainment\",\n \"Topic :: Games/Entertainment :: Arcade\",\n \"Topic :: Games/Entertainment :: Board Games\",\n \"Topic :: Games/Entertainment :: First Person Shooters\",\n \"Topic :: Games/Entertainment :: Fortune Cookies\",\n \"Topic :: Games/Entertainment :: Multi-User Dungeons (MUD)\",\n \"Topic :: Games/Entertainment :: Puzzle Games\",\n \"Topic :: Games/Entertainment :: Real Time Strategy\",\n \"Topic :: Games/Entertainment :: Role-Playing\",\n \"Topic :: Games/Entertainment :: Side-Scrolling/Arcade Games\",\n \"Topic :: Games/Entertainment :: Simulation\",\n \"Topic :: Games/Entertainment :: Turn Based Strategy\",\n \"Topic :: Home Automation\",\n \"Topic :: Internet\",\n \"Topic :: Internet :: File Transfer Protocol (FTP)\",\n \"Topic :: Internet :: Finger\",\n \"Topic :: Internet :: Log Analysis\",\n \"Topic :: Internet :: Name Service (DNS)\",\n \"Topic :: Internet :: Proxy Servers\",\n \"Topic :: Internet :: WAP\",\n \"Topic :: Internet :: WWW/HTTP\",\n \"Topic :: Internet :: WWW/HTTP :: Browsers\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Message Boards\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: News/Diary\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Page Counters\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki\",\n \"Topic :: Internet :: WWW/HTTP :: HTTP Servers\",\n \"Topic :: Internet :: WWW/HTTP :: Indexing/Search\",\n \"Topic :: Internet :: WWW/HTTP :: Session\",\n \"Topic :: Internet :: WWW/HTTP :: Site Management\",\n \"Topic :: Internet :: WWW/HTTP :: Site Management :: Link Checking\",\n \"Topic :: Internet :: WWW/HTTP :: WSGI\",\n \"Topic :: Internet :: WWW/HTTP :: WSGI :: Application\",\n \"Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware\",\n \"Topic :: Internet :: WWW/HTTP :: WSGI :: Server\",\n \"Topic :: Internet :: XMPP\",\n \"Topic :: Internet :: Z39.50\",\n \"Topic :: Multimedia\",\n \"Topic :: Multimedia :: Graphics\",\n \"Topic :: Multimedia :: Graphics :: 3D Modeling\",\n \"Topic :: Multimedia :: Graphics :: 3D Rendering\",\n \"Topic :: Multimedia :: Graphics :: Capture\",\n \"Topic :: Multimedia :: Graphics :: Capture :: Digital Camera\",\n \"Topic :: Multimedia :: Graphics :: Capture :: Scanners\",\n \"Topic :: Multimedia :: Graphics :: Capture :: Screen Capture\",\n \"Topic :: Multimedia :: Graphics :: Editors\",\n \"Topic :: Multimedia :: Graphics :: Editors :: Raster-Based\",\n \"Topic :: Multimedia :: Graphics :: Editors :: Vector-Based\",\n \"Topic :: Multimedia :: Graphics :: Graphics Conversion\",\n \"Topic :: Multimedia :: Graphics :: Presentation\",\n \"Topic :: Multimedia :: Graphics :: Viewers\",\n \"Topic :: Multimedia :: Sound/Audio\",\n \"Topic :: Multimedia :: Sound/Audio :: Analysis\",\n \"Topic :: Multimedia :: Sound/Audio :: CD Audio\",\n \"Topic :: Multimedia :: Sound/Audio :: CD Audio :: CD Playing\",\n \"Topic :: Multimedia :: Sound/Audio :: CD Audio :: CD Ripping\",\n \"Topic :: Multimedia :: Sound/Audio :: CD Audio :: CD Writing\",\n \"Topic :: Multimedia :: Sound/Audio :: Capture/Recording\",\n \"Topic :: Multimedia :: Sound/Audio :: Conversion\",\n \"Topic :: Multimedia :: Sound/Audio :: Editors\",\n \"Topic :: Multimedia :: Sound/Audio :: MIDI\",\n \"Topic :: Multimedia :: Sound/Audio :: Mixers\",\n \"Topic :: Multimedia :: Sound/Audio :: Players\",\n \"Topic :: Multimedia :: Sound/Audio :: Players :: MP3\",\n \"Topic :: Multimedia :: Sound/Audio :: Sound Synthesis\",\n \"Topic :: Multimedia :: Sound/Audio :: Speech\",\n \"Topic :: Multimedia :: Video\",\n \"Topic :: Multimedia :: Video :: Capture\",\n \"Topic :: Multimedia :: Video :: Conversion\",\n \"Topic :: Multimedia :: Video :: Display\",\n \"Topic :: Multimedia :: Video :: Non-Linear Editor\",\n \"Topic :: Office/Business\",\n \"Topic :: Office/Business :: Financial\",\n \"Topic :: Office/Business :: Financial :: Accounting\",\n \"Topic :: Office/Business :: Financial :: Investment\",\n \"Topic :: Office/Business :: Financial :: Point-Of-Sale\",\n \"Topic :: Office/Business :: Financial :: Spreadsheet\",\n \"Topic :: Office/Business :: Groupware\",\n \"Topic :: Office/Business :: News/Diary\",\n \"Topic :: Office/Business :: Office Suites\",\n \"Topic :: Office/Business :: Scheduling\",\n \"Topic :: Other/Nonlisted Topic\",\n \"Topic :: Printing\",\n \"Topic :: Religion\",\n \"Topic :: Scientific/Engineering\",\n \"Topic :: Scientific/Engineering :: Artificial Intelligence\",\n \"Topic :: Scientific/Engineering :: Artificial Life\",\n \"Topic :: Scientific/Engineering :: Astronomy\",\n \"Topic :: Scientific/Engineering :: Atmospheric Science\",\n \"Topic :: Scientific/Engineering :: Bio-Informatics\",\n \"Topic :: Scientific/Engineering :: Chemistry\",\n \"Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)\",\n \"Topic :: Scientific/Engineering :: GIS\",\n \"Topic :: Scientific/Engineering :: Human Machine Interfaces\",\n \"Topic :: Scientific/Engineering :: Hydrology\",\n \"Topic :: Scientific/Engineering :: Image Processing\",\n \"Topic :: Scientific/Engineering :: Image Recognition\",\n \"Topic :: Scientific/Engineering :: Information Analysis\",\n \"Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator\",\n \"Topic :: Scientific/Engineering :: Mathematics\",\n \"Topic :: Scientific/Engineering :: Medical Science Apps.\",\n \"Topic :: Scientific/Engineering :: Oceanography\",\n \"Topic :: Scientific/Engineering :: Physics\",\n \"Topic :: Scientific/Engineering :: Quantum Computing\",\n \"Topic :: Scientific/Engineering :: Visualization\",\n \"Topic :: Security\",\n \"Topic :: Security :: Cryptography\",\n \"Topic :: Sociology\",\n \"Topic :: Sociology :: Genealogy\",\n \"Topic :: Sociology :: History\",\n \"Topic :: Software Development\",\n \"Topic :: Software Development :: Assemblers\",\n \"Topic :: Software Development :: Bug Tracking\",\n \"Topic :: Software Development :: Build Tools\",\n \"Topic :: Software Development :: Code Generators\",\n \"Topic :: Software Development :: Compilers\",\n \"Topic :: Software Development :: Debuggers\",\n \"Topic :: Software Development :: Disassemblers\",\n \"Topic :: Software Development :: Documentation\",\n \"Topic :: Software Development :: Embedded Systems\",\n \"Topic :: Software Development :: Embedded Systems :: Controller Area Network (CAN)\",\n \"Topic :: Software Development :: Embedded Systems :: Controller Area Network (CAN) :: CANopen\",\n \"Topic :: Software Development :: Embedded Systems :: Controller Area Network (CAN) :: J1939\",\n \"Topic :: Software Development :: Internationalization\",\n \"Topic :: Software Development :: Interpreters\",\n \"Topic :: Software Development :: Libraries\",\n \"Topic :: Software Development :: Libraries :: Application Frameworks\",\n \"Topic :: Software Development :: Libraries :: Java Libraries\",\n \"Topic :: Software Development :: Libraries :: PHP Classes\",\n \"Topic :: Software Development :: Libraries :: Perl Modules\",\n \"Topic :: Software Development :: Libraries :: Pike Modules\",\n \"Topic :: Software Development :: Libraries :: Python Modules\",\n \"Topic :: Software Development :: Libraries :: Ruby Modules\",\n \"Topic :: Software Development :: Libraries :: Tcl Extensions\",\n \"Topic :: Software Development :: Libraries :: pygame\",\n \"Topic :: Software Development :: Localization\",\n \"Topic :: Software Development :: Object Brokering\",\n \"Topic :: Software Development :: Object Brokering :: CORBA\",\n \"Topic :: Software Development :: Pre-processors\",\n \"Topic :: Software Development :: Quality Assurance\",\n \"Topic :: Software Development :: Testing\",\n \"Topic :: Software Development :: Testing :: Acceptance\",\n \"Topic :: Software Development :: Testing :: BDD\",\n \"Topic :: Software Development :: Testing :: Mocking\",\n \"Topic :: Software Development :: Testing :: Traffic Generation\",\n \"Topic :: Software Development :: Testing :: Unit\",\n \"Topic :: Software Development :: User Interfaces\",\n \"Topic :: Software Development :: Version Control\",\n \"Topic :: Software Development :: Version Control :: Bazaar\",\n \"Topic :: Software Development :: Version Control :: CVS\",\n \"Topic :: Software Development :: Version Control :: Git\",\n \"Topic :: Software Development :: Version Control :: Mercurial\",\n \"Topic :: Software Development :: Version Control :: RCS\",\n \"Topic :: Software Development :: Version Control :: SCCS\",\n \"Topic :: Software Development :: Widget Sets\",\n \"Topic :: System\",\n \"Topic :: System :: Archiving\",\n \"Topic :: System :: Archiving :: Backup\",\n \"Topic :: System :: Archiving :: Compression\",\n \"Topic :: System :: Archiving :: Mirroring\",\n \"Topic :: System :: Archiving :: Packaging\",\n \"Topic :: System :: Benchmark\",\n \"Topic :: System :: Boot\",\n \"Topic :: System :: Boot :: Init\",\n \"Topic :: System :: Clustering\",\n \"Topic :: System :: Console Fonts\",\n \"Topic :: System :: Distributed Computing\",\n \"Topic :: System :: Emulators\",\n \"Topic :: System :: Filesystems\",\n \"Topic :: System :: Hardware\",\n \"Topic :: System :: Hardware :: Hardware Drivers\",\n \"Topic :: System :: Hardware :: Mainframes\",\n \"Topic :: System :: Hardware :: Symmetric Multi-processing\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB)\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Audio\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Audio/Video (AV)\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Communications Device Class (CDC)\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Diagnostic Device\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Hub\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Human Interface Device (HID)\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Mass Storage\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Miscellaneous\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Printer\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Smart Card\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Vendor\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Video (UVC)\",\n \"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Wireless Controller\",\n \"Topic :: System :: Installation/Setup\",\n \"Topic :: System :: Logging\",\n \"Topic :: System :: Monitoring\",\n \"Topic :: System :: Networking\",\n \"Topic :: System :: Networking :: Firewalls\",\n \"Topic :: System :: Networking :: Monitoring\",\n \"Topic :: System :: Networking :: Monitoring :: Hardware Watchdog\",\n \"Topic :: System :: Networking :: Time Synchronization\",\n \"Topic :: System :: Operating System\",\n \"Topic :: System :: Operating System Kernels\",\n \"Topic :: System :: Operating System Kernels :: BSD\",\n \"Topic :: System :: Operating System Kernels :: GNU Hurd\",\n \"Topic :: System :: Operating System Kernels :: Linux\",\n \"Topic :: System :: Power (UPS)\",\n \"Topic :: System :: Recovery Tools\",\n \"Topic :: System :: Shells\",\n \"Topic :: System :: Software Distribution\",\n \"Topic :: System :: System Shells\",\n \"Topic :: System :: Systems Administration\",\n \"Topic :: System :: Systems Administration :: Authentication/Directory\",\n \"Topic :: System :: Systems Administration :: Authentication/Directory :: LDAP\",\n \"Topic :: System :: Systems Administration :: Authentication/Directory :: NIS\",\n \"Topic :: Terminals\",\n \"Topic :: Terminals :: Serial\",\n \"Topic :: Terminals :: Telnet\",\n \"Topic :: Terminals :: Terminal Emulators/X Terminals\",\n \"Topic :: Text Editors\",\n \"Topic :: Text Editors :: Documentation\",\n \"Topic :: Text Editors :: Emacs\",\n \"Topic :: Text Editors :: Integrated Development Environments (IDE)\",\n \"Topic :: Text Editors :: Text Processing\",\n \"Topic :: Text Editors :: Word Processors\",\n \"Topic :: Text Processing\",\n \"Topic :: Text Processing :: Filters\",\n \"Topic :: Text Processing :: Fonts\",\n \"Topic :: Text Processing :: General\",\n \"Topic :: Text Processing :: Indexing\",\n \"Topic :: Text Processing :: Linguistic\",\n \"Topic :: Text Processing :: Markup\",\n \"Topic :: Text Processing :: Markup :: HTML\",\n \"Topic :: Text Processing :: Markup :: LaTeX\",\n \"Topic :: Text Processing :: Markup :: Markdown\",\n \"Topic :: Text Processing :: Markup :: SGML\",\n \"Topic :: Text Processing :: Markup :: VRML\",\n \"Topic :: Text Processing :: Markup :: XML\",\n \"Topic :: Text Processing :: Markup :: reStructuredText\",\n \"Topic :: Utilities\",\n \"Typing :: Stubs Only\",\n \"Typing :: Typed\",\n]\n\nclassifiers: Set[str] = set(sorted_classifiers)\n\n\n# A mapping from the deprecated classifier name to a list of zero or more valid\n# classifiers that should replace it\ndeprecated_classifiers: Dict[str, List[str]] = {\n \"Framework :: Django CMS :: 4.2\": [\"Framework :: Django CMS :: 5.0\"],\n \"License :: OSI Approved :: Intel Open Source License\": [],\n \"License :: OSI Approved :: Jabber Open Source License\": [],\n \"License :: OSI Approved :: MITRE Collaborative Virtual Workspace License (CVW)\": [],\n \"License :: OSI Approved :: Sun Industry Standards Source License (SISSL)\": [],\n \"License :: OSI Approved :: X.Net License\": [],\n \"Natural Language :: Ukranian\": [\"Natural Language :: Ukrainian\"],\n \"Topic :: Communications :: Chat :: AOL Instant Messenger\": [],\n}\n\n\n# All classifiers, including deprecated classifiers\nall_classifiers: List[str] = sorted(\n sorted_classifiers + list(deprecated_classifiers.keys())\n)\n\n__all__ = [\n \"all_classifiers\",\n \"classifiers\",\n \"deprecated_classifiers\",\n \"sorted_classifiers\",\n]\n\n[end of src/trove_classifiers/__init__.py]","filename":"src/trove_classifiers/__init__.py","id":"9"},{"content":"[end of src/trove_classifiers/py.typed]","filename":"src/trove_classifiers/py.typed","id":"10"},{"content":"from trove_classifiers import sorted_classifiers\n\nfor classifier in sorted_classifiers:\n print(classifier)\n\n[end of src/trove_classifiers/__main__.py]","filename":"src/trove_classifiers/__main__.py","id":"11"}],"string":"[\n {\n \"content\": \"Apache License\\n Version 2.0, January 2004\\n http://www.apache.org/licenses/\\n\\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\\n\\n 1. Definitions.\\n\\n \\\"License\\\" shall mean the terms and conditions for use, reproduction,\\n and distribution as defined by Sections 1 through 9 of this document.\\n\\n \\\"Licensor\\\" shall mean the copyright owner or entity authorized by\\n the copyright owner that is granting the License.\\n\\n \\\"Legal Entity\\\" shall mean the union of the acting entity and all\\n other entities that control, are controlled by, or are under common\\n control with that entity. For the purposes of this definition,\\n \\\"control\\\" means (i) the power, direct or indirect, to cause the\\n direction or management of such entity, whether by contract or\\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\\n outstanding shares, or (iii) beneficial ownership of such entity.\\n\\n \\\"You\\\" (or \\\"Your\\\") shall mean an individual or Legal Entity\\n exercising permissions granted by this License.\\n\\n \\\"Source\\\" form shall mean the preferred form for making modifications,\\n including but not limited to software source code, documentation\\n source, and configuration files.\\n\\n \\\"Object\\\" form shall mean any form resulting from mechanical\\n transformation or translation of a Source form, including but\\n not limited to compiled object code, generated documentation,\\n and conversions to other media types.\\n\\n \\\"Work\\\" shall mean the work of authorship, whether in Source or\\n Object form, made available under the License, as indicated by a\\n copyright notice that is included in or attached to the work\\n (an example is provided in the Appendix below).\\n\\n \\\"Derivative Works\\\" shall mean any work, whether in Source or Object\\n form, that is based on (or derived from) the Work and for which the\\n editorial revisions, annotations, elaborations, or other modifications\\n represent, as a whole, an original work of authorship. For the purposes\\n of this License, Derivative Works shall not include works that remain\\n separable from, or merely link (or bind by name) to the interfaces of,\\n the Work and Derivative Works thereof.\\n\\n \\\"Contribution\\\" shall mean any work of authorship, including\\n the original version of the Work and any modifications or additions\\n to that Work or Derivative Works thereof, that is intentionally\\n submitted to Licensor for inclusion in the Work by the copyright owner\\n or by an individual or Legal Entity authorized to submit on behalf of\\n the copyright owner. For the purposes of this definition, \\\"submitted\\\"\\n means any form of electronic, verbal, or written communication sent\\n to the Licensor or its representatives, including but not limited to\\n communication on electronic mailing lists, source code control systems,\\n and issue tracking systems that are managed by, or on behalf of, the\\n Licensor for the purpose of discussing and improving the Work, but\\n excluding communication that is conspicuously marked or otherwise\\n designated in writing by the copyright owner as \\\"Not a Contribution.\\\"\\n\\n \\\"Contributor\\\" shall mean Licensor and any individual or Legal Entity\\n on behalf of whom a Contribution has been received by Licensor and\\n subsequently incorporated within the Work.\\n\\n 2. Grant of Copyright License. Subject to the terms and conditions of\\n this License, each Contributor hereby grants to You a perpetual,\\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\\n copyright license to reproduce, prepare Derivative Works of,\\n publicly display, publicly perform, sublicense, and distribute the\\n Work and such Derivative Works in Source or Object form.\\n\\n 3. Grant of Patent License. Subject to the terms and conditions of\\n this License, each Contributor hereby grants to You a perpetual,\\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\\n (except as stated in this section) patent license to make, have made,\\n use, offer to sell, sell, import, and otherwise transfer the Work,\\n where such license applies only to those patent claims licensable\\n by such Contributor that are necessarily infringed by their\\n Contribution(s) alone or by combination of their Contribution(s)\\n with the Work to which such Contribution(s) was submitted. If You\\n institute patent litigation against any entity (including a\\n cross-claim or counterclaim in a lawsuit) alleging that the Work\\n or a Contribution incorporated within the Work constitutes direct\\n or contributory patent infringement, then any patent licenses\\n granted to You under this License for that Work shall terminate\\n as of the date such litigation is filed.\\n\\n 4. Redistribution. You may reproduce and distribute copies of the\\n Work or Derivative Works thereof in any medium, with or without\\n modifications, and in Source or Object form, provided that You\\n meet the following conditions:\\n\\n (a) You must give any other recipients of the Work or\\n Derivative Works a copy of this License; and\\n\\n (b) You must cause any modified files to carry prominent notices\\n stating that You changed the files; and\\n\\n (c) You must retain, in the Source form of any Derivative Works\\n that You distribute, all copyright, patent, trademark, and\\n attribution notices from the Source form of the Work,\\n excluding those notices that do not pertain to any part of\\n the Derivative Works; and\\n\\n (d) If the Work includes a \\\"NOTICE\\\" text file as part of its\\n distribution, then any Derivative Works that You distribute must\\n include a readable copy of the attribution notices contained\\n within such NOTICE file, excluding those notices that do not\\n pertain to any part of the Derivative Works, in at least one\\n of the following places: within a NOTICE text file distributed\\n as part of the Derivative Works; within the Source form or\\n documentation, if provided along with the Derivative Works; or,\\n within a display generated by the Derivative Works, if and\\n wherever such third-party notices normally appear. The contents\\n of the NOTICE file are for informational purposes only and\\n do not modify the License. You may add Your own attribution\\n notices within Derivative Works that You distribute, alongside\\n or as an addendum to the NOTICE text from the Work, provided\\n that such additional attribution notices cannot be construed\\n as modifying the License.\\n\\n You may add Your own copyright statement to Your modifications and\\n may provide additional or different license terms and conditions\\n for use, reproduction, or distribution of Your modifications, or\\n for any such Derivative Works as a whole, provided Your use,\\n reproduction, and distribution of the Work otherwise complies with\\n the conditions stated in this License.\\n\\n 5. Submission of Contributions. Unless You explicitly state otherwise,\\n any Contribution intentionally submitted for inclusion in the Work\\n by You to the Licensor shall be under the terms and conditions of\\n this License, without any additional terms or conditions.\\n Notwithstanding the above, nothing herein shall supersede or modify\\n the terms of any separate license agreement you may have executed\\n with Licensor regarding such Contributions.\\n\\n 6. Trademarks. This License does not grant permission to use the trade\\n names, trademarks, service marks, or product names of the Licensor,\\n except as required for reasonable and customary use in describing the\\n origin of the Work and reproducing the content of the NOTICE file.\\n\\n 7. Disclaimer of Warranty. Unless required by applicable law or\\n agreed to in writing, Licensor provides the Work (and each\\n Contributor provides its Contributions) on an \\\"AS IS\\\" BASIS,\\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\\n implied, including, without limitation, any warranties or conditions\\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\\n PARTICULAR PURPOSE. You are solely responsible for determining the\\n appropriateness of using or redistributing the Work and assume any\\n risks associated with Your exercise of permissions under this License.\\n\\n 8. Limitation of Liability. In no event and under no legal theory,\\n whether in tort (including negligence), contract, or otherwise,\\n unless required by applicable law (such as deliberate and grossly\\n negligent acts) or agreed to in writing, shall any Contributor be\\n liable to You for damages, including any direct, indirect, special,\\n incidental, or consequential damages of any character arising as a\\n result of this License or out of the use or inability to use the\\n Work (including but not limited to damages for loss of goodwill,\\n work stoppage, computer failure or malfunction, or any and all\\n other commercial damages or losses), even if such Contributor\\n has been advised of the possibility of such damages.\\n\\n 9. Accepting Warranty or Additional Liability. While redistributing\\n the Work or Derivative Works thereof, You may choose to offer,\\n and charge a fee for, acceptance of support, warranty, indemnity,\\n or other liability obligations and/or rights consistent with this\\n License. However, in accepting such obligations, You may act only\\n on Your own behalf and on Your sole responsibility, not on behalf\\n of any other Contributor, and only if You agree to indemnify,\\n defend, and hold each Contributor harmless for any liability\\n incurred by, or claims asserted against, such Contributor by reason\\n of your accepting any such warranty or additional liability.\\n\\n END OF TERMS AND CONDITIONS\\n\\n APPENDIX: How to apply the Apache License to your work.\\n\\n To apply the Apache License to your work, attach the following\\n boilerplate notice, with the fields enclosed by brackets \\\"[]\\\"\\n replaced with your own identifying information. (Don't include\\n the brackets!) The text should be enclosed in the appropriate\\n comment syntax for the file format. We also recommend that a\\n file or class name and description of purpose be included on the\\n same \\\"printed page\\\" as the copyright notice for easier\\n identification within third-party archives.\\n\\n Copyright [yyyy] [name of copyright owner]\\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[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"BINDIR = $(PWD)/.state/env/bin\\n\\n.state/env/pyvenv.cfg: requirements/dev.txt\\n\\trm -rf .state/env\\n\\tpython -m venv .state/env\\n\\n\\t# install/upgrade general requirements\\n\\t$(BINDIR)/python -m pip install --upgrade pip setuptools wheel\\n\\n\\t# install various types of requirements\\n\\t$(BINDIR)/python -m pip install -r requirements/dev.txt\\n\\ntest: .state/env/pyvenv.cfg\\n\\t$(BINDIR)/python -m pip install .\\n\\t$(BINDIR)/pytest\\n\\t$(BINDIR)/python -m tests.lib\\n\\nlint: .state/env/pyvenv.cfg\\n\\t$(BINDIR)/black --check bin setup.py src tests\\n\\t$(BINDIR)/python bin/sort.py src/trove_classifiers/__init__.py\\n\\t$(BINDIR)/mypy src\\n\\nreformat: .state/env/pyvenv.cfg\\n\\t$(BINDIR)/black tests src\\n\\n.PHONY: build test lint reformat\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"setuptools\\\", \\\"calver\\\"]\\nbuild-backend = \\\"setuptools.build_meta\\\"\\n\\n[tool.mypy]\\nstrict = true\\nwarn_unreachable = true\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"include CONTRIBUTING.md\\ninclude Makefile\\nrecursive-include bin *.py\\nrecursive-include tests *.py\\nrecursive-include requirements *\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"3\"\n },\n {\n \"content\": \"Canonical source for [classifiers][1] on [PyPI][2].\\n\\nClassifiers [categorize projects][3] per [PEP 301][4]. Use this package to\\nvalidate classifiers in packages for PyPI upload or download.\\n\\n## Usage\\n\\nTo install [from PyPI][5]:\\n\\n```\\n$ pip install trove-classifiers\\n```\\n\\nThis package can be invoked as a module to print a list of classifiers:\\n\\n```\\n$ python -m trove_classifiers | grep -Ei pyramid\\nFramework :: Pyramid\\n```\\n\\nIn addition, this package's API is two importable objects:\\n\\n### Classifiers (`trove_classifiers.classifiers`)\\nA `set` containing classifiers (as strings). Useful for determining membership.\\n\\nExample - determine if a classifier is valid:\\n\\n```python\\n>>> from trove_classifiers import classifiers\\n>>> 'License :: OSI Approved' in classifiers\\nTrue\\n>>> 'Fuzzy :: Wuzzy :: Was :: A :: Bear' in classifiers\\nFalse\\n>>>\\n```\\n\\n### Deprecated classifiers (`trove_classifiers.deprecated_classifiers`)\\nA `dict`, mapping a deprecated classifier (string) to a list of classifiers\\nwhich replaces it (strings).\\n\\nExample - determine if a classifier is deprecated:\\n\\n```python\\n>>> from trove_classifiers import deprecated_classifiers\\n>>> 'License :: OSI Approved' in deprecated_classifiers\\nFalse\\n>>> 'Natural Language :: Ukranian' in deprecated_classifiers\\nTrue\\n>>> deprecated_classifiers[\\\"Natural Language :: Ukranian\\\"]\\n['Natural Language :: Ukrainian']\\n```\\n\\n[1]: https://pypi.org/classifiers/\\n[2]: https://pypi.org\\n[3]: https://packaging.python.org/specifications/core-metadata/#classifier-multiple-use\\n[4]: https://www.python.org/dev/peps/pep-0301/\\n[5]: https://pypi.org/project/trove-classifiers/\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"from io import open\\nfrom os import path\\n\\nfrom setuptools import setup, find_packages\\n\\nhere = path.abspath(path.dirname(__file__))\\n\\n# Get the long description from the README file\\nwith open(path.join(here, \\\"README.md\\\"), encoding=\\\"utf-8\\\") as f:\\n long_description = f.read()\\n\\nsetup(\\n name=\\\"trove-classifiers\\\",\\n description=\\\"Canonical source for classifiers on PyPI (pypi.org).\\\",\\n long_description=long_description,\\n long_description_content_type=\\\"text/markdown\\\",\\n url=\\\"https://github.com/pypa/trove-classifiers\\\",\\n author=\\\"The PyPI Admins\\\",\\n author_email=\\\"admin@pypi.org\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: Apache Software License\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Typing :: Typed\\\",\\n ],\\n keywords=\\\"classifiers\\\",\\n package_dir={\\\"\\\": \\\"src\\\"},\\n packages=find_packages(where=\\\"src\\\"),\\n package_data={\\\"\\\": [\\\"py.typed\\\"]},\\n use_calver=\\\"%Y.%m.%d.%H\\\",\\n setup_requires=[\\\"calver\\\"],\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# Contributing\\nHow to contributing to this package.\\n\\n## Running tests\\nRun `make test`. This checks whether the auto-generated list of classifiers\\nmatches the input source.\\n\\n## Running linting\\nRun `make lint`.\\n\\n## Adding a new classifier\\nTo add a new classifier, add to the `classifiers` set in\\n`trove_classifiers/__init__.py`.\\n\\n## Deprecating a classifier\\nTo deprecate a classifier, move it from `classifiers` to\\n`deprecated_classifiers` in `trove_classifiers/__init__.py`, and list any new\\nclassifiers that may replace it.\\n\\n[end of CONTRIBUTING.md]\",\n \"filename\": \"CONTRIBUTING.md\",\n \"id\": \"6\"\n },\n {\n \"content\": \"import ast\\nimport sys\\n\\nfrom natsort import natsorted\\n\\n\\ndef _test_sort(elements, _type):\\n values = [e.value for e in elements]\\n for wrong, right in zip(values, natsorted(values)):\\n if wrong != right:\\n print(f\\\"{_type} is not sorted, {right!r} should come before {wrong!r}\\\")\\n return True\\n return False\\n\\n\\nif len(sys.argv) == 1:\\n print(\\\"Usage: sort.py [filename]\\\")\\n sys.exit(1)\\n\\n\\nwith open(sys.argv[1]) as f:\\n contents = f.read()\\n\\nfail = False\\n\\nfor node in ast.walk(ast.parse(contents)):\\n if type(node) == ast.List:\\n fail = _test_sort(node.elts, \\\"List\\\") or fail\\n if type(node) == ast.Set:\\n fail = _test_sort(node.elts, \\\"Set\\\") or fail\\n if type(node) == ast.Dict:\\n fail = _test_sort(node.keys, \\\"Dict\\\") or fail\\n\\nsys.exit(fail)\\n\\n[end of bin/sort.py]\",\n \"filename\": \"bin/sort.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"black\\njinja2\\nnatsort\\npytest\\nmypy\\n\\n[end of requirements/dev.txt]\",\n \"filename\": \"requirements/dev.txt\",\n \"id\": \"8\"\n },\n {\n \"content\": \"from typing import Dict, List, Set\\n\\n# A set of classifier names\\nsorted_classifiers: List[str] = [\\n \\\"Development Status :: 1 - Planning\\\",\\n \\\"Development Status :: 2 - Pre-Alpha\\\",\\n \\\"Development Status :: 3 - Alpha\\\",\\n \\\"Development Status :: 4 - Beta\\\",\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Development Status :: 6 - Mature\\\",\\n \\\"Development Status :: 7 - Inactive\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Environment :: Console :: Curses\\\",\\n \\\"Environment :: Console :: Framebuffer\\\",\\n \\\"Environment :: Console :: Newt\\\",\\n \\\"Environment :: Console :: svgalib\\\",\\n \\\"Environment :: GPU\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 1.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 1.1\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 2.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 2.1\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 2.2\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 2.3\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 3.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 3.1\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 3.2\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 4.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 4.1\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 4.2\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 5.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 5.5\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 6.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 6.5\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 7.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 7.5\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 8.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 9.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 9.1\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 9.2\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 10.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 10.1\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 10.2\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.1\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.2\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.3\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.4\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.5\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.6\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.7\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 11.8\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 12\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.0\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.1\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.2\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.3\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.4\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.5\\\",\\n \\\"Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.6\\\",\\n \\\"Environment :: Handhelds/PDA's\\\",\\n \\\"Environment :: MacOS X\\\",\\n \\\"Environment :: MacOS X :: Aqua\\\",\\n \\\"Environment :: MacOS X :: Carbon\\\",\\n \\\"Environment :: MacOS X :: Cocoa\\\",\\n \\\"Environment :: No Input/Output (Daemon)\\\",\\n \\\"Environment :: OpenStack\\\",\\n \\\"Environment :: Other Environment\\\",\\n \\\"Environment :: Plugins\\\",\\n \\\"Environment :: Web Environment\\\",\\n \\\"Environment :: Web Environment :: Buffet\\\",\\n \\\"Environment :: Web Environment :: Mozilla\\\",\\n \\\"Environment :: Web Environment :: ToscaWidgets\\\",\\n \\\"Environment :: WebAssembly\\\",\\n \\\"Environment :: WebAssembly :: Emscripten\\\",\\n \\\"Environment :: WebAssembly :: WASI\\\",\\n \\\"Environment :: Win32 (MS Windows)\\\",\\n \\\"Environment :: X11 Applications\\\",\\n \\\"Environment :: X11 Applications :: GTK\\\",\\n \\\"Environment :: X11 Applications :: Gnome\\\",\\n \\\"Environment :: X11 Applications :: KDE\\\",\\n \\\"Environment :: X11 Applications :: Qt\\\",\\n \\\"Framework :: AWS CDK\\\",\\n \\\"Framework :: AWS CDK :: 1\\\",\\n \\\"Framework :: AWS CDK :: 2\\\",\\n \\\"Framework :: AiiDA\\\",\\n \\\"Framework :: Ansible\\\",\\n \\\"Framework :: AnyIO\\\",\\n \\\"Framework :: Apache Airflow\\\",\\n \\\"Framework :: Apache Airflow :: Provider\\\",\\n \\\"Framework :: AsyncIO\\\",\\n \\\"Framework :: BEAT\\\",\\n \\\"Framework :: BFG\\\",\\n \\\"Framework :: Bob\\\",\\n \\\"Framework :: Bottle\\\",\\n \\\"Framework :: Buildout\\\",\\n \\\"Framework :: Buildout :: Extension\\\",\\n \\\"Framework :: Buildout :: Recipe\\\",\\n \\\"Framework :: CastleCMS\\\",\\n \\\"Framework :: CastleCMS :: Theme\\\",\\n \\\"Framework :: Celery\\\",\\n \\\"Framework :: Chandler\\\",\\n \\\"Framework :: CherryPy\\\",\\n \\\"Framework :: CubicWeb\\\",\\n \\\"Framework :: Dash\\\",\\n \\\"Framework :: Datasette\\\",\\n \\\"Framework :: Django\\\",\\n \\\"Framework :: Django :: 1\\\",\\n \\\"Framework :: Django :: 1.4\\\",\\n \\\"Framework :: Django :: 1.5\\\",\\n \\\"Framework :: Django :: 1.6\\\",\\n \\\"Framework :: Django :: 1.7\\\",\\n \\\"Framework :: Django :: 1.8\\\",\\n \\\"Framework :: Django :: 1.9\\\",\\n \\\"Framework :: Django :: 1.10\\\",\\n \\\"Framework :: Django :: 1.11\\\",\\n \\\"Framework :: Django :: 2\\\",\\n \\\"Framework :: Django :: 2.0\\\",\\n \\\"Framework :: Django :: 2.1\\\",\\n \\\"Framework :: Django :: 2.2\\\",\\n \\\"Framework :: Django :: 3\\\",\\n \\\"Framework :: Django :: 3.0\\\",\\n \\\"Framework :: Django :: 3.1\\\",\\n \\\"Framework :: Django :: 3.2\\\",\\n \\\"Framework :: Django :: 4\\\",\\n \\\"Framework :: Django :: 4.0\\\",\\n \\\"Framework :: Django :: 4.1\\\",\\n \\\"Framework :: Django :: 4.2\\\",\\n \\\"Framework :: Django :: 5\\\",\\n \\\"Framework :: Django :: 5.0\\\",\\n \\\"Framework :: Django :: 5.1\\\",\\n \\\"Framework :: Django :: 5.2\\\",\\n \\\"Framework :: Django CMS\\\",\\n \\\"Framework :: Django CMS :: 3.4\\\",\\n \\\"Framework :: Django CMS :: 3.5\\\",\\n \\\"Framework :: Django CMS :: 3.6\\\",\\n \\\"Framework :: Django CMS :: 3.7\\\",\\n \\\"Framework :: Django CMS :: 3.8\\\",\\n \\\"Framework :: Django CMS :: 3.9\\\",\\n \\\"Framework :: Django CMS :: 3.10\\\",\\n \\\"Framework :: Django CMS :: 3.11\\\",\\n \\\"Framework :: Django CMS :: 4.0\\\",\\n \\\"Framework :: Django CMS :: 4.1\\\",\\n \\\"Framework :: Django CMS :: 5.0\\\",\\n \\\"Framework :: FastAPI\\\",\\n \\\"Framework :: Flake8\\\",\\n \\\"Framework :: Flask\\\",\\n \\\"Framework :: Hatch\\\",\\n \\\"Framework :: Hypothesis\\\",\\n \\\"Framework :: IDLE\\\",\\n \\\"Framework :: IPython\\\",\\n \\\"Framework :: Jupyter\\\",\\n \\\"Framework :: Jupyter :: JupyterLab\\\",\\n \\\"Framework :: Jupyter :: JupyterLab :: 1\\\",\\n \\\"Framework :: Jupyter :: JupyterLab :: 2\\\",\\n \\\"Framework :: Jupyter :: JupyterLab :: 3\\\",\\n \\\"Framework :: Jupyter :: JupyterLab :: 4\\\",\\n \\\"Framework :: Jupyter :: JupyterLab :: Extensions\\\",\\n \\\"Framework :: Jupyter :: JupyterLab :: Extensions :: Mime Renderers\\\",\\n \\\"Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt\\\",\\n \\\"Framework :: Jupyter :: JupyterLab :: Extensions :: Themes\\\",\\n \\\"Framework :: Kedro\\\",\\n \\\"Framework :: Lektor\\\",\\n \\\"Framework :: Masonite\\\",\\n \\\"Framework :: Matplotlib\\\",\\n \\\"Framework :: MkDocs\\\",\\n \\\"Framework :: Nengo\\\",\\n \\\"Framework :: Odoo\\\",\\n \\\"Framework :: Odoo :: 8.0\\\",\\n \\\"Framework :: Odoo :: 9.0\\\",\\n \\\"Framework :: Odoo :: 10.0\\\",\\n \\\"Framework :: Odoo :: 11.0\\\",\\n \\\"Framework :: Odoo :: 12.0\\\",\\n \\\"Framework :: Odoo :: 13.0\\\",\\n \\\"Framework :: Odoo :: 14.0\\\",\\n \\\"Framework :: Odoo :: 15.0\\\",\\n \\\"Framework :: Odoo :: 16.0\\\",\\n \\\"Framework :: Odoo :: 17.0\\\",\\n \\\"Framework :: Odoo :: 18.0\\\",\\n \\\"Framework :: OpenTelemetry\\\",\\n \\\"Framework :: OpenTelemetry :: Distros\\\",\\n \\\"Framework :: OpenTelemetry :: Exporters\\\",\\n \\\"Framework :: OpenTelemetry :: Instrumentations\\\",\\n \\\"Framework :: Opps\\\",\\n \\\"Framework :: Paste\\\",\\n \\\"Framework :: Pelican\\\",\\n \\\"Framework :: Pelican :: Plugins\\\",\\n \\\"Framework :: Pelican :: Themes\\\",\\n \\\"Framework :: Plone\\\",\\n \\\"Framework :: Plone :: 3.2\\\",\\n \\\"Framework :: Plone :: 3.3\\\",\\n \\\"Framework :: Plone :: 4.0\\\",\\n \\\"Framework :: Plone :: 4.1\\\",\\n \\\"Framework :: Plone :: 4.2\\\",\\n \\\"Framework :: Plone :: 4.3\\\",\\n \\\"Framework :: Plone :: 5.0\\\",\\n \\\"Framework :: Plone :: 5.1\\\",\\n \\\"Framework :: Plone :: 5.2\\\",\\n \\\"Framework :: Plone :: 5.3\\\",\\n \\\"Framework :: Plone :: 6.0\\\",\\n \\\"Framework :: Plone :: 6.1\\\",\\n \\\"Framework :: Plone :: 6.2\\\",\\n \\\"Framework :: Plone :: Addon\\\",\\n \\\"Framework :: Plone :: Core\\\",\\n \\\"Framework :: Plone :: Distribution\\\",\\n \\\"Framework :: Plone :: Theme\\\",\\n \\\"Framework :: PySimpleGUI\\\",\\n \\\"Framework :: PySimpleGUI :: 4\\\",\\n \\\"Framework :: PySimpleGUI :: 5\\\",\\n \\\"Framework :: Pycsou\\\",\\n \\\"Framework :: Pydantic\\\",\\n \\\"Framework :: Pydantic :: 1\\\",\\n \\\"Framework :: Pydantic :: 2\\\",\\n \\\"Framework :: Pylons\\\",\\n \\\"Framework :: Pyodide\\\",\\n \\\"Framework :: Pyramid\\\",\\n \\\"Framework :: Pytest\\\",\\n \\\"Framework :: Review Board\\\",\\n \\\"Framework :: Robot Framework\\\",\\n \\\"Framework :: Robot Framework :: Library\\\",\\n \\\"Framework :: Robot Framework :: Tool\\\",\\n \\\"Framework :: Scrapy\\\",\\n \\\"Framework :: Setuptools Plugin\\\",\\n \\\"Framework :: Sphinx\\\",\\n \\\"Framework :: Sphinx :: Domain\\\",\\n \\\"Framework :: Sphinx :: Extension\\\",\\n \\\"Framework :: Sphinx :: Theme\\\",\\n \\\"Framework :: Trac\\\",\\n \\\"Framework :: Trio\\\",\\n \\\"Framework :: Tryton\\\",\\n \\\"Framework :: TurboGears\\\",\\n \\\"Framework :: TurboGears :: Applications\\\",\\n \\\"Framework :: TurboGears :: Widgets\\\",\\n \\\"Framework :: Twisted\\\",\\n \\\"Framework :: Wagtail\\\",\\n \\\"Framework :: Wagtail :: 1\\\",\\n \\\"Framework :: Wagtail :: 2\\\",\\n \\\"Framework :: Wagtail :: 3\\\",\\n \\\"Framework :: Wagtail :: 4\\\",\\n \\\"Framework :: Wagtail :: 5\\\",\\n \\\"Framework :: Wagtail :: 6\\\",\\n \\\"Framework :: ZODB\\\",\\n \\\"Framework :: Zope\\\",\\n \\\"Framework :: Zope2\\\",\\n \\\"Framework :: Zope3\\\",\\n \\\"Framework :: Zope :: 2\\\",\\n \\\"Framework :: Zope :: 3\\\",\\n \\\"Framework :: Zope :: 4\\\",\\n \\\"Framework :: Zope :: 5\\\",\\n \\\"Framework :: aiohttp\\\",\\n \\\"Framework :: cocotb\\\",\\n \\\"Framework :: napari\\\",\\n \\\"Framework :: tox\\\",\\n \\\"Intended Audience :: Customer Service\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: Education\\\",\\n \\\"Intended Audience :: End Users/Desktop\\\",\\n \\\"Intended Audience :: Financial and Insurance Industry\\\",\\n \\\"Intended Audience :: Healthcare Industry\\\",\\n \\\"Intended Audience :: Information Technology\\\",\\n \\\"Intended Audience :: Legal Industry\\\",\\n \\\"Intended Audience :: Manufacturing\\\",\\n \\\"Intended Audience :: Other Audience\\\",\\n \\\"Intended Audience :: Religion\\\",\\n \\\"Intended Audience :: Science/Research\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"Intended Audience :: Telecommunications Industry\\\",\\n \\\"License :: Aladdin Free Public License (AFPL)\\\",\\n \\\"License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication\\\",\\n \\\"License :: CeCILL-B Free Software License Agreement (CECILL-B)\\\",\\n \\\"License :: CeCILL-C Free Software License Agreement (CECILL-C)\\\",\\n \\\"License :: DFSG approved\\\",\\n \\\"License :: Eiffel Forum License (EFL)\\\",\\n \\\"License :: Free For Educational Use\\\",\\n \\\"License :: Free For Home Use\\\",\\n \\\"License :: Free To Use But Restricted\\\",\\n \\\"License :: Free for non-commercial use\\\",\\n \\\"License :: Freely Distributable\\\",\\n \\\"License :: Freeware\\\",\\n \\\"License :: GUST Font License 1.0\\\",\\n \\\"License :: GUST Font License 2006-09-30\\\",\\n \\\"License :: Netscape Public License (NPL)\\\",\\n \\\"License :: Nokia Open Source License (NOKOS)\\\",\\n \\\"License :: OSI Approved\\\",\\n \\\"License :: OSI Approved :: Academic Free License (AFL)\\\",\\n \\\"License :: OSI Approved :: Apache Software License\\\",\\n \\\"License :: OSI Approved :: Apple Public Source License\\\",\\n \\\"License :: OSI Approved :: Artistic License\\\",\\n \\\"License :: OSI Approved :: Attribution Assurance License\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"License :: OSI Approved :: Blue Oak Model License (BlueOak-1.0.0)\\\",\\n \\\"License :: OSI Approved :: Boost Software License 1.0 (BSL-1.0)\\\",\\n \\\"License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)\\\",\\n \\\"License :: OSI Approved :: CMU License (MIT-CMU)\\\",\\n \\\"License :: OSI Approved :: Common Development and Distribution License 1.0 (CDDL-1.0)\\\",\\n \\\"License :: OSI Approved :: Common Public License\\\",\\n \\\"License :: OSI Approved :: Eclipse Public License 1.0 (EPL-1.0)\\\",\\n \\\"License :: OSI Approved :: Eclipse Public License 2.0 (EPL-2.0)\\\",\\n \\\"License :: OSI Approved :: Educational Community License, Version 2.0 (ECL-2.0)\\\",\\n \\\"License :: OSI Approved :: Eiffel Forum License\\\",\\n \\\"License :: OSI Approved :: European Union Public Licence 1.0 (EUPL 1.0)\\\",\\n \\\"License :: OSI Approved :: European Union Public Licence 1.1 (EUPL 1.1)\\\",\\n \\\"License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)\\\",\\n \\\"License :: OSI Approved :: GNU Affero General Public License v3\\\",\\n \\\"License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)\\\",\\n \\\"License :: OSI Approved :: GNU Free Documentation License (FDL)\\\",\\n \\\"License :: OSI Approved :: GNU General Public License (GPL)\\\",\\n \\\"License :: OSI Approved :: GNU General Public License v2 (GPLv2)\\\",\\n \\\"License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)\\\",\\n \\\"License :: OSI Approved :: GNU General Public License v3 (GPLv3)\\\",\\n \\\"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)\\\",\\n \\\"License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)\\\",\\n \\\"License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)\\\",\\n \\\"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)\\\",\\n \\\"License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)\\\",\\n \\\"License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)\\\",\\n \\\"License :: OSI Approved :: Historical Permission Notice and Disclaimer (HPND)\\\",\\n \\\"License :: OSI Approved :: IBM Public License\\\",\\n \\\"License :: OSI Approved :: ISC License (ISCL)\\\",\\n \\\"License :: OSI Approved :: MIT License\\\",\\n \\\"License :: OSI Approved :: MIT No Attribution License (MIT-0)\\\",\\n \\\"License :: OSI Approved :: MirOS License (MirOS)\\\",\\n \\\"License :: OSI Approved :: Motosoto License\\\",\\n \\\"License :: OSI Approved :: Mozilla Public License 1.0 (MPL)\\\",\\n \\\"License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)\\\",\\n \\\"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)\\\",\\n \\\"License :: OSI Approved :: Mulan Permissive Software License v2 (MulanPSL-2.0)\\\",\\n \\\"License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)\\\",\\n \\\"License :: OSI Approved :: Nethack General Public License\\\",\\n \\\"License :: OSI Approved :: Nokia Open Source License\\\",\\n \\\"License :: OSI Approved :: Open Group Test Suite License\\\",\\n \\\"License :: OSI Approved :: Open Software License 3.0 (OSL-3.0)\\\",\\n \\\"License :: OSI Approved :: PostgreSQL License\\\",\\n \\\"License :: OSI Approved :: Python License (CNRI Python License)\\\",\\n \\\"License :: OSI Approved :: Python Software Foundation License\\\",\\n \\\"License :: OSI Approved :: Qt Public License (QPL)\\\",\\n \\\"License :: OSI Approved :: Ricoh Source Code Public License\\\",\\n \\\"License :: OSI Approved :: SIL Open Font License 1.1 (OFL-1.1)\\\",\\n \\\"License :: OSI Approved :: Sleepycat License\\\",\\n \\\"License :: OSI Approved :: Sun Public License\\\",\\n \\\"License :: OSI Approved :: The Unlicense (Unlicense)\\\",\\n \\\"License :: OSI Approved :: Universal Permissive License (UPL)\\\",\\n \\\"License :: OSI Approved :: University of Illinois/NCSA Open Source License\\\",\\n \\\"License :: OSI Approved :: Vovida Software License 1.0\\\",\\n \\\"License :: OSI Approved :: W3C License\\\",\\n \\\"License :: OSI Approved :: Zero-Clause BSD (0BSD)\\\",\\n \\\"License :: OSI Approved :: Zope Public License\\\",\\n \\\"License :: OSI Approved :: zlib/libpng License\\\",\\n \\\"License :: Other/Proprietary License\\\",\\n \\\"License :: Public Domain\\\",\\n \\\"License :: Repoze Public License\\\",\\n \\\"Natural Language :: Afrikaans\\\",\\n \\\"Natural Language :: Arabic\\\",\\n \\\"Natural Language :: Basque\\\",\\n \\\"Natural Language :: Bengali\\\",\\n \\\"Natural Language :: Bosnian\\\",\\n \\\"Natural Language :: Bulgarian\\\",\\n \\\"Natural Language :: Cantonese\\\",\\n \\\"Natural Language :: Catalan\\\",\\n \\\"Natural Language :: Catalan (Valencian)\\\",\\n \\\"Natural Language :: Chinese (Simplified)\\\",\\n \\\"Natural Language :: Chinese (Traditional)\\\",\\n \\\"Natural Language :: Croatian\\\",\\n \\\"Natural Language :: Czech\\\",\\n \\\"Natural Language :: Danish\\\",\\n \\\"Natural Language :: Dutch\\\",\\n \\\"Natural Language :: English\\\",\\n \\\"Natural Language :: Esperanto\\\",\\n \\\"Natural Language :: Finnish\\\",\\n \\\"Natural Language :: French\\\",\\n \\\"Natural Language :: Galician\\\",\\n \\\"Natural Language :: Georgian\\\",\\n \\\"Natural Language :: German\\\",\\n \\\"Natural Language :: Greek\\\",\\n \\\"Natural Language :: Hebrew\\\",\\n \\\"Natural Language :: Hindi\\\",\\n \\\"Natural Language :: Hungarian\\\",\\n \\\"Natural Language :: Icelandic\\\",\\n \\\"Natural Language :: Indonesian\\\",\\n \\\"Natural Language :: Irish\\\",\\n \\\"Natural Language :: Italian\\\",\\n \\\"Natural Language :: Japanese\\\",\\n \\\"Natural Language :: Javanese\\\",\\n \\\"Natural Language :: Korean\\\",\\n \\\"Natural Language :: Latin\\\",\\n \\\"Natural Language :: Latvian\\\",\\n \\\"Natural Language :: Lithuanian\\\",\\n \\\"Natural Language :: Macedonian\\\",\\n \\\"Natural Language :: Malay\\\",\\n \\\"Natural Language :: Marathi\\\",\\n \\\"Natural Language :: Nepali\\\",\\n \\\"Natural Language :: Norwegian\\\",\\n \\\"Natural Language :: Panjabi\\\",\\n \\\"Natural Language :: Persian\\\",\\n \\\"Natural Language :: Polish\\\",\\n \\\"Natural Language :: Portuguese\\\",\\n \\\"Natural Language :: Portuguese (Brazilian)\\\",\\n \\\"Natural Language :: Romanian\\\",\\n \\\"Natural Language :: Russian\\\",\\n \\\"Natural Language :: Serbian\\\",\\n \\\"Natural Language :: Slovak\\\",\\n \\\"Natural Language :: Slovenian\\\",\\n \\\"Natural Language :: Spanish\\\",\\n \\\"Natural Language :: Swedish\\\",\\n \\\"Natural Language :: Tamil\\\",\\n \\\"Natural Language :: Telugu\\\",\\n \\\"Natural Language :: Thai\\\",\\n \\\"Natural Language :: Tibetan\\\",\\n \\\"Natural Language :: Turkish\\\",\\n \\\"Natural Language :: Ukrainian\\\",\\n \\\"Natural Language :: Urdu\\\",\\n \\\"Natural Language :: Vietnamese\\\",\\n \\\"Operating System :: Android\\\",\\n \\\"Operating System :: BeOS\\\",\\n \\\"Operating System :: MacOS\\\",\\n \\\"Operating System :: MacOS :: MacOS 9\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Operating System :: Microsoft\\\",\\n \\\"Operating System :: Microsoft :: MS-DOS\\\",\\n \\\"Operating System :: Microsoft :: Windows\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows 3.1 or Earlier\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows 7\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows 8\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows 8.1\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows 10\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows 11\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows 95/98/2000\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows CE\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows NT/2000\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows Server 2003\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows Server 2008\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows Vista\\\",\\n \\\"Operating System :: Microsoft :: Windows :: Windows XP\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Operating System :: OS/2\\\",\\n \\\"Operating System :: Other OS\\\",\\n \\\"Operating System :: PDA Systems\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: POSIX :: AIX\\\",\\n \\\"Operating System :: POSIX :: BSD\\\",\\n \\\"Operating System :: POSIX :: BSD :: BSD/OS\\\",\\n \\\"Operating System :: POSIX :: BSD :: FreeBSD\\\",\\n \\\"Operating System :: POSIX :: BSD :: NetBSD\\\",\\n \\\"Operating System :: POSIX :: BSD :: OpenBSD\\\",\\n \\\"Operating System :: POSIX :: GNU Hurd\\\",\\n \\\"Operating System :: POSIX :: HP-UX\\\",\\n \\\"Operating System :: POSIX :: IRIX\\\",\\n \\\"Operating System :: POSIX :: Linux\\\",\\n \\\"Operating System :: POSIX :: Other\\\",\\n \\\"Operating System :: POSIX :: SCO\\\",\\n \\\"Operating System :: POSIX :: SunOS/Solaris\\\",\\n \\\"Operating System :: PalmOS\\\",\\n \\\"Operating System :: RISC OS\\\",\\n \\\"Operating System :: Unix\\\",\\n \\\"Operating System :: iOS\\\",\\n \\\"Programming Language :: APL\\\",\\n \\\"Programming Language :: ASP\\\",\\n \\\"Programming Language :: Ada\\\",\\n \\\"Programming Language :: Assembly\\\",\\n \\\"Programming Language :: Awk\\\",\\n \\\"Programming Language :: Basic\\\",\\n \\\"Programming Language :: C\\\",\\n \\\"Programming Language :: C#\\\",\\n \\\"Programming Language :: C++\\\",\\n \\\"Programming Language :: Cold Fusion\\\",\\n \\\"Programming Language :: Cython\\\",\\n \\\"Programming Language :: D\\\",\\n \\\"Programming Language :: Delphi/Kylix\\\",\\n \\\"Programming Language :: Dylan\\\",\\n \\\"Programming Language :: Eiffel\\\",\\n \\\"Programming Language :: Emacs-Lisp\\\",\\n \\\"Programming Language :: Erlang\\\",\\n \\\"Programming Language :: Euler\\\",\\n \\\"Programming Language :: Euphoria\\\",\\n \\\"Programming Language :: F#\\\",\\n \\\"Programming Language :: Forth\\\",\\n \\\"Programming Language :: Fortran\\\",\\n \\\"Programming Language :: Go\\\",\\n \\\"Programming Language :: Haskell\\\",\\n \\\"Programming Language :: Hy\\\",\\n \\\"Programming Language :: Java\\\",\\n \\\"Programming Language :: JavaScript\\\",\\n \\\"Programming Language :: Kotlin\\\",\\n \\\"Programming Language :: Lisp\\\",\\n \\\"Programming Language :: Logo\\\",\\n \\\"Programming Language :: Lua\\\",\\n \\\"Programming Language :: ML\\\",\\n \\\"Programming Language :: Modula\\\",\\n \\\"Programming Language :: OCaml\\\",\\n \\\"Programming Language :: Object Pascal\\\",\\n \\\"Programming Language :: Objective C\\\",\\n \\\"Programming Language :: Other\\\",\\n \\\"Programming Language :: Other Scripting Engines\\\",\\n \\\"Programming Language :: PHP\\\",\\n \\\"Programming Language :: PL/SQL\\\",\\n \\\"Programming Language :: PROGRESS\\\",\\n \\\"Programming Language :: Pascal\\\",\\n \\\"Programming Language :: Perl\\\",\\n \\\"Programming Language :: Pike\\\",\\n \\\"Programming Language :: Pliant\\\",\\n \\\"Programming Language :: Prolog\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 2\\\",\\n \\\"Programming Language :: Python :: 2 :: Only\\\",\\n \\\"Programming Language :: Python :: 2.3\\\",\\n \\\"Programming Language :: Python :: 2.4\\\",\\n \\\"Programming Language :: Python :: 2.5\\\",\\n \\\"Programming Language :: Python :: 2.6\\\",\\n \\\"Programming Language :: Python :: 2.7\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3 :: Only\\\",\\n \\\"Programming Language :: Python :: 3.0\\\",\\n \\\"Programming Language :: Python :: 3.1\\\",\\n \\\"Programming Language :: Python :: 3.2\\\",\\n \\\"Programming Language :: Python :: 3.3\\\",\\n \\\"Programming Language :: Python :: 3.4\\\",\\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 :: 3.9\\\",\\n \\\"Programming Language :: Python :: 3.10\\\",\\n \\\"Programming Language :: Python :: 3.11\\\",\\n \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: 3.14\\\",\\n \\\"Programming Language :: Python :: Implementation\\\",\\n \\\"Programming Language :: Python :: Implementation :: CPython\\\",\\n \\\"Programming Language :: Python :: Implementation :: IronPython\\\",\\n \\\"Programming Language :: Python :: Implementation :: Jython\\\",\\n \\\"Programming Language :: Python :: Implementation :: MicroPython\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Programming Language :: Python :: Implementation :: Stackless\\\",\\n \\\"Programming Language :: R\\\",\\n \\\"Programming Language :: REBOL\\\",\\n \\\"Programming Language :: Rexx\\\",\\n \\\"Programming Language :: Ruby\\\",\\n \\\"Programming Language :: Rust\\\",\\n \\\"Programming Language :: SQL\\\",\\n \\\"Programming Language :: Scheme\\\",\\n \\\"Programming Language :: Simula\\\",\\n \\\"Programming Language :: Smalltalk\\\",\\n \\\"Programming Language :: Tcl\\\",\\n \\\"Programming Language :: Unix Shell\\\",\\n \\\"Programming Language :: Visual Basic\\\",\\n \\\"Programming Language :: XBasic\\\",\\n \\\"Programming Language :: YACC\\\",\\n \\\"Programming Language :: Zope\\\",\\n \\\"Topic :: Adaptive Technologies\\\",\\n \\\"Topic :: Artistic Software\\\",\\n \\\"Topic :: Communications\\\",\\n \\\"Topic :: Communications :: BBS\\\",\\n \\\"Topic :: Communications :: Chat\\\",\\n \\\"Topic :: Communications :: Chat :: ICQ\\\",\\n \\\"Topic :: Communications :: Chat :: Internet Relay Chat\\\",\\n \\\"Topic :: Communications :: Chat :: Unix Talk\\\",\\n \\\"Topic :: Communications :: Conferencing\\\",\\n \\\"Topic :: Communications :: Email\\\",\\n \\\"Topic :: Communications :: Email :: Address Book\\\",\\n \\\"Topic :: Communications :: Email :: Email Clients (MUA)\\\",\\n \\\"Topic :: Communications :: Email :: Filters\\\",\\n \\\"Topic :: Communications :: Email :: Mail Transport Agents\\\",\\n \\\"Topic :: Communications :: Email :: Mailing List Servers\\\",\\n \\\"Topic :: Communications :: Email :: Post-Office\\\",\\n \\\"Topic :: Communications :: Email :: Post-Office :: IMAP\\\",\\n \\\"Topic :: Communications :: Email :: Post-Office :: POP3\\\",\\n \\\"Topic :: Communications :: FIDO\\\",\\n \\\"Topic :: Communications :: Fax\\\",\\n \\\"Topic :: Communications :: File Sharing\\\",\\n \\\"Topic :: Communications :: File Sharing :: Gnutella\\\",\\n \\\"Topic :: Communications :: File Sharing :: Napster\\\",\\n \\\"Topic :: Communications :: Ham Radio\\\",\\n \\\"Topic :: Communications :: Internet Phone\\\",\\n \\\"Topic :: Communications :: Telephony\\\",\\n \\\"Topic :: Communications :: Usenet News\\\",\\n \\\"Topic :: Database\\\",\\n \\\"Topic :: Database :: Database Engines/Servers\\\",\\n \\\"Topic :: Database :: Front-Ends\\\",\\n \\\"Topic :: Desktop Environment\\\",\\n \\\"Topic :: Desktop Environment :: File Managers\\\",\\n \\\"Topic :: Desktop Environment :: GNUstep\\\",\\n \\\"Topic :: Desktop Environment :: Gnome\\\",\\n \\\"Topic :: Desktop Environment :: K Desktop Environment (KDE)\\\",\\n \\\"Topic :: Desktop Environment :: K Desktop Environment (KDE) :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: PicoGUI\\\",\\n \\\"Topic :: Desktop Environment :: PicoGUI :: Applications\\\",\\n \\\"Topic :: Desktop Environment :: PicoGUI :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Screen Savers\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Afterstep\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Afterstep :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Applets\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Blackbox\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Blackbox :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: CTWM\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: CTWM :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Enlightenment\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Enlightenment :: Epplets\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Enlightenment :: Themes DR15\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Enlightenment :: Themes DR16\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Enlightenment :: Themes DR17\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: FVWM\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: FVWM :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Fluxbox\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Fluxbox :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: IceWM\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: IceWM :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: MetaCity\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: MetaCity :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Oroborus\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Oroborus :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Sawfish\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Sawfish :: Themes 0.30\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Sawfish :: Themes pre-0.30\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Waimea\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Waimea :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Window Maker\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Window Maker :: Applets\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: Window Maker :: Themes\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: XFCE\\\",\\n \\\"Topic :: Desktop Environment :: Window Managers :: XFCE :: Themes\\\",\\n \\\"Topic :: Documentation\\\",\\n \\\"Topic :: Documentation :: Sphinx\\\",\\n \\\"Topic :: Education\\\",\\n \\\"Topic :: Education :: Computer Aided Instruction (CAI)\\\",\\n \\\"Topic :: Education :: Testing\\\",\\n \\\"Topic :: File Formats\\\",\\n \\\"Topic :: File Formats :: JSON\\\",\\n \\\"Topic :: File Formats :: JSON :: JSON Schema\\\",\\n \\\"Topic :: Games/Entertainment\\\",\\n \\\"Topic :: Games/Entertainment :: Arcade\\\",\\n \\\"Topic :: Games/Entertainment :: Board Games\\\",\\n \\\"Topic :: Games/Entertainment :: First Person Shooters\\\",\\n \\\"Topic :: Games/Entertainment :: Fortune Cookies\\\",\\n \\\"Topic :: Games/Entertainment :: Multi-User Dungeons (MUD)\\\",\\n \\\"Topic :: Games/Entertainment :: Puzzle Games\\\",\\n \\\"Topic :: Games/Entertainment :: Real Time Strategy\\\",\\n \\\"Topic :: Games/Entertainment :: Role-Playing\\\",\\n \\\"Topic :: Games/Entertainment :: Side-Scrolling/Arcade Games\\\",\\n \\\"Topic :: Games/Entertainment :: Simulation\\\",\\n \\\"Topic :: Games/Entertainment :: Turn Based Strategy\\\",\\n \\\"Topic :: Home Automation\\\",\\n \\\"Topic :: Internet\\\",\\n \\\"Topic :: Internet :: File Transfer Protocol (FTP)\\\",\\n \\\"Topic :: Internet :: Finger\\\",\\n \\\"Topic :: Internet :: Log Analysis\\\",\\n \\\"Topic :: Internet :: Name Service (DNS)\\\",\\n \\\"Topic :: Internet :: Proxy Servers\\\",\\n \\\"Topic :: Internet :: WAP\\\",\\n \\\"Topic :: Internet :: WWW/HTTP\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Browsers\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Dynamic Content\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Message Boards\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: News/Diary\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Page Counters\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: HTTP Servers\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Indexing/Search\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Session\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Site Management\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: Site Management :: Link Checking\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: WSGI\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: WSGI :: Application\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware\\\",\\n \\\"Topic :: Internet :: WWW/HTTP :: WSGI :: Server\\\",\\n \\\"Topic :: Internet :: XMPP\\\",\\n \\\"Topic :: Internet :: Z39.50\\\",\\n \\\"Topic :: Multimedia\\\",\\n \\\"Topic :: Multimedia :: Graphics\\\",\\n \\\"Topic :: Multimedia :: Graphics :: 3D Modeling\\\",\\n \\\"Topic :: Multimedia :: Graphics :: 3D Rendering\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Capture\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Capture :: Digital Camera\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Capture :: Scanners\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Capture :: Screen Capture\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Editors\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Editors :: Raster-Based\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Editors :: Vector-Based\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Graphics Conversion\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Presentation\\\",\\n \\\"Topic :: Multimedia :: Graphics :: Viewers\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Analysis\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: CD Audio\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: CD Audio :: CD Playing\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: CD Audio :: CD Ripping\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: CD Audio :: CD Writing\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Capture/Recording\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Conversion\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Editors\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: MIDI\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Mixers\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Players\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Players :: MP3\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Sound Synthesis\\\",\\n \\\"Topic :: Multimedia :: Sound/Audio :: Speech\\\",\\n \\\"Topic :: Multimedia :: Video\\\",\\n \\\"Topic :: Multimedia :: Video :: Capture\\\",\\n \\\"Topic :: Multimedia :: Video :: Conversion\\\",\\n \\\"Topic :: Multimedia :: Video :: Display\\\",\\n \\\"Topic :: Multimedia :: Video :: Non-Linear Editor\\\",\\n \\\"Topic :: Office/Business\\\",\\n \\\"Topic :: Office/Business :: Financial\\\",\\n \\\"Topic :: Office/Business :: Financial :: Accounting\\\",\\n \\\"Topic :: Office/Business :: Financial :: Investment\\\",\\n \\\"Topic :: Office/Business :: Financial :: Point-Of-Sale\\\",\\n \\\"Topic :: Office/Business :: Financial :: Spreadsheet\\\",\\n \\\"Topic :: Office/Business :: Groupware\\\",\\n \\\"Topic :: Office/Business :: News/Diary\\\",\\n \\\"Topic :: Office/Business :: Office Suites\\\",\\n \\\"Topic :: Office/Business :: Scheduling\\\",\\n \\\"Topic :: Other/Nonlisted Topic\\\",\\n \\\"Topic :: Printing\\\",\\n \\\"Topic :: Religion\\\",\\n \\\"Topic :: Scientific/Engineering\\\",\\n \\\"Topic :: Scientific/Engineering :: Artificial Intelligence\\\",\\n \\\"Topic :: Scientific/Engineering :: Artificial Life\\\",\\n \\\"Topic :: Scientific/Engineering :: Astronomy\\\",\\n \\\"Topic :: Scientific/Engineering :: Atmospheric Science\\\",\\n \\\"Topic :: Scientific/Engineering :: Bio-Informatics\\\",\\n \\\"Topic :: Scientific/Engineering :: Chemistry\\\",\\n \\\"Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)\\\",\\n \\\"Topic :: Scientific/Engineering :: GIS\\\",\\n \\\"Topic :: Scientific/Engineering :: Human Machine Interfaces\\\",\\n \\\"Topic :: Scientific/Engineering :: Hydrology\\\",\\n \\\"Topic :: Scientific/Engineering :: Image Processing\\\",\\n \\\"Topic :: Scientific/Engineering :: Image Recognition\\\",\\n \\\"Topic :: Scientific/Engineering :: Information Analysis\\\",\\n \\\"Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator\\\",\\n \\\"Topic :: Scientific/Engineering :: Mathematics\\\",\\n \\\"Topic :: Scientific/Engineering :: Medical Science Apps.\\\",\\n \\\"Topic :: Scientific/Engineering :: Oceanography\\\",\\n \\\"Topic :: Scientific/Engineering :: Physics\\\",\\n \\\"Topic :: Scientific/Engineering :: Quantum Computing\\\",\\n \\\"Topic :: Scientific/Engineering :: Visualization\\\",\\n \\\"Topic :: Security\\\",\\n \\\"Topic :: Security :: Cryptography\\\",\\n \\\"Topic :: Sociology\\\",\\n \\\"Topic :: Sociology :: Genealogy\\\",\\n \\\"Topic :: Sociology :: History\\\",\\n \\\"Topic :: Software Development\\\",\\n \\\"Topic :: Software Development :: Assemblers\\\",\\n \\\"Topic :: Software Development :: Bug Tracking\\\",\\n \\\"Topic :: Software Development :: Build Tools\\\",\\n \\\"Topic :: Software Development :: Code Generators\\\",\\n \\\"Topic :: Software Development :: Compilers\\\",\\n \\\"Topic :: Software Development :: Debuggers\\\",\\n \\\"Topic :: Software Development :: Disassemblers\\\",\\n \\\"Topic :: Software Development :: Documentation\\\",\\n \\\"Topic :: Software Development :: Embedded Systems\\\",\\n \\\"Topic :: Software Development :: Embedded Systems :: Controller Area Network (CAN)\\\",\\n \\\"Topic :: Software Development :: Embedded Systems :: Controller Area Network (CAN) :: CANopen\\\",\\n \\\"Topic :: Software Development :: Embedded Systems :: Controller Area Network (CAN) :: J1939\\\",\\n \\\"Topic :: Software Development :: Internationalization\\\",\\n \\\"Topic :: Software Development :: Interpreters\\\",\\n \\\"Topic :: Software Development :: Libraries\\\",\\n \\\"Topic :: Software Development :: Libraries :: Application Frameworks\\\",\\n \\\"Topic :: Software Development :: Libraries :: Java Libraries\\\",\\n \\\"Topic :: Software Development :: Libraries :: PHP Classes\\\",\\n \\\"Topic :: Software Development :: Libraries :: Perl Modules\\\",\\n \\\"Topic :: Software Development :: Libraries :: Pike Modules\\\",\\n \\\"Topic :: Software Development :: Libraries :: Python Modules\\\",\\n \\\"Topic :: Software Development :: Libraries :: Ruby Modules\\\",\\n \\\"Topic :: Software Development :: Libraries :: Tcl Extensions\\\",\\n \\\"Topic :: Software Development :: Libraries :: pygame\\\",\\n \\\"Topic :: Software Development :: Localization\\\",\\n \\\"Topic :: Software Development :: Object Brokering\\\",\\n \\\"Topic :: Software Development :: Object Brokering :: CORBA\\\",\\n \\\"Topic :: Software Development :: Pre-processors\\\",\\n \\\"Topic :: Software Development :: Quality Assurance\\\",\\n \\\"Topic :: Software Development :: Testing\\\",\\n \\\"Topic :: Software Development :: Testing :: Acceptance\\\",\\n \\\"Topic :: Software Development :: Testing :: BDD\\\",\\n \\\"Topic :: Software Development :: Testing :: Mocking\\\",\\n \\\"Topic :: Software Development :: Testing :: Traffic Generation\\\",\\n \\\"Topic :: Software Development :: Testing :: Unit\\\",\\n \\\"Topic :: Software Development :: User Interfaces\\\",\\n \\\"Topic :: Software Development :: Version Control\\\",\\n \\\"Topic :: Software Development :: Version Control :: Bazaar\\\",\\n \\\"Topic :: Software Development :: Version Control :: CVS\\\",\\n \\\"Topic :: Software Development :: Version Control :: Git\\\",\\n \\\"Topic :: Software Development :: Version Control :: Mercurial\\\",\\n \\\"Topic :: Software Development :: Version Control :: RCS\\\",\\n \\\"Topic :: Software Development :: Version Control :: SCCS\\\",\\n \\\"Topic :: Software Development :: Widget Sets\\\",\\n \\\"Topic :: System\\\",\\n \\\"Topic :: System :: Archiving\\\",\\n \\\"Topic :: System :: Archiving :: Backup\\\",\\n \\\"Topic :: System :: Archiving :: Compression\\\",\\n \\\"Topic :: System :: Archiving :: Mirroring\\\",\\n \\\"Topic :: System :: Archiving :: Packaging\\\",\\n \\\"Topic :: System :: Benchmark\\\",\\n \\\"Topic :: System :: Boot\\\",\\n \\\"Topic :: System :: Boot :: Init\\\",\\n \\\"Topic :: System :: Clustering\\\",\\n \\\"Topic :: System :: Console Fonts\\\",\\n \\\"Topic :: System :: Distributed Computing\\\",\\n \\\"Topic :: System :: Emulators\\\",\\n \\\"Topic :: System :: Filesystems\\\",\\n \\\"Topic :: System :: Hardware\\\",\\n \\\"Topic :: System :: Hardware :: Hardware Drivers\\\",\\n \\\"Topic :: System :: Hardware :: Mainframes\\\",\\n \\\"Topic :: System :: Hardware :: Symmetric Multi-processing\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB)\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Audio\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Audio/Video (AV)\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Communications Device Class (CDC)\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Diagnostic Device\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Hub\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Human Interface Device (HID)\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Mass Storage\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Miscellaneous\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Printer\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Smart Card\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Vendor\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Video (UVC)\\\",\\n \\\"Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Wireless Controller\\\",\\n \\\"Topic :: System :: Installation/Setup\\\",\\n \\\"Topic :: System :: Logging\\\",\\n \\\"Topic :: System :: Monitoring\\\",\\n \\\"Topic :: System :: Networking\\\",\\n \\\"Topic :: System :: Networking :: Firewalls\\\",\\n \\\"Topic :: System :: Networking :: Monitoring\\\",\\n \\\"Topic :: System :: Networking :: Monitoring :: Hardware Watchdog\\\",\\n \\\"Topic :: System :: Networking :: Time Synchronization\\\",\\n \\\"Topic :: System :: Operating System\\\",\\n \\\"Topic :: System :: Operating System Kernels\\\",\\n \\\"Topic :: System :: Operating System Kernels :: BSD\\\",\\n \\\"Topic :: System :: Operating System Kernels :: GNU Hurd\\\",\\n \\\"Topic :: System :: Operating System Kernels :: Linux\\\",\\n \\\"Topic :: System :: Power (UPS)\\\",\\n \\\"Topic :: System :: Recovery Tools\\\",\\n \\\"Topic :: System :: Shells\\\",\\n \\\"Topic :: System :: Software Distribution\\\",\\n \\\"Topic :: System :: System Shells\\\",\\n \\\"Topic :: System :: Systems Administration\\\",\\n \\\"Topic :: System :: Systems Administration :: Authentication/Directory\\\",\\n \\\"Topic :: System :: Systems Administration :: Authentication/Directory :: LDAP\\\",\\n \\\"Topic :: System :: Systems Administration :: Authentication/Directory :: NIS\\\",\\n \\\"Topic :: Terminals\\\",\\n \\\"Topic :: Terminals :: Serial\\\",\\n \\\"Topic :: Terminals :: Telnet\\\",\\n \\\"Topic :: Terminals :: Terminal Emulators/X Terminals\\\",\\n \\\"Topic :: Text Editors\\\",\\n \\\"Topic :: Text Editors :: Documentation\\\",\\n \\\"Topic :: Text Editors :: Emacs\\\",\\n \\\"Topic :: Text Editors :: Integrated Development Environments (IDE)\\\",\\n \\\"Topic :: Text Editors :: Text Processing\\\",\\n \\\"Topic :: Text Editors :: Word Processors\\\",\\n \\\"Topic :: Text Processing\\\",\\n \\\"Topic :: Text Processing :: Filters\\\",\\n \\\"Topic :: Text Processing :: Fonts\\\",\\n \\\"Topic :: Text Processing :: General\\\",\\n \\\"Topic :: Text Processing :: Indexing\\\",\\n \\\"Topic :: Text Processing :: Linguistic\\\",\\n \\\"Topic :: Text Processing :: Markup\\\",\\n \\\"Topic :: Text Processing :: Markup :: HTML\\\",\\n \\\"Topic :: Text Processing :: Markup :: LaTeX\\\",\\n \\\"Topic :: Text Processing :: Markup :: Markdown\\\",\\n \\\"Topic :: Text Processing :: Markup :: SGML\\\",\\n \\\"Topic :: Text Processing :: Markup :: VRML\\\",\\n \\\"Topic :: Text Processing :: Markup :: XML\\\",\\n \\\"Topic :: Text Processing :: Markup :: reStructuredText\\\",\\n \\\"Topic :: Utilities\\\",\\n \\\"Typing :: Stubs Only\\\",\\n \\\"Typing :: Typed\\\",\\n]\\n\\nclassifiers: Set[str] = set(sorted_classifiers)\\n\\n\\n# A mapping from the deprecated classifier name to a list of zero or more valid\\n# classifiers that should replace it\\ndeprecated_classifiers: Dict[str, List[str]] = {\\n \\\"Framework :: Django CMS :: 4.2\\\": [\\\"Framework :: Django CMS :: 5.0\\\"],\\n \\\"License :: OSI Approved :: Intel Open Source License\\\": [],\\n \\\"License :: OSI Approved :: Jabber Open Source License\\\": [],\\n \\\"License :: OSI Approved :: MITRE Collaborative Virtual Workspace License (CVW)\\\": [],\\n \\\"License :: OSI Approved :: Sun Industry Standards Source License (SISSL)\\\": [],\\n \\\"License :: OSI Approved :: X.Net License\\\": [],\\n \\\"Natural Language :: Ukranian\\\": [\\\"Natural Language :: Ukrainian\\\"],\\n \\\"Topic :: Communications :: Chat :: AOL Instant Messenger\\\": [],\\n}\\n\\n\\n# All classifiers, including deprecated classifiers\\nall_classifiers: List[str] = sorted(\\n sorted_classifiers + list(deprecated_classifiers.keys())\\n)\\n\\n__all__ = [\\n \\\"all_classifiers\\\",\\n \\\"classifiers\\\",\\n \\\"deprecated_classifiers\\\",\\n \\\"sorted_classifiers\\\",\\n]\\n\\n[end of src/trove_classifiers/__init__.py]\",\n \"filename\": \"src/trove_classifiers/__init__.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"[end of src/trove_classifiers/py.typed]\",\n \"filename\": \"src/trove_classifiers/py.typed\",\n \"id\": \"10\"\n },\n {\n \"content\": \"from trove_classifiers import sorted_classifiers\\n\\nfor classifier in sorted_classifiers:\\n print(classifier)\\n\\n[end of src/trove_classifiers/__main__.py]\",\n \"filename\": \"src/trove_classifiers/__main__.py\",\n \"id\": \"11\"\n }\n]","isConversational":false}}},{"rowIdx":60,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 60,\n \"num_files\": 27,\n \"repo_id\": \"repo_0060\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n handlers:\n python:\n rendering:\n show_root_heading: yes\n show_submodules: no\n separate_signature: yes\n - search\nnav:\n - Home: index.md\n - Changelog: changelog.md\n - Contributing: contributing.md\n - Reference: reference.md\n - License: license.md\n\n[end of mkdocs.yml]","filename":"mkdocs.yml","id":"0"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"black~=22.3.0\nbumpversion\nclick\nflake8>=2.2.3\nipython\npytest-cov\npytest>=3.9\nsh>=2\ntox\ntwine\nwheel\n\n[end of requirements.txt]","filename":"requirements.txt","id":"2"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"3"},{"content":".PHONY: clean-pyc clean-build test\n\nclean: clean-build clean-pyc\n\nclean-build:\n\trm -fr build/\n\trm -fr dist/\n\trm -fr src/*.egg-info\n\nclean-pyc:\n\tfind . -name '*.pyc' -exec rm -f {} +\n\tfind . -name '*.pyo' -exec rm -f {} +\n\tfind . -name '*~' -exec rm -f {} +\n\nrelease: sdist\n\ttwine check dist/*\n\ttwine upload dist/*\n\nrelease-test: sdist\n\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\n\nsdist: clean\n\tpython setup.py sdist bdist_wheel\n\tls -l dist\n\ntest:\n\tpip install -e .\n\tflake8 .\n\tpy.test tests/\n\ncoverage:\n\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\n\tcoverage report\n\ncoverage-html: coverage\n\tcoverage html\n\n[end of Makefile]","filename":"Makefile","id":"4"},{"content":"mdx_truly_sane_lists~=1.2\nmkdocs-include-markdown-plugin~=3.3.0\nmkdocs-material~=8.2.9\nmkdocstrings[python]~=0.18.1\nmkdocs~=1.3.0\n\n[end of requirements-docs.txt]","filename":"requirements-docs.txt","id":"5"},{"content":"include LICENSE *.md *.yml *.toml\n\ninclude tox.ini\nrecursive-include docs *.md\nrecursive-include tests *.py\n\ninclude .bumpversion.cfg\ninclude .coveragerc\ninclude .editorconfig\ninclude Makefile\ninclude requirements.txt\ninclude requirements-docs.txt\ninclude src/dotenv/py.typed\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"6"},{"content":"# see: http://editorconfig.org\n\nroot = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.{py,rst,ini}]\nindent_style = space\nindent_size = 4\n\n[*.yml]\nindent_style = space\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"7"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of README.md]","filename":"README.md","id":"8"},{"content":"from setuptools import setup\n\n\ndef read_files(files):\n data = []\n for file in files:\n with open(file, encoding=\"utf-8\") as f:\n data.append(f.read())\n return \"\\n\".join(data)\n\n\nlong_description = read_files([\"README.md\", \"CHANGELOG.md\"])\n\nmeta = {}\nwith open(\"./src/dotenv/version.py\", encoding=\"utf-8\") as f:\n exec(f.read(), meta)\n\nsetup(\n name=\"python-dotenv\",\n description=\"Read key-value pairs from a .env file and set them as environment variables\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n version=meta[\"__version__\"],\n author=\"Saurabh Kumar\",\n author_email=\"me+github@saurabh-kumar.com\",\n url=\"https://github.com/theskumar/python-dotenv\",\n keywords=[\n \"environment variables\",\n \"deployments\",\n \"settings\",\n \"env\",\n \"dotenv\",\n \"configurations\",\n \"python\",\n ],\n packages=[\"dotenv\"],\n package_dir={\"\": \"src\"},\n package_data={\n \"dotenv\": [\"py.typed\"],\n },\n python_requires=\">=3.9\",\n extras_require={\n \"cli\": [\n \"click>=5.0\",\n ],\n },\n entry_points={\n \"console_scripts\": [\n \"dotenv=dotenv.__main__:cli\",\n ],\n },\n license=\"BSD-3-Clause\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Topic :: System :: Systems Administration\",\n \"Topic :: Utilities\",\n \"Environment :: Web Environment\",\n ],\n)\n\n[end of setup.py]","filename":"setup.py","id":"9"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of CONTRIBUTING.md]","filename":"CONTRIBUTING.md","id":"10"},{"content":"[tox]\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\n\n[gh-actions]\npython =\n 3.9: py39\n 3.10: py310\n 3.11: py311\n 3.12: py312\n 3.13: py313, lint, manifest\n pypy-3.9: pypy3\n\n[testenv]\ndeps =\n pytest\n pytest-cov\n sh >= 2.0.2, <3\n click\n py{39,310,311,312,313,pypy3}: ipython\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\ndepends =\n py{39,310,311,312,313},pypy3: coverage-clean\n coverage-report: py{39,310,311,312,313},pypy3\n\n[testenv:lint]\nskip_install = true\ndeps =\n flake8\n mypy\ncommands =\n flake8 src tests\n mypy --python-version=3.13 src tests\n mypy --python-version=3.12 src tests\n mypy --python-version=3.11 src tests\n mypy --python-version=3.10 src tests\n mypy --python-version=3.9 src tests\n\n[testenv:manifest]\ndeps = check-manifest\nskip_install = true\ncommands = check-manifest\n\n[testenv:coverage-clean]\ndeps = coverage\nskip_install = true\ncommands = coverage erase\n\n[testenv:coverage-report]\ndeps = coverage\nskip_install = true\ncommands =\n coverage report\n\n[end of tox.ini]","filename":"tox.ini","id":"11"},{"content":"[bumpversion]\ncurrent_version = 1.0.1\ncommit = True\ntag = True\n\n[bumpversion:file:src/dotenv/version.py]\n\n[flake8]\nmax-line-length = 120\nexclude = .tox,.git,docs,venv,.venv,build\n\n[mypy]\ncheck_untyped_defs = true\nignore_missing_imports = true\n\n[metadata]\ndescription_file = README.md\n\n[tool:pytest]\ntestpaths = tests\n\n[coverage:run]\nrelative_files = True\nsource = dotenv\n\n[coverage:paths]\nsource =\n\tsrc/dotenv\n\t.tox/*/lib/python*/site-packages/dotenv\n\t.tox/pypy*/site-packages/dotenv\n\n[coverage:report]\nshow_missing = True\ninclude = */site-packages/dotenv/*\nexclude_lines =\n\tif IS_TYPE_CHECKING:\n\tpragma: no cover\n\n[end of setup.cfg]","filename":"setup.cfg","id":"12"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of docs/license.md]","filename":"docs/license.md","id":"13"},{"content":"# ::: dotenv\n\n\n[end of docs/reference.md]","filename":"docs/reference.md","id":"14"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of docs/changelog.md]","filename":"docs/changelog.md","id":"15"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of docs/index.md]","filename":"docs/index.md","id":"16"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of docs/contributing.md]","filename":"docs/contributing.md","id":"17"},{"content":"__version__ = \"1.0.1\"\n\n[end of src/dotenv/version.py]","filename":"src/dotenv/version.py","id":"18"},{"content":"import re\nfrom abc import ABCMeta, abstractmethod\nfrom typing import Iterator, Mapping, Optional, Pattern\n\n_posix_variable: Pattern[str] = re.compile(\n r\"\"\"\n \\$\\{\n (?P<name>[^\\}:]*)\n (?::-\n (?P<default>[^\\}]*)\n )?\n \\}\n \"\"\",\n re.VERBOSE,\n)\n\n\nclass Atom(metaclass=ABCMeta):\n def __ne__(self, other: object) -> bool:\n result = self.__eq__(other)\n if result is NotImplemented:\n return NotImplemented\n return not result\n\n @abstractmethod\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\n\n\nclass Literal(Atom):\n def __init__(self, value: str) -> None:\n self.value = value\n\n def __repr__(self) -> str:\n return f\"Literal(value={self.value})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return self.value == other.value\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.value))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n return self.value\n\n\nclass Variable(Atom):\n def __init__(self, name: str, default: Optional[str]) -> None:\n self.name = name\n self.default = default\n\n def __repr__(self) -> str:\n return f\"Variable(name={self.name}, default={self.default})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return (self.name, self.default) == (other.name, other.default)\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.name, self.default))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n default = self.default if self.default is not None else \"\"\n result = env.get(self.name, default)\n return result if result is not None else \"\"\n\n\ndef parse_variables(value: str) -> Iterator[Atom]:\n cursor = 0\n\n for match in _posix_variable.finditer(value):\n (start, end) = match.span()\n name = match[\"name\"]\n default = match[\"default\"]\n\n if start > cursor:\n yield Literal(value=value[cursor:start])\n\n yield Variable(name=name, default=default)\n cursor = end\n\n length = len(value)\n if cursor < length:\n yield Literal(value=value[cursor:length])\n\n[end of src/dotenv/variables.py]","filename":"src/dotenv/variables.py","id":"19"},{"content":"from typing import Any, Optional\n\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\n unset_key)\n\n\ndef load_ipython_extension(ipython: Any) -> None:\n from .ipython import load_ipython_extension\n load_ipython_extension(ipython)\n\n\ndef get_cli_string(\n path: Optional[str] = None,\n action: Optional[str] = None,\n key: Optional[str] = None,\n value: Optional[str] = None,\n quote: Optional[str] = None,\n):\n \"\"\"Returns a string suitable for running as a shell script.\n\n Useful for converting a arguments passed to a fabric task\n to be passed to a `local` or `run` command.\n \"\"\"\n command = ['dotenv']\n if quote:\n command.append(f'-q {quote}')\n if path:\n command.append(f'-f {path}')\n if action:\n command.append(action)\n if key:\n command.append(key)\n if value:\n if ' ' in value:\n command.append(f'\"{value}\"')\n else:\n command.append(value)\n\n return ' '.join(command).strip()\n\n\n__all__ = ['get_cli_string',\n 'load_dotenv',\n 'dotenv_values',\n 'get_key',\n 'set_key',\n 'unset_key',\n 'find_dotenv',\n 'load_ipython_extension']\n\n[end of src/dotenv/__init__.py]","filename":"src/dotenv/__init__.py","id":"20"},{"content":"import codecs\nimport re\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\n Pattern, Sequence, Tuple)\n\n\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\n return re.compile(string, re.UNICODE | extra_flags)\n\n\n_newline = make_regex(r\"(\\r\\n|\\n|\\r)\")\n_multiline_whitespace = make_regex(r\"\\s*\", extra_flags=re.MULTILINE)\n_whitespace = make_regex(r\"[^\\S\\r\\n]*\")\n_export = make_regex(r\"(?:export[^\\S\\r\\n]+)?\")\n_single_quoted_key = make_regex(r\"'([^']+)'\")\n_unquoted_key = make_regex(r\"([^=\\#\\s]+)\")\n_equal_sign = make_regex(r\"(=[^\\S\\r\\n]*)\")\n_single_quoted_value = make_regex(r\"'((?:\\\\'|[^'])*)'\")\n_double_quoted_value = make_regex(r'\"((?:\\\\\"|[^\"])*)\"')\n_unquoted_value = make_regex(r\"([^\\r\\n]*)\")\n_comment = make_regex(r\"(?:[^\\S\\r\\n]*#[^\\r\\n]*)?\")\n_end_of_line = make_regex(r\"[^\\S\\r\\n]*(?:\\r\\n|\\n|\\r|$)\")\n_rest_of_line = make_regex(r\"[^\\r\\n]*(?:\\r|\\n|\\r\\n)?\")\n_double_quote_escapes = make_regex(r\"\\\\[\\\\'\\\"abfnrtv]\")\n_single_quote_escapes = make_regex(r\"\\\\[\\\\']\")\n\n\nclass Original(NamedTuple):\n string: str\n line: int\n\n\nclass Binding(NamedTuple):\n key: Optional[str]\n value: Optional[str]\n original: Original\n error: bool\n\n\nclass Position:\n def __init__(self, chars: int, line: int) -> None:\n self.chars = chars\n self.line = line\n\n @classmethod\n def start(cls) -> \"Position\":\n return cls(chars=0, line=1)\n\n def set(self, other: \"Position\") -> None:\n self.chars = other.chars\n self.line = other.line\n\n def advance(self, string: str) -> None:\n self.chars += len(string)\n self.line += len(re.findall(_newline, string))\n\n\nclass Error(Exception):\n pass\n\n\nclass Reader:\n def __init__(self, stream: IO[str]) -> None:\n self.string = stream.read()\n self.position = Position.start()\n self.mark = Position.start()\n\n def has_next(self) -> bool:\n return self.position.chars < len(self.string)\n\n def set_mark(self) -> None:\n self.mark.set(self.position)\n\n def get_marked(self) -> Original:\n return Original(\n string=self.string[self.mark.chars:self.position.chars],\n line=self.mark.line,\n )\n\n def peek(self, count: int) -> str:\n return self.string[self.position.chars:self.position.chars + count]\n\n def read(self, count: int) -> str:\n result = self.string[self.position.chars:self.position.chars + count]\n if len(result) < count:\n raise Error(\"read: End of string\")\n self.position.advance(result)\n return result\n\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\n match = regex.match(self.string, self.position.chars)\n if match is None:\n raise Error(\"read_regex: Pattern not found\")\n self.position.advance(self.string[match.start():match.end()])\n return match.groups()\n\n\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\n def decode_match(match: Match[str]) -> str:\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\n\n return regex.sub(decode_match, string)\n\n\ndef parse_key(reader: Reader) -> Optional[str]:\n char = reader.peek(1)\n if char == \"#\":\n return None\n elif char == \"'\":\n (key,) = reader.read_regex(_single_quoted_key)\n else:\n (key,) = reader.read_regex(_unquoted_key)\n return key\n\n\ndef parse_unquoted_value(reader: Reader) -> str:\n (part,) = reader.read_regex(_unquoted_value)\n return re.sub(r\"\\s+#.*\", \"\", part).rstrip()\n\n\ndef parse_value(reader: Reader) -> str:\n char = reader.peek(1)\n if char == u\"'\":\n (value,) = reader.read_regex(_single_quoted_value)\n return decode_escapes(_single_quote_escapes, value)\n elif char == u'\"':\n (value,) = reader.read_regex(_double_quoted_value)\n return decode_escapes(_double_quote_escapes, value)\n elif char in (u\"\", u\"\\n\", u\"\\r\"):\n return u\"\"\n else:\n return parse_unquoted_value(reader)\n\n\ndef parse_binding(reader: Reader) -> Binding:\n reader.set_mark()\n try:\n reader.read_regex(_multiline_whitespace)\n if not reader.has_next():\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=False,\n )\n reader.read_regex(_export)\n key = parse_key(reader)\n reader.read_regex(_whitespace)\n if reader.peek(1) == \"=\":\n reader.read_regex(_equal_sign)\n value: Optional[str] = parse_value(reader)\n else:\n value = None\n reader.read_regex(_comment)\n reader.read_regex(_end_of_line)\n return Binding(\n key=key,\n value=value,\n original=reader.get_marked(),\n error=False,\n )\n except Error:\n reader.read_regex(_rest_of_line)\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=True,\n )\n\n\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\n reader = Reader(stream)\n while reader.has_next():\n yield parse_binding(reader)\n\n[end of src/dotenv/parser.py]","filename":"src/dotenv/parser.py","id":"21"},{"content":"import json\nimport os\nimport shlex\nimport sys\nfrom contextlib import contextmanager\nfrom typing import Any, Dict, IO, Iterator, List, Optional\n\ntry:\n import click\nexcept ImportError:\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\n'\n 'Run pip install \"python-dotenv[cli]\" to fix this.')\n sys.exit(1)\n\nfrom .main import dotenv_values, set_key, unset_key\nfrom .version import __version__\n\n\ndef enumerate_env() -> Optional[str]:\n \"\"\"\n Return a path for the ${pwd}/.env file.\n\n If pwd does not exist, return None.\n \"\"\"\n try:\n cwd = os.getcwd()\n except FileNotFoundError:\n return None\n path = os.path.join(cwd, '.env')\n return path\n\n\n@click.group()\n@click.option('-f', '--file', default=enumerate_env(),\n type=click.Path(file_okay=True),\n help=\"Location of the .env file, defaults to .env file in current working directory.\")\n@click.option('-q', '--quote', default='always',\n type=click.Choice(['always', 'never', 'auto']),\n help=\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\")\n@click.option('-e', '--export', default=False,\n type=click.BOOL,\n help=\"Whether to write the dot file as an executable bash script.\")\n@click.version_option(version=__version__)\n@click.pass_context\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\n \"\"\"This script is used to set, get or unset values from a .env file.\"\"\"\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\n\n\n@contextmanager\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\n \"\"\"\n Open a file and yield the corresponding (decoded) stream.\n\n Exits with error code 2 if the file cannot be opened.\n \"\"\"\n\n try:\n with open(path) as stream:\n yield stream\n except OSError as exc:\n print(f\"Error opening env file: {exc}\", file=sys.stderr)\n exit(2)\n\n\n@cli.command()\n@click.pass_context\n@click.option('--format', default='simple',\n type=click.Choice(['simple', 'json', 'shell', 'export']),\n help=\"The format in which to display the list. Default format is simple, \"\n \"which displays name=value without quotes.\")\ndef list(ctx: click.Context, format: bool) -> None:\n \"\"\"Display all the stored key/value.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n if format == 'json':\n click.echo(json.dumps(values, indent=2, sort_keys=True))\n else:\n prefix = 'export ' if format == 'export' else ''\n for k in sorted(values):\n v = values[k]\n if v is not None:\n if format in ('export', 'shell'):\n v = shlex.quote(v)\n click.echo(f'{prefix}{k}={v}')\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\n@click.argument('value', required=True)\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\n \"\"\"Store the given key/value.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n export = ctx.obj['EXPORT']\n success, key, value = set_key(file, key, value, quote, export)\n if success:\n click.echo(f'{key}={value}')\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef get(ctx: click.Context, key: Any) -> None:\n \"\"\"Retrieve the value for the given key.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n stored_value = values.get(key)\n if stored_value:\n click.echo(stored_value)\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef unset(ctx: click.Context, key: Any) -> None:\n \"\"\"Removes the given key.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n success, key = unset_key(file, key, quote)\n if success:\n click.echo(f\"Successfully removed {key}\")\n else:\n exit(1)\n\n\n@cli.command(context_settings={'ignore_unknown_options': True})\n@click.pass_context\n@click.option(\n \"--override/--no-override\",\n default=True,\n help=\"Override variables from the environment file with those from the .env file.\",\n)\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\n \"\"\"Run command with environment variables present.\"\"\"\n file = ctx.obj['FILE']\n if not os.path.isfile(file):\n raise click.BadParameter(\n f'Invalid value for \\'-f\\' \"{file}\" does not exist.',\n ctx=ctx\n )\n dotenv_as_dict = {\n k: v\n for (k, v) in dotenv_values(file).items()\n if v is not None and (override or k not in os.environ)\n }\n\n if not commandline:\n click.echo('No command given.')\n exit(1)\n run_command(commandline, dotenv_as_dict)\n\n\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\n \"\"\"Replace the current process with the specified command.\n\n Replaces the current process with the specified command and the variables from `env`\n added in the current environment variables.\n\n Parameters\n ----------\n command: List[str]\n The command and it's parameters\n env: Dict\n The additional environment variables\n\n Returns\n -------\n None\n This function does not return any value. It replaces the current process with the new one.\n\n \"\"\"\n # copy the current environment variables and add the vales from\n # `env`\n cmd_env = os.environ.copy()\n cmd_env.update(env)\n\n os.execvpe(command[0], args=command, env=cmd_env)\n\n[end of src/dotenv/cli.py]","filename":"src/dotenv/cli.py","id":"22"},{"content":"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\n parse_argstring) # type: ignore\n\nfrom .main import find_dotenv, load_dotenv\n\n\n@magics_class\nclass IPythonDotEnv(Magics):\n\n @magic_arguments()\n @argument(\n '-o', '--override', action='store_true',\n help=\"Indicate to override existing variables\"\n )\n @argument(\n '-v', '--verbose', action='store_true',\n help=\"Indicate function calls to be verbose\"\n )\n @argument('dotenv_path', nargs='?', type=str, default='.env',\n help='Search in increasingly higher folders for the `dotenv_path`')\n @line_magic\n def dotenv(self, line):\n args = parse_argstring(self.dotenv, line)\n # Locate the .env file\n dotenv_path = args.dotenv_path\n try:\n dotenv_path = find_dotenv(dotenv_path, True, True)\n except IOError:\n print(\"cannot find .env file\")\n return\n\n # Load the .env file\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\n\n\ndef load_ipython_extension(ipython):\n \"\"\"Register the %dotenv magic.\"\"\"\n ipython.register_magics(IPythonDotEnv)\n\n[end of src/dotenv/ipython.py]","filename":"src/dotenv/ipython.py","id":"23"},{"content":"# Marker file for PEP 561\n\n[end of src/dotenv/py.typed]","filename":"src/dotenv/py.typed","id":"24"},{"content":"import io\nimport logging\nimport os\nimport pathlib\nimport shutil\nimport sys\nimport tempfile\nfrom collections import OrderedDict\nfrom contextlib import contextmanager\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\n\nfrom .parser import Binding, parse_stream\nfrom .variables import parse_variables\n\n# A type alias for a string path to be used for the paths in this file.\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\n# only accepts string paths, not byte paths or file descriptors. See\n# https://github.com/python/typeshed/pull/6832.\nStrPath = Union[str, \"os.PathLike[str]\"]\n\nlogger = logging.getLogger(__name__)\n\n\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\n for mapping in mappings:\n if mapping.error:\n logger.warning(\n \"python-dotenv could not parse statement starting at line %s\",\n mapping.original.line,\n )\n yield mapping\n\n\nclass DotEnv:\n def __init__(\n self,\n dotenv_path: Optional[StrPath],\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n encoding: Optional[str] = None,\n interpolate: bool = True,\n override: bool = True,\n ) -> None:\n self.dotenv_path: Optional[StrPath] = dotenv_path\n self.stream: Optional[IO[str]] = stream\n self._dict: Optional[Dict[str, Optional[str]]] = None\n self.verbose: bool = verbose\n self.encoding: Optional[str] = encoding\n self.interpolate: bool = interpolate\n self.override: bool = override\n\n @contextmanager\n def _get_stream(self) -> Iterator[IO[str]]:\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\n with open(self.dotenv_path, encoding=self.encoding) as stream:\n yield stream\n elif self.stream is not None:\n yield self.stream\n else:\n if self.verbose:\n logger.info(\n \"python-dotenv could not find configuration file %s.\",\n self.dotenv_path or \".env\",\n )\n yield io.StringIO(\"\")\n\n def dict(self) -> Dict[str, Optional[str]]:\n \"\"\"Return dotenv as dict\"\"\"\n if self._dict:\n return self._dict\n\n raw_values = self.parse()\n\n if self.interpolate:\n self._dict = OrderedDict(\n resolve_variables(raw_values, override=self.override)\n )\n else:\n self._dict = OrderedDict(raw_values)\n\n return self._dict\n\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\n with self._get_stream() as stream:\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\n if mapping.key is not None:\n yield mapping.key, mapping.value\n\n def set_as_environment_variables(self) -> bool:\n \"\"\"\n Load the current dotenv as system environment variable.\n \"\"\"\n if not self.dict():\n return False\n\n for k, v in self.dict().items():\n if k in os.environ and not self.override:\n continue\n if v is not None:\n os.environ[k] = v\n\n return True\n\n def get(self, key: str) -> Optional[str]:\n \"\"\" \"\"\"\n data = self.dict()\n\n if key in data:\n return data[key]\n\n if self.verbose:\n logger.warning(\"Key %s not found in %s.\", key, self.dotenv_path)\n\n return None\n\n\ndef get_key(\n dotenv_path: StrPath,\n key_to_get: str,\n encoding: Optional[str] = \"utf-8\",\n) -> Optional[str]:\n \"\"\"\n Get the value of a given key from the given .env.\n\n Returns `None` if the key isn't found or doesn't have a value.\n \"\"\"\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\n\n\n@contextmanager\ndef rewrite(\n path: StrPath,\n encoding: Optional[str],\n) -> Iterator[Tuple[IO[str], IO[str]]]:\n pathlib.Path(path).touch()\n\n with tempfile.NamedTemporaryFile(mode=\"w\", encoding=encoding, delete=False) as dest:\n error = None\n try:\n with open(path, encoding=encoding) as source:\n yield (source, dest)\n except BaseException as err:\n error = err\n\n if error is None:\n shutil.move(dest.name, path)\n else:\n os.unlink(dest.name)\n raise error from None\n\n\ndef set_key(\n dotenv_path: StrPath,\n key_to_set: str,\n value_to_set: str,\n quote_mode: str = \"always\",\n export: bool = False,\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str, str]:\n \"\"\"\n Adds or Updates a key/value to the given .env\n\n If the .env path given doesn't exist, fails instead of risking creating\n an orphan .env somewhere in the filesystem\n \"\"\"\n if quote_mode not in (\"always\", \"auto\", \"never\"):\n raise ValueError(f\"Unknown quote_mode: {quote_mode}\")\n\n quote = quote_mode == \"always\" or (\n quote_mode == \"auto\" and not value_to_set.isalnum()\n )\n\n if quote:\n value_out = \"'{}'\".format(value_to_set.replace(\"'\", \"\\\\'\"))\n else:\n value_out = value_to_set\n if export:\n line_out = f\"export {key_to_set}={value_out}\\n\"\n else:\n line_out = f\"{key_to_set}={value_out}\\n\"\n\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n replaced = False\n missing_newline = False\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_set:\n dest.write(line_out)\n replaced = True\n else:\n dest.write(mapping.original.string)\n missing_newline = not mapping.original.string.endswith(\"\\n\")\n if not replaced:\n if missing_newline:\n dest.write(\"\\n\")\n dest.write(line_out)\n\n return True, key_to_set, value_to_set\n\n\ndef unset_key(\n dotenv_path: StrPath,\n key_to_unset: str,\n quote_mode: str = \"always\",\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str]:\n \"\"\"\n Removes a given key from the given `.env` file.\n\n If the .env path given doesn't exist, fails.\n If the given key doesn't exist in the .env, fails.\n \"\"\"\n if not os.path.exists(dotenv_path):\n logger.warning(\"Can't delete from %s - it doesn't exist.\", dotenv_path)\n return None, key_to_unset\n\n removed = False\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_unset:\n removed = True\n else:\n dest.write(mapping.original.string)\n\n if not removed:\n logger.warning(\n \"Key %s not removed from %s - key doesn't exist.\", key_to_unset, dotenv_path\n )\n return None, key_to_unset\n\n return removed, key_to_unset\n\n\ndef resolve_variables(\n values: Iterable[Tuple[str, Optional[str]]],\n override: bool,\n) -> Mapping[str, Optional[str]]:\n new_values: Dict[str, Optional[str]] = {}\n\n for name, value in values:\n if value is None:\n result = None\n else:\n atoms = parse_variables(value)\n env: Dict[str, Optional[str]] = {}\n if override:\n env.update(os.environ) # type: ignore\n env.update(new_values)\n else:\n env.update(new_values)\n env.update(os.environ) # type: ignore\n result = \"\".join(atom.resolve(env) for atom in atoms)\n\n new_values[name] = result\n\n return new_values\n\n\ndef _walk_to_root(path: str) -> Iterator[str]:\n \"\"\"\n Yield directories starting from the given directory up to the root\n \"\"\"\n if not os.path.exists(path):\n raise IOError(\"Starting path not found\")\n\n if os.path.isfile(path):\n path = os.path.dirname(path)\n\n last_dir = None\n current_dir = os.path.abspath(path)\n while last_dir != current_dir:\n yield current_dir\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\n last_dir, current_dir = current_dir, parent_dir\n\n\ndef find_dotenv(\n filename: str = \".env\",\n raise_error_if_not_found: bool = False,\n usecwd: bool = False,\n) -> str:\n \"\"\"\n Search in increasingly higher folders for the given file\n\n Returns path to the file if found, or an empty string otherwise\n \"\"\"\n\n def _is_interactive():\n \"\"\"Decide whether this is running in a REPL or IPython notebook\"\"\"\n try:\n main = __import__(\"__main__\", None, None, fromlist=[\"__file__\"])\n except ModuleNotFoundError:\n return False\n return not hasattr(main, \"__file__\")\n\n if usecwd or _is_interactive() or getattr(sys, \"frozen\", False):\n # Should work without __file__, e.g. in REPL or IPython notebook.\n path = os.getcwd()\n else:\n # will work for .py files\n frame = sys._getframe()\n current_file = __file__\n\n while frame.f_code.co_filename == current_file or not os.path.exists(\n frame.f_code.co_filename\n ):\n assert frame.f_back is not None\n frame = frame.f_back\n frame_filename = frame.f_code.co_filename\n path = os.path.dirname(os.path.abspath(frame_filename))\n\n for dirname in _walk_to_root(path):\n check_path = os.path.join(dirname, filename)\n if os.path.isfile(check_path):\n return check_path\n\n if raise_error_if_not_found:\n raise IOError(\"File not found\")\n\n return \"\"\n\n\ndef load_dotenv(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n override: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> bool:\n \"\"\"Parse a .env file and then load all the variables found as environment variables.\n\n Parameters:\n dotenv_path: Absolute or relative path to .env file.\n stream: Text stream (such as `io.StringIO`) with .env content, used if\n `dotenv_path` is `None`.\n verbose: Whether to output a warning the .env file is missing.\n override: Whether to override the system environment variables with the variables\n from the `.env` file.\n encoding: Encoding to be used to read the file.\n Returns:\n Bool: True if at least one environment variable is set else False\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file with it's default parameters. If you need to change the default parameters\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\n to this function as `dotenv_path`.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n dotenv = DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=override,\n encoding=encoding,\n )\n return dotenv.set_as_environment_variables()\n\n\ndef dotenv_values(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> Dict[str, Optional[str]]:\n \"\"\"\n Parse a .env file and return its content as a dict.\n\n The returned dict will have `None` values for keys without values in the .env file.\n For example, `foo=bar` results in `{\"foo\": \"bar\"}` whereas `foo` alone results in\n `{\"foo\": None}`\n\n Parameters:\n dotenv_path: Absolute or relative path to the .env file.\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\n verbose: Whether to output a warning if the .env file is missing.\n encoding: Encoding to be used to read the file.\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n return DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=True,\n encoding=encoding,\n ).dict()\n\n[end of src/dotenv/main.py]","filename":"src/dotenv/main.py","id":"25"},{"content":"\"\"\"Entry point for cli, enables execution with `python -m dotenv`\"\"\"\n\nfrom .cli import cli\n\nif __name__ == \"__main__\":\n cli()\n\n[end of src/dotenv/__main__.py]","filename":"src/dotenv/__main__.py","id":"26"}],"string":"[\n {\n \"content\": \"site_name: python-dotenv\\nrepo_url: https://github.com/theskumar/python-dotenv\\nedit_uri: \\\"\\\"\\ntheme:\\n name: material\\n palette:\\n primary: green\\n features:\\n - toc.follow\\n - navigation.sections\\n\\nmarkdown_extensions:\\n - mdx_truly_sane_lists\\n\\nplugins:\\n - mkdocstrings:\\n handlers:\\n python:\\n rendering:\\n show_root_heading: yes\\n show_submodules: no\\n separate_signature: yes\\n - search\\nnav:\\n - Home: index.md\\n - Changelog: changelog.md\\n - Contributing: contributing.md\\n - Reference: reference.md\\n - License: license.md\\n\\n[end of mkdocs.yml]\",\n \"filename\": \"mkdocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"black~=22.3.0\\nbumpversion\\nclick\\nflake8>=2.2.3\\nipython\\npytest-cov\\npytest>=3.9\\nsh>=2\\ntox\\ntwine\\nwheel\\n\\n[end of requirements.txt]\",\n \"filename\": \"requirements.txt\",\n \"id\": \"2\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"3\"\n },\n {\n \"content\": \".PHONY: clean-pyc clean-build test\\n\\nclean: clean-build clean-pyc\\n\\nclean-build:\\n\\trm -fr build/\\n\\trm -fr dist/\\n\\trm -fr src/*.egg-info\\n\\nclean-pyc:\\n\\tfind . -name '*.pyc' -exec rm -f {} +\\n\\tfind . -name '*.pyo' -exec rm -f {} +\\n\\tfind . -name '*~' -exec rm -f {} +\\n\\nrelease: sdist\\n\\ttwine check dist/*\\n\\ttwine upload dist/*\\n\\nrelease-test: sdist\\n\\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\\n\\nsdist: clean\\n\\tpython setup.py sdist bdist_wheel\\n\\tls -l dist\\n\\ntest:\\n\\tpip install -e .\\n\\tflake8 .\\n\\tpy.test tests/\\n\\ncoverage:\\n\\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\\n\\tcoverage report\\n\\ncoverage-html: coverage\\n\\tcoverage html\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"4\"\n },\n {\n \"content\": \"mdx_truly_sane_lists~=1.2\\nmkdocs-include-markdown-plugin~=3.3.0\\nmkdocs-material~=8.2.9\\nmkdocstrings[python]~=0.18.1\\nmkdocs~=1.3.0\\n\\n[end of requirements-docs.txt]\",\n \"filename\": \"requirements-docs.txt\",\n \"id\": \"5\"\n },\n {\n \"content\": \"include LICENSE *.md *.yml *.toml\\n\\ninclude tox.ini\\nrecursive-include docs *.md\\nrecursive-include tests *.py\\n\\ninclude .bumpversion.cfg\\ninclude .coveragerc\\ninclude .editorconfig\\ninclude Makefile\\ninclude requirements.txt\\ninclude requirements-docs.txt\\ninclude src/dotenv/py.typed\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# see: http://editorconfig.org\\n\\nroot = true\\n\\n[*]\\ncharset = utf-8\\nend_of_line = lf\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\n\\n[*.{py,rst,ini}]\\nindent_style = space\\nindent_size = 4\\n\\n[*.yml]\\nindent_style = space\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"8\"\n },\n {\n \"content\": \"from setuptools import setup\\n\\n\\ndef read_files(files):\\n data = []\\n for file in files:\\n with open(file, encoding=\\\"utf-8\\\") as f:\\n data.append(f.read())\\n return \\\"\\\\n\\\".join(data)\\n\\n\\nlong_description = read_files([\\\"README.md\\\", \\\"CHANGELOG.md\\\"])\\n\\nmeta = {}\\nwith open(\\\"./src/dotenv/version.py\\\", encoding=\\\"utf-8\\\") as f:\\n exec(f.read(), meta)\\n\\nsetup(\\n name=\\\"python-dotenv\\\",\\n description=\\\"Read key-value pairs from a .env file and set them as environment variables\\\",\\n long_description=long_description,\\n long_description_content_type=\\\"text/markdown\\\",\\n version=meta[\\\"__version__\\\"],\\n author=\\\"Saurabh Kumar\\\",\\n author_email=\\\"me+github@saurabh-kumar.com\\\",\\n url=\\\"https://github.com/theskumar/python-dotenv\\\",\\n keywords=[\\n \\\"environment variables\\\",\\n \\\"deployments\\\",\\n \\\"settings\\\",\\n \\\"env\\\",\\n \\\"dotenv\\\",\\n \\\"configurations\\\",\\n \\\"python\\\",\\n ],\\n packages=[\\\"dotenv\\\"],\\n package_dir={\\\"\\\": \\\"src\\\"},\\n package_data={\\n \\\"dotenv\\\": [\\\"py.typed\\\"],\\n },\\n python_requires=\\\">=3.9\\\",\\n extras_require={\\n \\\"cli\\\": [\\n \\\"click>=5.0\\\",\\n ],\\n },\\n entry_points={\\n \\\"console_scripts\\\": [\\n \\\"dotenv=dotenv.__main__:cli\\\",\\n ],\\n },\\n license=\\\"BSD-3-Clause\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Programming Language :: Python :: 3.10\\\",\\n \\\"Programming Language :: Python :: 3.11\\\",\\n \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Topic :: System :: Systems Administration\\\",\\n \\\"Topic :: Utilities\\\",\\n \\\"Environment :: Web Environment\\\",\\n ],\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of CONTRIBUTING.md]\",\n \"filename\": \"CONTRIBUTING.md\",\n \"id\": \"10\"\n },\n {\n \"content\": \"[tox]\\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\\n\\n[gh-actions]\\npython =\\n 3.9: py39\\n 3.10: py310\\n 3.11: py311\\n 3.12: py312\\n 3.13: py313, lint, manifest\\n pypy-3.9: pypy3\\n\\n[testenv]\\ndeps =\\n pytest\\n pytest-cov\\n sh >= 2.0.2, <3\\n click\\n py{39,310,311,312,313,pypy3}: ipython\\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\\ndepends =\\n py{39,310,311,312,313},pypy3: coverage-clean\\n coverage-report: py{39,310,311,312,313},pypy3\\n\\n[testenv:lint]\\nskip_install = true\\ndeps =\\n flake8\\n mypy\\ncommands =\\n flake8 src tests\\n mypy --python-version=3.13 src tests\\n mypy --python-version=3.12 src tests\\n mypy --python-version=3.11 src tests\\n mypy --python-version=3.10 src tests\\n mypy --python-version=3.9 src tests\\n\\n[testenv:manifest]\\ndeps = check-manifest\\nskip_install = true\\ncommands = check-manifest\\n\\n[testenv:coverage-clean]\\ndeps = coverage\\nskip_install = true\\ncommands = coverage erase\\n\\n[testenv:coverage-report]\\ndeps = coverage\\nskip_install = true\\ncommands =\\n coverage report\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"11\"\n },\n {\n \"content\": \"[bumpversion]\\ncurrent_version = 1.0.1\\ncommit = True\\ntag = True\\n\\n[bumpversion:file:src/dotenv/version.py]\\n\\n[flake8]\\nmax-line-length = 120\\nexclude = .tox,.git,docs,venv,.venv,build\\n\\n[mypy]\\ncheck_untyped_defs = true\\nignore_missing_imports = true\\n\\n[metadata]\\ndescription_file = README.md\\n\\n[tool:pytest]\\ntestpaths = tests\\n\\n[coverage:run]\\nrelative_files = True\\nsource = dotenv\\n\\n[coverage:paths]\\nsource =\\n\\tsrc/dotenv\\n\\t.tox/*/lib/python*/site-packages/dotenv\\n\\t.tox/pypy*/site-packages/dotenv\\n\\n[coverage:report]\\nshow_missing = True\\ninclude = */site-packages/dotenv/*\\nexclude_lines =\\n\\tif IS_TYPE_CHECKING:\\n\\tpragma: no cover\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of docs/license.md]\",\n \"filename\": \"docs/license.md\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# ::: dotenv\\n\\n\\n[end of docs/reference.md]\",\n \"filename\": \"docs/reference.md\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of docs/changelog.md]\",\n \"filename\": \"docs/changelog.md\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of docs/index.md]\",\n \"filename\": \"docs/index.md\",\n \"id\": \"16\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of docs/contributing.md]\",\n \"filename\": \"docs/contributing.md\",\n \"id\": \"17\"\n },\n {\n \"content\": \"__version__ = \\\"1.0.1\\\"\\n\\n[end of src/dotenv/version.py]\",\n \"filename\": \"src/dotenv/version.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"import re\\nfrom abc import ABCMeta, abstractmethod\\nfrom typing import Iterator, Mapping, Optional, Pattern\\n\\n_posix_variable: Pattern[str] = re.compile(\\n r\\\"\\\"\\\"\\n \\\\$\\\\{\\n (?P<name>[^\\\\}:]*)\\n (?::-\\n (?P<default>[^\\\\}]*)\\n )?\\n \\\\}\\n \\\"\\\"\\\",\\n re.VERBOSE,\\n)\\n\\n\\nclass Atom(metaclass=ABCMeta):\\n def __ne__(self, other: object) -> bool:\\n result = self.__eq__(other)\\n if result is NotImplemented:\\n return NotImplemented\\n return not result\\n\\n @abstractmethod\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\\n\\n\\nclass Literal(Atom):\\n def __init__(self, value: str) -> None:\\n self.value = value\\n\\n def __repr__(self) -> str:\\n return f\\\"Literal(value={self.value})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return self.value == other.value\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.value))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n return self.value\\n\\n\\nclass Variable(Atom):\\n def __init__(self, name: str, default: Optional[str]) -> None:\\n self.name = name\\n self.default = default\\n\\n def __repr__(self) -> str:\\n return f\\\"Variable(name={self.name}, default={self.default})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return (self.name, self.default) == (other.name, other.default)\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.name, self.default))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n default = self.default if self.default is not None else \\\"\\\"\\n result = env.get(self.name, default)\\n return result if result is not None else \\\"\\\"\\n\\n\\ndef parse_variables(value: str) -> Iterator[Atom]:\\n cursor = 0\\n\\n for match in _posix_variable.finditer(value):\\n (start, end) = match.span()\\n name = match[\\\"name\\\"]\\n default = match[\\\"default\\\"]\\n\\n if start > cursor:\\n yield Literal(value=value[cursor:start])\\n\\n yield Variable(name=name, default=default)\\n cursor = end\\n\\n length = len(value)\\n if cursor < length:\\n yield Literal(value=value[cursor:length])\\n\\n[end of src/dotenv/variables.py]\",\n \"filename\": \"src/dotenv/variables.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from typing import Any, Optional\\n\\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\\n unset_key)\\n\\n\\ndef load_ipython_extension(ipython: Any) -> None:\\n from .ipython import load_ipython_extension\\n load_ipython_extension(ipython)\\n\\n\\ndef get_cli_string(\\n path: Optional[str] = None,\\n action: Optional[str] = None,\\n key: Optional[str] = None,\\n value: Optional[str] = None,\\n quote: Optional[str] = None,\\n):\\n \\\"\\\"\\\"Returns a string suitable for running as a shell script.\\n\\n Useful for converting a arguments passed to a fabric task\\n to be passed to a `local` or `run` command.\\n \\\"\\\"\\\"\\n command = ['dotenv']\\n if quote:\\n command.append(f'-q {quote}')\\n if path:\\n command.append(f'-f {path}')\\n if action:\\n command.append(action)\\n if key:\\n command.append(key)\\n if value:\\n if ' ' in value:\\n command.append(f'\\\"{value}\\\"')\\n else:\\n command.append(value)\\n\\n return ' '.join(command).strip()\\n\\n\\n__all__ = ['get_cli_string',\\n 'load_dotenv',\\n 'dotenv_values',\\n 'get_key',\\n 'set_key',\\n 'unset_key',\\n 'find_dotenv',\\n 'load_ipython_extension']\\n\\n[end of src/dotenv/__init__.py]\",\n \"filename\": \"src/dotenv/__init__.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"import codecs\\nimport re\\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\\n Pattern, Sequence, Tuple)\\n\\n\\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\\n return re.compile(string, re.UNICODE | extra_flags)\\n\\n\\n_newline = make_regex(r\\\"(\\\\r\\\\n|\\\\n|\\\\r)\\\")\\n_multiline_whitespace = make_regex(r\\\"\\\\s*\\\", extra_flags=re.MULTILINE)\\n_whitespace = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*\\\")\\n_export = make_regex(r\\\"(?:export[^\\\\S\\\\r\\\\n]+)?\\\")\\n_single_quoted_key = make_regex(r\\\"'([^']+)'\\\")\\n_unquoted_key = make_regex(r\\\"([^=\\\\#\\\\s]+)\\\")\\n_equal_sign = make_regex(r\\\"(=[^\\\\S\\\\r\\\\n]*)\\\")\\n_single_quoted_value = make_regex(r\\\"'((?:\\\\\\\\'|[^'])*)'\\\")\\n_double_quoted_value = make_regex(r'\\\"((?:\\\\\\\\\\\"|[^\\\"])*)\\\"')\\n_unquoted_value = make_regex(r\\\"([^\\\\r\\\\n]*)\\\")\\n_comment = make_regex(r\\\"(?:[^\\\\S\\\\r\\\\n]*#[^\\\\r\\\\n]*)?\\\")\\n_end_of_line = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*(?:\\\\r\\\\n|\\\\n|\\\\r|$)\\\")\\n_rest_of_line = make_regex(r\\\"[^\\\\r\\\\n]*(?:\\\\r|\\\\n|\\\\r\\\\n)?\\\")\\n_double_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\'\\\\\\\"abfnrtv]\\\")\\n_single_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\']\\\")\\n\\n\\nclass Original(NamedTuple):\\n string: str\\n line: int\\n\\n\\nclass Binding(NamedTuple):\\n key: Optional[str]\\n value: Optional[str]\\n original: Original\\n error: bool\\n\\n\\nclass Position:\\n def __init__(self, chars: int, line: int) -> None:\\n self.chars = chars\\n self.line = line\\n\\n @classmethod\\n def start(cls) -> \\\"Position\\\":\\n return cls(chars=0, line=1)\\n\\n def set(self, other: \\\"Position\\\") -> None:\\n self.chars = other.chars\\n self.line = other.line\\n\\n def advance(self, string: str) -> None:\\n self.chars += len(string)\\n self.line += len(re.findall(_newline, string))\\n\\n\\nclass Error(Exception):\\n pass\\n\\n\\nclass Reader:\\n def __init__(self, stream: IO[str]) -> None:\\n self.string = stream.read()\\n self.position = Position.start()\\n self.mark = Position.start()\\n\\n def has_next(self) -> bool:\\n return self.position.chars < len(self.string)\\n\\n def set_mark(self) -> None:\\n self.mark.set(self.position)\\n\\n def get_marked(self) -> Original:\\n return Original(\\n string=self.string[self.mark.chars:self.position.chars],\\n line=self.mark.line,\\n )\\n\\n def peek(self, count: int) -> str:\\n return self.string[self.position.chars:self.position.chars + count]\\n\\n def read(self, count: int) -> str:\\n result = self.string[self.position.chars:self.position.chars + count]\\n if len(result) < count:\\n raise Error(\\\"read: End of string\\\")\\n self.position.advance(result)\\n return result\\n\\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\\n match = regex.match(self.string, self.position.chars)\\n if match is None:\\n raise Error(\\\"read_regex: Pattern not found\\\")\\n self.position.advance(self.string[match.start():match.end()])\\n return match.groups()\\n\\n\\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\\n def decode_match(match: Match[str]) -> str:\\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\\n\\n return regex.sub(decode_match, string)\\n\\n\\ndef parse_key(reader: Reader) -> Optional[str]:\\n char = reader.peek(1)\\n if char == \\\"#\\\":\\n return None\\n elif char == \\\"'\\\":\\n (key,) = reader.read_regex(_single_quoted_key)\\n else:\\n (key,) = reader.read_regex(_unquoted_key)\\n return key\\n\\n\\ndef parse_unquoted_value(reader: Reader) -> str:\\n (part,) = reader.read_regex(_unquoted_value)\\n return re.sub(r\\\"\\\\s+#.*\\\", \\\"\\\", part).rstrip()\\n\\n\\ndef parse_value(reader: Reader) -> str:\\n char = reader.peek(1)\\n if char == u\\\"'\\\":\\n (value,) = reader.read_regex(_single_quoted_value)\\n return decode_escapes(_single_quote_escapes, value)\\n elif char == u'\\\"':\\n (value,) = reader.read_regex(_double_quoted_value)\\n return decode_escapes(_double_quote_escapes, value)\\n elif char in (u\\\"\\\", u\\\"\\\\n\\\", u\\\"\\\\r\\\"):\\n return u\\\"\\\"\\n else:\\n return parse_unquoted_value(reader)\\n\\n\\ndef parse_binding(reader: Reader) -> Binding:\\n reader.set_mark()\\n try:\\n reader.read_regex(_multiline_whitespace)\\n if not reader.has_next():\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=False,\\n )\\n reader.read_regex(_export)\\n key = parse_key(reader)\\n reader.read_regex(_whitespace)\\n if reader.peek(1) == \\\"=\\\":\\n reader.read_regex(_equal_sign)\\n value: Optional[str] = parse_value(reader)\\n else:\\n value = None\\n reader.read_regex(_comment)\\n reader.read_regex(_end_of_line)\\n return Binding(\\n key=key,\\n value=value,\\n original=reader.get_marked(),\\n error=False,\\n )\\n except Error:\\n reader.read_regex(_rest_of_line)\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=True,\\n )\\n\\n\\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\\n reader = Reader(stream)\\n while reader.has_next():\\n yield parse_binding(reader)\\n\\n[end of src/dotenv/parser.py]\",\n \"filename\": \"src/dotenv/parser.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \"import json\\nimport os\\nimport shlex\\nimport sys\\nfrom contextlib import contextmanager\\nfrom typing import Any, Dict, IO, Iterator, List, Optional\\n\\ntry:\\n import click\\nexcept ImportError:\\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\\\n'\\n 'Run pip install \\\"python-dotenv[cli]\\\" to fix this.')\\n sys.exit(1)\\n\\nfrom .main import dotenv_values, set_key, unset_key\\nfrom .version import __version__\\n\\n\\ndef enumerate_env() -> Optional[str]:\\n \\\"\\\"\\\"\\n Return a path for the ${pwd}/.env file.\\n\\n If pwd does not exist, return None.\\n \\\"\\\"\\\"\\n try:\\n cwd = os.getcwd()\\n except FileNotFoundError:\\n return None\\n path = os.path.join(cwd, '.env')\\n return path\\n\\n\\n@click.group()\\n@click.option('-f', '--file', default=enumerate_env(),\\n type=click.Path(file_okay=True),\\n help=\\\"Location of the .env file, defaults to .env file in current working directory.\\\")\\n@click.option('-q', '--quote', default='always',\\n type=click.Choice(['always', 'never', 'auto']),\\n help=\\\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\\\")\\n@click.option('-e', '--export', default=False,\\n type=click.BOOL,\\n help=\\\"Whether to write the dot file as an executable bash script.\\\")\\n@click.version_option(version=__version__)\\n@click.pass_context\\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\\n \\\"\\\"\\\"This script is used to set, get or unset values from a .env file.\\\"\\\"\\\"\\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\\n\\n\\n@contextmanager\\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\\n \\\"\\\"\\\"\\n Open a file and yield the corresponding (decoded) stream.\\n\\n Exits with error code 2 if the file cannot be opened.\\n \\\"\\\"\\\"\\n\\n try:\\n with open(path) as stream:\\n yield stream\\n except OSError as exc:\\n print(f\\\"Error opening env file: {exc}\\\", file=sys.stderr)\\n exit(2)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.option('--format', default='simple',\\n type=click.Choice(['simple', 'json', 'shell', 'export']),\\n help=\\\"The format in which to display the list. Default format is simple, \\\"\\n \\\"which displays name=value without quotes.\\\")\\ndef list(ctx: click.Context, format: bool) -> None:\\n \\\"\\\"\\\"Display all the stored key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n if format == 'json':\\n click.echo(json.dumps(values, indent=2, sort_keys=True))\\n else:\\n prefix = 'export ' if format == 'export' else ''\\n for k in sorted(values):\\n v = values[k]\\n if v is not None:\\n if format in ('export', 'shell'):\\n v = shlex.quote(v)\\n click.echo(f'{prefix}{k}={v}')\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\n@click.argument('value', required=True)\\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\\n \\\"\\\"\\\"Store the given key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n export = ctx.obj['EXPORT']\\n success, key, value = set_key(file, key, value, quote, export)\\n if success:\\n click.echo(f'{key}={value}')\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef get(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Retrieve the value for the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n stored_value = values.get(key)\\n if stored_value:\\n click.echo(stored_value)\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef unset(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Removes the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n success, key = unset_key(file, key, quote)\\n if success:\\n click.echo(f\\\"Successfully removed {key}\\\")\\n else:\\n exit(1)\\n\\n\\n@cli.command(context_settings={'ignore_unknown_options': True})\\n@click.pass_context\\n@click.option(\\n \\\"--override/--no-override\\\",\\n default=True,\\n help=\\\"Override variables from the environment file with those from the .env file.\\\",\\n)\\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\\n \\\"\\\"\\\"Run command with environment variables present.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n if not os.path.isfile(file):\\n raise click.BadParameter(\\n f'Invalid value for \\\\'-f\\\\' \\\"{file}\\\" does not exist.',\\n ctx=ctx\\n )\\n dotenv_as_dict = {\\n k: v\\n for (k, v) in dotenv_values(file).items()\\n if v is not None and (override or k not in os.environ)\\n }\\n\\n if not commandline:\\n click.echo('No command given.')\\n exit(1)\\n run_command(commandline, dotenv_as_dict)\\n\\n\\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\\n \\\"\\\"\\\"Replace the current process with the specified command.\\n\\n Replaces the current process with the specified command and the variables from `env`\\n added in the current environment variables.\\n\\n Parameters\\n ----------\\n command: List[str]\\n The command and it's parameters\\n env: Dict\\n The additional environment variables\\n\\n Returns\\n -------\\n None\\n This function does not return any value. It replaces the current process with the new one.\\n\\n \\\"\\\"\\\"\\n # copy the current environment variables and add the vales from\\n # `env`\\n cmd_env = os.environ.copy()\\n cmd_env.update(env)\\n\\n os.execvpe(command[0], args=command, env=cmd_env)\\n\\n[end of src/dotenv/cli.py]\",\n \"filename\": \"src/dotenv/cli.py\",\n \"id\": \"22\"\n },\n {\n \"content\": \"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\\n parse_argstring) # type: ignore\\n\\nfrom .main import find_dotenv, load_dotenv\\n\\n\\n@magics_class\\nclass IPythonDotEnv(Magics):\\n\\n @magic_arguments()\\n @argument(\\n '-o', '--override', action='store_true',\\n help=\\\"Indicate to override existing variables\\\"\\n )\\n @argument(\\n '-v', '--verbose', action='store_true',\\n help=\\\"Indicate function calls to be verbose\\\"\\n )\\n @argument('dotenv_path', nargs='?', type=str, default='.env',\\n help='Search in increasingly higher folders for the `dotenv_path`')\\n @line_magic\\n def dotenv(self, line):\\n args = parse_argstring(self.dotenv, line)\\n # Locate the .env file\\n dotenv_path = args.dotenv_path\\n try:\\n dotenv_path = find_dotenv(dotenv_path, True, True)\\n except IOError:\\n print(\\\"cannot find .env file\\\")\\n return\\n\\n # Load the .env file\\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\\n\\n\\ndef load_ipython_extension(ipython):\\n \\\"\\\"\\\"Register the %dotenv magic.\\\"\\\"\\\"\\n ipython.register_magics(IPythonDotEnv)\\n\\n[end of src/dotenv/ipython.py]\",\n \"filename\": \"src/dotenv/ipython.py\",\n \"id\": \"23\"\n },\n {\n \"content\": \"# Marker file for PEP 561\\n\\n[end of src/dotenv/py.typed]\",\n \"filename\": \"src/dotenv/py.typed\",\n \"id\": \"24\"\n },\n {\n \"content\": \"import io\\nimport logging\\nimport os\\nimport pathlib\\nimport shutil\\nimport sys\\nimport tempfile\\nfrom collections import OrderedDict\\nfrom contextlib import contextmanager\\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\\n\\nfrom .parser import Binding, parse_stream\\nfrom .variables import parse_variables\\n\\n# A type alias for a string path to be used for the paths in this file.\\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\\n# only accepts string paths, not byte paths or file descriptors. See\\n# https://github.com/python/typeshed/pull/6832.\\nStrPath = Union[str, \\\"os.PathLike[str]\\\"]\\n\\nlogger = logging.getLogger(__name__)\\n\\n\\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\\n for mapping in mappings:\\n if mapping.error:\\n logger.warning(\\n \\\"python-dotenv could not parse statement starting at line %s\\\",\\n mapping.original.line,\\n )\\n yield mapping\\n\\n\\nclass DotEnv:\\n def __init__(\\n self,\\n dotenv_path: Optional[StrPath],\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n encoding: Optional[str] = None,\\n interpolate: bool = True,\\n override: bool = True,\\n ) -> None:\\n self.dotenv_path: Optional[StrPath] = dotenv_path\\n self.stream: Optional[IO[str]] = stream\\n self._dict: Optional[Dict[str, Optional[str]]] = None\\n self.verbose: bool = verbose\\n self.encoding: Optional[str] = encoding\\n self.interpolate: bool = interpolate\\n self.override: bool = override\\n\\n @contextmanager\\n def _get_stream(self) -> Iterator[IO[str]]:\\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\\n with open(self.dotenv_path, encoding=self.encoding) as stream:\\n yield stream\\n elif self.stream is not None:\\n yield self.stream\\n else:\\n if self.verbose:\\n logger.info(\\n \\\"python-dotenv could not find configuration file %s.\\\",\\n self.dotenv_path or \\\".env\\\",\\n )\\n yield io.StringIO(\\\"\\\")\\n\\n def dict(self) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"Return dotenv as dict\\\"\\\"\\\"\\n if self._dict:\\n return self._dict\\n\\n raw_values = self.parse()\\n\\n if self.interpolate:\\n self._dict = OrderedDict(\\n resolve_variables(raw_values, override=self.override)\\n )\\n else:\\n self._dict = OrderedDict(raw_values)\\n\\n return self._dict\\n\\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\\n with self._get_stream() as stream:\\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\\n if mapping.key is not None:\\n yield mapping.key, mapping.value\\n\\n def set_as_environment_variables(self) -> bool:\\n \\\"\\\"\\\"\\n Load the current dotenv as system environment variable.\\n \\\"\\\"\\\"\\n if not self.dict():\\n return False\\n\\n for k, v in self.dict().items():\\n if k in os.environ and not self.override:\\n continue\\n if v is not None:\\n os.environ[k] = v\\n\\n return True\\n\\n def get(self, key: str) -> Optional[str]:\\n \\\"\\\"\\\" \\\"\\\"\\\"\\n data = self.dict()\\n\\n if key in data:\\n return data[key]\\n\\n if self.verbose:\\n logger.warning(\\\"Key %s not found in %s.\\\", key, self.dotenv_path)\\n\\n return None\\n\\n\\ndef get_key(\\n dotenv_path: StrPath,\\n key_to_get: str,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Optional[str]:\\n \\\"\\\"\\\"\\n Get the value of a given key from the given .env.\\n\\n Returns `None` if the key isn't found or doesn't have a value.\\n \\\"\\\"\\\"\\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\\n\\n\\n@contextmanager\\ndef rewrite(\\n path: StrPath,\\n encoding: Optional[str],\\n) -> Iterator[Tuple[IO[str], IO[str]]]:\\n pathlib.Path(path).touch()\\n\\n with tempfile.NamedTemporaryFile(mode=\\\"w\\\", encoding=encoding, delete=False) as dest:\\n error = None\\n try:\\n with open(path, encoding=encoding) as source:\\n yield (source, dest)\\n except BaseException as err:\\n error = err\\n\\n if error is None:\\n shutil.move(dest.name, path)\\n else:\\n os.unlink(dest.name)\\n raise error from None\\n\\n\\ndef set_key(\\n dotenv_path: StrPath,\\n key_to_set: str,\\n value_to_set: str,\\n quote_mode: str = \\\"always\\\",\\n export: bool = False,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str, str]:\\n \\\"\\\"\\\"\\n Adds or Updates a key/value to the given .env\\n\\n If the .env path given doesn't exist, fails instead of risking creating\\n an orphan .env somewhere in the filesystem\\n \\\"\\\"\\\"\\n if quote_mode not in (\\\"always\\\", \\\"auto\\\", \\\"never\\\"):\\n raise ValueError(f\\\"Unknown quote_mode: {quote_mode}\\\")\\n\\n quote = quote_mode == \\\"always\\\" or (\\n quote_mode == \\\"auto\\\" and not value_to_set.isalnum()\\n )\\n\\n if quote:\\n value_out = \\\"'{}'\\\".format(value_to_set.replace(\\\"'\\\", \\\"\\\\\\\\'\\\"))\\n else:\\n value_out = value_to_set\\n if export:\\n line_out = f\\\"export {key_to_set}={value_out}\\\\n\\\"\\n else:\\n line_out = f\\\"{key_to_set}={value_out}\\\\n\\\"\\n\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n replaced = False\\n missing_newline = False\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_set:\\n dest.write(line_out)\\n replaced = True\\n else:\\n dest.write(mapping.original.string)\\n missing_newline = not mapping.original.string.endswith(\\\"\\\\n\\\")\\n if not replaced:\\n if missing_newline:\\n dest.write(\\\"\\\\n\\\")\\n dest.write(line_out)\\n\\n return True, key_to_set, value_to_set\\n\\n\\ndef unset_key(\\n dotenv_path: StrPath,\\n key_to_unset: str,\\n quote_mode: str = \\\"always\\\",\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str]:\\n \\\"\\\"\\\"\\n Removes a given key from the given `.env` file.\\n\\n If the .env path given doesn't exist, fails.\\n If the given key doesn't exist in the .env, fails.\\n \\\"\\\"\\\"\\n if not os.path.exists(dotenv_path):\\n logger.warning(\\\"Can't delete from %s - it doesn't exist.\\\", dotenv_path)\\n return None, key_to_unset\\n\\n removed = False\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_unset:\\n removed = True\\n else:\\n dest.write(mapping.original.string)\\n\\n if not removed:\\n logger.warning(\\n \\\"Key %s not removed from %s - key doesn't exist.\\\", key_to_unset, dotenv_path\\n )\\n return None, key_to_unset\\n\\n return removed, key_to_unset\\n\\n\\ndef resolve_variables(\\n values: Iterable[Tuple[str, Optional[str]]],\\n override: bool,\\n) -> Mapping[str, Optional[str]]:\\n new_values: Dict[str, Optional[str]] = {}\\n\\n for name, value in values:\\n if value is None:\\n result = None\\n else:\\n atoms = parse_variables(value)\\n env: Dict[str, Optional[str]] = {}\\n if override:\\n env.update(os.environ) # type: ignore\\n env.update(new_values)\\n else:\\n env.update(new_values)\\n env.update(os.environ) # type: ignore\\n result = \\\"\\\".join(atom.resolve(env) for atom in atoms)\\n\\n new_values[name] = result\\n\\n return new_values\\n\\n\\ndef _walk_to_root(path: str) -> Iterator[str]:\\n \\\"\\\"\\\"\\n Yield directories starting from the given directory up to the root\\n \\\"\\\"\\\"\\n if not os.path.exists(path):\\n raise IOError(\\\"Starting path not found\\\")\\n\\n if os.path.isfile(path):\\n path = os.path.dirname(path)\\n\\n last_dir = None\\n current_dir = os.path.abspath(path)\\n while last_dir != current_dir:\\n yield current_dir\\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\\n last_dir, current_dir = current_dir, parent_dir\\n\\n\\ndef find_dotenv(\\n filename: str = \\\".env\\\",\\n raise_error_if_not_found: bool = False,\\n usecwd: bool = False,\\n) -> str:\\n \\\"\\\"\\\"\\n Search in increasingly higher folders for the given file\\n\\n Returns path to the file if found, or an empty string otherwise\\n \\\"\\\"\\\"\\n\\n def _is_interactive():\\n \\\"\\\"\\\"Decide whether this is running in a REPL or IPython notebook\\\"\\\"\\\"\\n try:\\n main = __import__(\\\"__main__\\\", None, None, fromlist=[\\\"__file__\\\"])\\n except ModuleNotFoundError:\\n return False\\n return not hasattr(main, \\\"__file__\\\")\\n\\n if usecwd or _is_interactive() or getattr(sys, \\\"frozen\\\", False):\\n # Should work without __file__, e.g. in REPL or IPython notebook.\\n path = os.getcwd()\\n else:\\n # will work for .py files\\n frame = sys._getframe()\\n current_file = __file__\\n\\n while frame.f_code.co_filename == current_file or not os.path.exists(\\n frame.f_code.co_filename\\n ):\\n assert frame.f_back is not None\\n frame = frame.f_back\\n frame_filename = frame.f_code.co_filename\\n path = os.path.dirname(os.path.abspath(frame_filename))\\n\\n for dirname in _walk_to_root(path):\\n check_path = os.path.join(dirname, filename)\\n if os.path.isfile(check_path):\\n return check_path\\n\\n if raise_error_if_not_found:\\n raise IOError(\\\"File not found\\\")\\n\\n return \\\"\\\"\\n\\n\\ndef load_dotenv(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n override: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> bool:\\n \\\"\\\"\\\"Parse a .env file and then load all the variables found as environment variables.\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to .env file.\\n stream: Text stream (such as `io.StringIO`) with .env content, used if\\n `dotenv_path` is `None`.\\n verbose: Whether to output a warning the .env file is missing.\\n override: Whether to override the system environment variables with the variables\\n from the `.env` file.\\n encoding: Encoding to be used to read the file.\\n Returns:\\n Bool: True if at least one environment variable is set else False\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file with it's default parameters. If you need to change the default parameters\\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\\n to this function as `dotenv_path`.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n dotenv = DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=override,\\n encoding=encoding,\\n )\\n return dotenv.set_as_environment_variables()\\n\\n\\ndef dotenv_values(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"\\n Parse a .env file and return its content as a dict.\\n\\n The returned dict will have `None` values for keys without values in the .env file.\\n For example, `foo=bar` results in `{\\\"foo\\\": \\\"bar\\\"}` whereas `foo` alone results in\\n `{\\\"foo\\\": None}`\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to the .env file.\\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\\n verbose: Whether to output a warning if the .env file is missing.\\n encoding: Encoding to be used to read the file.\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n return DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=True,\\n encoding=encoding,\\n ).dict()\\n\\n[end of src/dotenv/main.py]\",\n \"filename\": \"src/dotenv/main.py\",\n \"id\": \"25\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Entry point for cli, enables execution with `python -m dotenv`\\\"\\\"\\\"\\n\\nfrom .cli import cli\\n\\nif __name__ == \\\"__main__\\\":\\n cli()\\n\\n[end of src/dotenv/__main__.py]\",\n \"filename\": \"src/dotenv/__main__.py\",\n \"id\": \"26\"\n }\n]","isConversational":false}}},{"rowIdx":61,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 61,\n \"num_files\": 27,\n \"repo_id\": \"repo_0061\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n handlers:\n python:\n rendering:\n show_root_heading: yes\n show_submodules: no\n separate_signature: yes\n - search\nnav:\n - Home: index.md\n - Changelog: changelog.md\n - Contributing: contributing.md\n - Reference: reference.md\n - License: license.md\n\n[end of mkdocs.yml]","filename":"mkdocs.yml","id":"0"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"black~=22.3.0\nbumpversion\nclick\nflake8>=2.2.3\nipython\npytest-cov\npytest>=3.9\nsh>=2\ntox\ntwine\nwheel\n\n[end of requirements.txt]","filename":"requirements.txt","id":"2"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"3"},{"content":".PHONY: clean-pyc clean-build test\n\nclean: clean-build clean-pyc\n\nclean-build:\n\trm -fr build/\n\trm -fr dist/\n\trm -fr src/*.egg-info\n\nclean-pyc:\n\tfind . -name '*.pyc' -exec rm -f {} +\n\tfind . -name '*.pyo' -exec rm -f {} +\n\tfind . -name '*~' -exec rm -f {} +\n\nrelease: sdist\n\ttwine check dist/*\n\ttwine upload dist/*\n\nrelease-test: sdist\n\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\n\nsdist: clean\n\tpython setup.py sdist bdist_wheel\n\tls -l dist\n\ntest:\n\tpip install -e .\n\tflake8 .\n\tpy.test tests/\n\ncoverage:\n\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\n\tcoverage report\n\ncoverage-html: coverage\n\tcoverage html\n\n[end of Makefile]","filename":"Makefile","id":"4"},{"content":"mdx_truly_sane_lists~=1.2\nmkdocs-include-markdown-plugin~=3.3.0\nmkdocs-material~=8.2.9\nmkdocstrings[python]~=0.18.1\nmkdocs~=1.3.0\n\n[end of requirements-docs.txt]","filename":"requirements-docs.txt","id":"5"},{"content":"include LICENSE *.md *.yml *.toml\n\ninclude tox.ini\nrecursive-include docs *.md\nrecursive-include tests *.py\n\ninclude .bumpversion.cfg\ninclude .coveragerc\ninclude .editorconfig\ninclude Makefile\ninclude requirements.txt\ninclude requirements-docs.txt\ninclude src/dotenv/py.typed\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"6"},{"content":"# see: http://editorconfig.org\n\nroot = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.{py,rst,ini}]\nindent_style = space\nindent_size = 4\n\n[*.yml]\nindent_style = space\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"7"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of README.md]","filename":"README.md","id":"8"},{"content":"from setuptools import setup\n\n\ndef read_files(files):\n data = []\n for file in files:\n with open(file, encoding=\"utf-8\") as f:\n data.append(f.read())\n return \"\\n\".join(data)\n\n\nlong_description = read_files([\"README.md\", \"CHANGELOG.md\"])\n\nmeta = {}\nwith open(\"./src/dotenv/version.py\", encoding=\"utf-8\") as f:\n exec(f.read(), meta)\n\nsetup(\n name=\"python-dotenv\",\n description=\"Read key-value pairs from a .env file and set them as environment variables\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n version=meta[\"__version__\"],\n author=\"Saurabh Kumar\",\n author_email=\"me+github@saurabh-kumar.com\",\n url=\"https://github.com/theskumar/python-dotenv\",\n keywords=[\n \"environment variables\",\n \"deployments\",\n \"settings\",\n \"env\",\n \"dotenv\",\n \"configurations\",\n \"python\",\n ],\n packages=[\"dotenv\"],\n package_dir={\"\": \"src\"},\n package_data={\n \"dotenv\": [\"py.typed\"],\n },\n python_requires=\">=3.9\",\n extras_require={\n \"cli\": [\n \"click>=5.0\",\n ],\n },\n entry_points={\n \"console_scripts\": [\n \"dotenv=dotenv.__main__:cli\",\n ],\n },\n license=\"BSD-3-Clause\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Topic :: System :: Systems Administration\",\n \"Topic :: Utilities\",\n \"Environment :: Web Environment\",\n ],\n)\n\n[end of setup.py]","filename":"setup.py","id":"9"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of CONTRIBUTING.md]","filename":"CONTRIBUTING.md","id":"10"},{"content":"[tox]\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\n\n[gh-actions]\npython =\n 3.9: py39\n 3.10: py310\n 3.11: py311\n 3.12: py312\n 3.13: py313, lint, manifest\n pypy-3.9: pypy3\n\n[testenv]\ndeps =\n pytest\n pytest-cov\n sh >= 2.0.2, <3\n click\n py{39,310,311,312,313,pypy3}: ipython\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\ndepends =\n py{39,310,311,312,313},pypy3: coverage-clean\n coverage-report: py{39,310,311,312,313},pypy3\n\n[testenv:lint]\nskip_install = true\ndeps =\n flake8\n mypy\ncommands =\n flake8 src tests\n mypy --python-version=3.13 src tests\n mypy --python-version=3.12 src tests\n mypy --python-version=3.11 src tests\n mypy --python-version=3.10 src tests\n mypy --python-version=3.9 src tests\n\n[testenv:manifest]\ndeps = check-manifest\nskip_install = true\ncommands = check-manifest\n\n[testenv:coverage-clean]\ndeps = coverage\nskip_install = true\ncommands = coverage erase\n\n[testenv:coverage-report]\ndeps = coverage\nskip_install = true\ncommands =\n coverage report\n\n[end of tox.ini]","filename":"tox.ini","id":"11"},{"content":"[bumpversion]\ncurrent_version = 1.0.1\ncommit = True\ntag = True\n\n[bumpversion:file:src/dotenv/version.py]\n\n[flake8]\nmax-line-length = 120\nexclude = .tox,.git,docs,venv,.venv,build\n\n[mypy]\ncheck_untyped_defs = true\nignore_missing_imports = true\n\n[metadata]\ndescription_file = README.md\n\n[tool:pytest]\ntestpaths = tests\n\n[coverage:run]\nrelative_files = True\nsource = dotenv\n\n[coverage:paths]\nsource =\n\tsrc/dotenv\n\t.tox/*/lib/python*/site-packages/dotenv\n\t.tox/pypy*/site-packages/dotenv\n\n[coverage:report]\nshow_missing = True\ninclude = */site-packages/dotenv/*\nexclude_lines =\n\tif IS_TYPE_CHECKING:\n\tpragma: no cover\n\n[end of setup.cfg]","filename":"setup.cfg","id":"12"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of docs/license.md]","filename":"docs/license.md","id":"13"},{"content":"# ::: dotenv\n\n\n[end of docs/reference.md]","filename":"docs/reference.md","id":"14"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of docs/changelog.md]","filename":"docs/changelog.md","id":"15"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of docs/index.md]","filename":"docs/index.md","id":"16"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of docs/contributing.md]","filename":"docs/contributing.md","id":"17"},{"content":"__version__ = \"1.0.1\"\n\n[end of src/dotenv/version.py]","filename":"src/dotenv/version.py","id":"18"},{"content":"import re\nfrom abc import ABCMeta, abstractmethod\nfrom typing import Iterator, Mapping, Optional, Pattern\n\n_posix_variable: Pattern[str] = re.compile(\n r\"\"\"\n \\$\\{\n (?P<name>[^\\}:]*)\n (?::-\n (?P<default>[^\\}]*)\n )?\n \\}\n \"\"\",\n re.VERBOSE,\n)\n\n\nclass Atom(metaclass=ABCMeta):\n def __ne__(self, other: object) -> bool:\n result = self.__eq__(other)\n if result is NotImplemented:\n return NotImplemented\n return not result\n\n @abstractmethod\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\n\n\nclass Literal(Atom):\n def __init__(self, value: str) -> None:\n self.value = value\n\n def __repr__(self) -> str:\n return f\"Literal(value={self.value})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return self.value == other.value\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.value))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n return self.value\n\n\nclass Variable(Atom):\n def __init__(self, name: str, default: Optional[str]) -> None:\n self.name = name\n self.default = default\n\n def __repr__(self) -> str:\n return f\"Variable(name={self.name}, default={self.default})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return (self.name, self.default) == (other.name, other.default)\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.name, self.default))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n default = self.default if self.default is not None else \"\"\n result = env.get(self.name, default)\n return result if result is not None else \"\"\n\n\ndef parse_variables(value: str) -> Iterator[Atom]:\n cursor = 0\n\n for match in _posix_variable.finditer(value):\n (start, end) = match.span()\n name = match[\"name\"]\n default = match[\"default\"]\n\n if start > cursor:\n yield Literal(value=value[cursor:start])\n\n yield Variable(name=name, default=default)\n cursor = end\n\n length = len(value)\n if cursor < length:\n yield Literal(value=value[cursor:length])\n\n[end of src/dotenv/variables.py]","filename":"src/dotenv/variables.py","id":"19"},{"content":"from typing import Any, Optional\n\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\n unset_key)\n\n\ndef load_ipython_extension(ipython: Any) -> None:\n from .ipython import load_ipython_extension\n load_ipython_extension(ipython)\n\n\ndef get_cli_string(\n path: Optional[str] = None,\n action: Optional[str] = None,\n key: Optional[str] = None,\n value: Optional[str] = None,\n quote: Optional[str] = None,\n):\n \"\"\"Returns a string suitable for running as a shell script.\n\n Useful for converting a arguments passed to a fabric task\n to be passed to a `local` or `run` command.\n \"\"\"\n command = ['dotenv']\n if quote:\n command.append(f'-q {quote}')\n if path:\n command.append(f'-f {path}')\n if action:\n command.append(action)\n if key:\n command.append(key)\n if value:\n if ' ' in value:\n command.append(f'\"{value}\"')\n else:\n command.append(value)\n\n return ' '.join(command).strip()\n\n\n__all__ = ['get_cli_string',\n 'load_dotenv',\n 'dotenv_values',\n 'get_key',\n 'set_key',\n 'unset_key',\n 'find_dotenv',\n 'load_ipython_extension']\n\n[end of src/dotenv/__init__.py]","filename":"src/dotenv/__init__.py","id":"20"},{"content":"import codecs\nimport re\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\n Pattern, Sequence, Tuple)\n\n\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\n return re.compile(string, re.UNICODE | extra_flags)\n\n\n_newline = make_regex(r\"(\\r\\n|\\n|\\r)\")\n_multiline_whitespace = make_regex(r\"\\s*\", extra_flags=re.MULTILINE)\n_whitespace = make_regex(r\"[^\\S\\r\\n]*\")\n_export = make_regex(r\"(?:export[^\\S\\r\\n]+)?\")\n_single_quoted_key = make_regex(r\"'([^']+)'\")\n_unquoted_key = make_regex(r\"([^=\\#\\s]+)\")\n_equal_sign = make_regex(r\"(=[^\\S\\r\\n]*)\")\n_single_quoted_value = make_regex(r\"'((?:\\\\'|[^'])*)'\")\n_double_quoted_value = make_regex(r'\"((?:\\\\\"|[^\"])*)\"')\n_unquoted_value = make_regex(r\"([^\\r\\n]*)\")\n_comment = make_regex(r\"(?:[^\\S\\r\\n]*#[^\\r\\n]*)?\")\n_end_of_line = make_regex(r\"[^\\S\\r\\n]*(?:\\r\\n|\\n|\\r|$)\")\n_rest_of_line = make_regex(r\"[^\\r\\n]*(?:\\r|\\n|\\r\\n)?\")\n_double_quote_escapes = make_regex(r\"\\\\[\\\\'\\\"abfnrtv]\")\n_single_quote_escapes = make_regex(r\"\\\\[\\\\']\")\n\n\nclass Original(NamedTuple):\n string: str\n line: int\n\n\nclass Binding(NamedTuple):\n key: Optional[str]\n value: Optional[str]\n original: Original\n error: bool\n\n\nclass Position:\n def __init__(self, chars: int, line: int) -> None:\n self.chars = chars\n self.line = line\n\n @classmethod\n def start(cls) -> \"Position\":\n return cls(chars=0, line=1)\n\n def set(self, other: \"Position\") -> None:\n self.chars = other.chars\n self.line = other.line\n\n def advance(self, string: str) -> None:\n self.chars += len(string)\n self.line += len(re.findall(_newline, string))\n\n\nclass Error(Exception):\n pass\n\n\nclass Reader:\n def __init__(self, stream: IO[str]) -> None:\n self.string = stream.read()\n self.position = Position.start()\n self.mark = Position.start()\n\n def has_next(self) -> bool:\n return self.position.chars < len(self.string)\n\n def set_mark(self) -> None:\n self.mark.set(self.position)\n\n def get_marked(self) -> Original:\n return Original(\n string=self.string[self.mark.chars:self.position.chars],\n line=self.mark.line,\n )\n\n def peek(self, count: int) -> str:\n return self.string[self.position.chars:self.position.chars + count]\n\n def read(self, count: int) -> str:\n result = self.string[self.position.chars:self.position.chars + count]\n if len(result) < count:\n raise Error(\"read: End of string\")\n self.position.advance(result)\n return result\n\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\n match = regex.match(self.string, self.position.chars)\n if match is None:\n raise Error(\"read_regex: Pattern not found\")\n self.position.advance(self.string[match.start():match.end()])\n return match.groups()\n\n\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\n def decode_match(match: Match[str]) -> str:\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\n\n return regex.sub(decode_match, string)\n\n\ndef parse_key(reader: Reader) -> Optional[str]:\n char = reader.peek(1)\n if char == \"#\":\n return None\n elif char == \"'\":\n (key,) = reader.read_regex(_single_quoted_key)\n else:\n (key,) = reader.read_regex(_unquoted_key)\n return key\n\n\ndef parse_unquoted_value(reader: Reader) -> str:\n (part,) = reader.read_regex(_unquoted_value)\n return re.sub(r\"\\s+#.*\", \"\", part).rstrip()\n\n\ndef parse_value(reader: Reader) -> str:\n char = reader.peek(1)\n if char == u\"'\":\n (value,) = reader.read_regex(_single_quoted_value)\n return decode_escapes(_single_quote_escapes, value)\n elif char == u'\"':\n (value,) = reader.read_regex(_double_quoted_value)\n return decode_escapes(_double_quote_escapes, value)\n elif char in (u\"\", u\"\\n\", u\"\\r\"):\n return u\"\"\n else:\n return parse_unquoted_value(reader)\n\n\ndef parse_binding(reader: Reader) -> Binding:\n reader.set_mark()\n try:\n reader.read_regex(_multiline_whitespace)\n if not reader.has_next():\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=False,\n )\n reader.read_regex(_export)\n key = parse_key(reader)\n reader.read_regex(_whitespace)\n if reader.peek(1) == \"=\":\n reader.read_regex(_equal_sign)\n value: Optional[str] = parse_value(reader)\n else:\n value = None\n reader.read_regex(_comment)\n reader.read_regex(_end_of_line)\n return Binding(\n key=key,\n value=value,\n original=reader.get_marked(),\n error=False,\n )\n except Error:\n reader.read_regex(_rest_of_line)\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=True,\n )\n\n\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\n reader = Reader(stream)\n while reader.has_next():\n yield parse_binding(reader)\n\n[end of src/dotenv/parser.py]","filename":"src/dotenv/parser.py","id":"21"},{"content":"import json\nimport os\nimport shlex\nimport sys\nfrom contextlib import contextmanager\nfrom typing import Any, Dict, IO, Iterator, List, Optional\n\ntry:\n import click\nexcept ImportError:\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\n'\n 'Run pip install \"python-dotenv[cli]\" to fix this.')\n sys.exit(1)\n\nfrom .main import dotenv_values, set_key, unset_key\nfrom .version import __version__\n\n\ndef enumerate_env() -> Optional[str]:\n \"\"\"\n Return a path for the ${pwd}/.env file.\n\n If pwd does not exist, return None.\n \"\"\"\n try:\n cwd = os.getcwd()\n except FileNotFoundError:\n return None\n path = os.path.join(cwd, '.env')\n return path\n\n\n@click.group()\n@click.option('-f', '--file', default=enumerate_env(),\n type=click.Path(file_okay=True),\n help=\"Location of the .env file, defaults to .env file in current working directory.\")\n@click.option('-q', '--quote', default='always',\n type=click.Choice(['always', 'never', 'auto']),\n help=\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\")\n@click.option('-e', '--export', default=False,\n type=click.BOOL,\n help=\"Whether to write the dot file as an executable bash script.\")\n@click.version_option(version=__version__)\n@click.pass_context\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\n \"\"\"This script is used to set, get or unset values from a .env file.\"\"\"\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\n\n\n@contextmanager\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\n \"\"\"\n Open a file and yield the corresponding (decoded) stream.\n\n Exits with error code 2 if the file cannot be opened.\n \"\"\"\n\n try:\n with open(path) as stream:\n yield stream\n except OSError as exc:\n print(f\"Error opening env file: {exc}\", file=sys.stderr)\n exit(2)\n\n\n@cli.command()\n@click.pass_context\n@click.option('--format', default='simple',\n type=click.Choice(['simple', 'json', 'shell', 'export']),\n help=\"The format in which to display the list. Default format is simple, \"\n \"which displays name=value without quotes.\")\ndef list(ctx: click.Context, format: bool) -> None:\n \"\"\"Display all the stored key/value.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n if format == 'json':\n click.echo(json.dumps(values, indent=2, sort_keys=True))\n else:\n prefix = 'export ' if format == 'export' else ''\n for k in sorted(values):\n v = values[k]\n if v is not None:\n if format in ('export', 'shell'):\n v = shlex.quote(v)\n click.echo(f'{prefix}{k}={v}')\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\n@click.argument('value', required=True)\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\n \"\"\"Store the given key/value.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n export = ctx.obj['EXPORT']\n success, key, value = set_key(file, key, value, quote, export)\n if success:\n click.echo(f'{key}={value}')\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef get(ctx: click.Context, key: Any) -> None:\n \"\"\"Retrieve the value for the given key.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n stored_value = values.get(key)\n if stored_value:\n click.echo(stored_value)\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef unset(ctx: click.Context, key: Any) -> None:\n \"\"\"Removes the given key.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n success, key = unset_key(file, key, quote)\n if success:\n click.echo(f\"Successfully removed {key}\")\n else:\n exit(1)\n\n\n@cli.command(context_settings={'ignore_unknown_options': True})\n@click.pass_context\n@click.option(\n \"--override/--no-override\",\n default=True,\n help=\"Override variables from the environment file with those from the .env file.\",\n)\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\n \"\"\"Run command with environment variables present.\"\"\"\n file = ctx.obj['FILE']\n if not os.path.isfile(file):\n raise click.BadParameter(\n f'Invalid value for \\'-f\\' \"{file}\" does not exist.',\n ctx=ctx\n )\n dotenv_as_dict = {\n k: v\n for (k, v) in dotenv_values(file).items()\n if v is not None and (override or k not in os.environ)\n }\n\n if not commandline:\n click.echo('No command given.')\n exit(1)\n run_command(commandline, dotenv_as_dict)\n\n\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\n \"\"\"Replace the current process with the specified command.\n\n Replaces the current process with the specified command and the variables from `env`\n added in the current environment variables.\n\n Parameters\n ----------\n command: List[str]\n The command and it's parameters\n env: Dict\n The additional environment variables\n\n Returns\n -------\n None\n This function does not return any value. It replaces the current process with the new one.\n\n \"\"\"\n # copy the current environment variables and add the vales from\n # `env`\n cmd_env = os.environ.copy()\n cmd_env.update(env)\n\n os.execvpe(command[0], args=command, env=cmd_env)\n\n[end of src/dotenv/cli.py]","filename":"src/dotenv/cli.py","id":"22"},{"content":"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\n parse_argstring) # type: ignore\n\nfrom .main import find_dotenv, load_dotenv\n\n\n@magics_class\nclass IPythonDotEnv(Magics):\n\n @magic_arguments()\n @argument(\n '-o', '--override', action='store_true',\n help=\"Indicate to override existing variables\"\n )\n @argument(\n '-v', '--verbose', action='store_true',\n help=\"Indicate function calls to be verbose\"\n )\n @argument('dotenv_path', nargs='?', type=str, default='.env',\n help='Search in increasingly higher folders for the `dotenv_path`')\n @line_magic\n def dotenv(self, line):\n args = parse_argstring(self.dotenv, line)\n # Locate the .env file\n dotenv_path = args.dotenv_path\n try:\n dotenv_path = find_dotenv(dotenv_path, True, True)\n except IOError:\n print(\"cannot find .env file\")\n return\n\n # Load the .env file\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\n\n\ndef load_ipython_extension(ipython):\n \"\"\"Register the %dotenv magic.\"\"\"\n ipython.register_magics(IPythonDotEnv)\n\n[end of src/dotenv/ipython.py]","filename":"src/dotenv/ipython.py","id":"23"},{"content":"# Marker file for PEP 561\n\n[end of src/dotenv/py.typed]","filename":"src/dotenv/py.typed","id":"24"},{"content":"import io\nimport logging\nimport os\nimport pathlib\nimport shutil\nimport sys\nimport tempfile\nfrom collections import OrderedDict\nfrom contextlib import contextmanager\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\n\nfrom .parser import Binding, parse_stream\nfrom .variables import parse_variables\n\n# A type alias for a string path to be used for the paths in this file.\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\n# only accepts string paths, not byte paths or file descriptors. See\n# https://github.com/python/typeshed/pull/6832.\nStrPath = Union[str, \"os.PathLike[str]\"]\n\nlogger = logging.getLogger(__name__)\n\n\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\n for mapping in mappings:\n if mapping.error:\n logger.warning(\n \"python-dotenv could not parse statement starting at line %s\",\n mapping.original.line,\n )\n yield mapping\n\n\nclass DotEnv:\n def __init__(\n self,\n dotenv_path: Optional[StrPath],\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n encoding: Optional[str] = None,\n interpolate: bool = True,\n override: bool = True,\n ) -> None:\n self.dotenv_path: Optional[StrPath] = dotenv_path\n self.stream: Optional[IO[str]] = stream\n self._dict: Optional[Dict[str, Optional[str]]] = None\n self.verbose: bool = verbose\n self.encoding: Optional[str] = encoding\n self.interpolate: bool = interpolate\n self.override: bool = override\n\n @contextmanager\n def _get_stream(self) -> Iterator[IO[str]]:\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\n with open(self.dotenv_path, encoding=self.encoding) as stream:\n yield stream\n elif self.stream is not None:\n yield self.stream\n else:\n if self.verbose:\n logger.info(\n \"python-dotenv could not find configuration file %s.\",\n self.dotenv_path or \".env\",\n )\n yield io.StringIO(\"\")\n\n def dict(self) -> Dict[str, Optional[str]]:\n \"\"\"Return dotenv as dict\"\"\"\n if self._dict:\n return self._dict\n\n raw_values = self.parse()\n\n if self.interpolate:\n self._dict = OrderedDict(\n resolve_variables(raw_values, override=self.override)\n )\n else:\n self._dict = OrderedDict(raw_values)\n\n return self._dict\n\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\n with self._get_stream() as stream:\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\n if mapping.key is not None:\n yield mapping.key, mapping.value\n\n def set_as_environment_variables(self) -> bool:\n \"\"\"\n Load the current dotenv as system environment variable.\n \"\"\"\n if not self.dict():\n return False\n\n for k, v in self.dict().items():\n if k in os.environ and not self.override:\n continue\n if v is not None:\n os.environ[k] = v\n\n return True\n\n def get(self, key: str) -> Optional[str]:\n \"\"\" \"\"\"\n data = self.dict()\n\n if key in data:\n return data[key]\n\n if self.verbose:\n logger.warning(\"Key %s not found in %s.\", key, self.dotenv_path)\n\n return None\n\n\ndef get_key(\n dotenv_path: StrPath,\n key_to_get: str,\n encoding: Optional[str] = \"utf-8\",\n) -> Optional[str]:\n \"\"\"\n Get the value of a given key from the given .env.\n\n Returns `None` if the key isn't found or doesn't have a value.\n \"\"\"\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\n\n\n@contextmanager\ndef rewrite(\n path: StrPath,\n encoding: Optional[str],\n) -> Iterator[Tuple[IO[str], IO[str]]]:\n pathlib.Path(path).touch()\n\n with tempfile.NamedTemporaryFile(mode=\"w\", encoding=encoding, delete=False) as dest:\n error = None\n try:\n with open(path, encoding=encoding) as source:\n yield (source, dest)\n except BaseException as err:\n error = err\n\n if error is None:\n shutil.move(dest.name, path)\n else:\n os.unlink(dest.name)\n raise error from None\n\n\ndef set_key(\n dotenv_path: StrPath,\n key_to_set: str,\n value_to_set: str,\n quote_mode: str = \"always\",\n export: bool = False,\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str, str]:\n \"\"\"\n Adds or Updates a key/value to the given .env\n\n If the .env path given doesn't exist, fails instead of risking creating\n an orphan .env somewhere in the filesystem\n \"\"\"\n if quote_mode not in (\"always\", \"auto\", \"never\"):\n raise ValueError(f\"Unknown quote_mode: {quote_mode}\")\n\n quote = quote_mode == \"always\" or (\n quote_mode == \"auto\" and not value_to_set.isalnum()\n )\n\n if quote:\n value_out = \"'{}'\".format(value_to_set.replace(\"'\", \"\\\\'\"))\n else:\n value_out = value_to_set\n if export:\n line_out = f\"export {key_to_set}={value_out}\\n\"\n else:\n line_out = f\"{key_to_set}={value_out}\\n\"\n\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n replaced = False\n missing_newline = False\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_set:\n dest.write(line_out)\n replaced = True\n else:\n dest.write(mapping.original.string)\n missing_newline = not mapping.original.string.endswith(\"\\n\")\n if not replaced:\n if missing_newline:\n dest.write(\"\\n\")\n dest.write(line_out)\n\n return True, key_to_set, value_to_set\n\n\ndef unset_key(\n dotenv_path: StrPath,\n key_to_unset: str,\n quote_mode: str = \"always\",\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str]:\n \"\"\"\n Removes a given key from the given `.env` file.\n\n If the .env path given doesn't exist, fails.\n If the given key doesn't exist in the .env, fails.\n \"\"\"\n if not os.path.exists(dotenv_path):\n logger.warning(\"Can't delete from %s - it doesn't exist.\", dotenv_path)\n return None, key_to_unset\n\n removed = False\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_unset:\n removed = True\n else:\n dest.write(mapping.original.string)\n\n if not removed:\n logger.warning(\n \"Key %s not removed from %s - key doesn't exist.\", key_to_unset, dotenv_path\n )\n return None, key_to_unset\n\n return removed, key_to_unset\n\n\ndef resolve_variables(\n values: Iterable[Tuple[str, Optional[str]]],\n override: bool,\n) -> Mapping[str, Optional[str]]:\n new_values: Dict[str, Optional[str]] = {}\n\n for name, value in values:\n if value is None:\n result = None\n else:\n atoms = parse_variables(value)\n env: Dict[str, Optional[str]] = {}\n if override:\n env.update(os.environ) # type: ignore\n env.update(new_values)\n else:\n env.update(new_values)\n env.update(os.environ) # type: ignore\n result = \"\".join(atom.resolve(env) for atom in atoms)\n\n new_values[name] = result\n\n return new_values\n\n\ndef _walk_to_root(path: str) -> Iterator[str]:\n \"\"\"\n Yield directories starting from the given directory up to the root\n \"\"\"\n if not os.path.exists(path):\n raise IOError(\"Starting path not found\")\n\n if os.path.isfile(path):\n path = os.path.dirname(path)\n\n last_dir = None\n current_dir = os.path.abspath(path)\n while last_dir != current_dir:\n yield current_dir\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\n last_dir, current_dir = current_dir, parent_dir\n\n\ndef find_dotenv(\n filename: str = \".env\",\n raise_error_if_not_found: bool = False,\n usecwd: bool = False,\n) -> str:\n \"\"\"\n Search in increasingly higher folders for the given file\n\n Returns path to the file if found, or an empty string otherwise\n \"\"\"\n\n def _is_interactive():\n \"\"\"Decide whether this is running in a REPL or IPython notebook\"\"\"\n try:\n main = __import__(\"__main__\", None, None, fromlist=[\"__file__\"])\n except ModuleNotFoundError:\n return False\n return not hasattr(main, \"__file__\")\n\n if usecwd or _is_interactive() or getattr(sys, \"frozen\", False):\n # Should work without __file__, e.g. in REPL or IPython notebook.\n path = os.getcwd()\n else:\n # will work for .py files\n frame = sys._getframe()\n current_file = __file__\n\n while frame.f_code.co_filename == current_file or not os.path.exists(\n frame.f_code.co_filename\n ):\n assert frame.f_back is not None\n frame = frame.f_back\n frame_filename = frame.f_code.co_filename\n path = os.path.dirname(os.path.abspath(frame_filename))\n\n for dirname in _walk_to_root(path):\n check_path = os.path.join(dirname, filename)\n if os.path.isfile(check_path):\n return check_path\n\n if raise_error_if_not_found:\n raise IOError(\"File not found\")\n\n return \"\"\n\n\ndef load_dotenv(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n override: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> bool:\n \"\"\"Parse a .env file and then load all the variables found as environment variables.\n\n Parameters:\n dotenv_path: Absolute or relative path to .env file.\n stream: Text stream (such as `io.StringIO`) with .env content, used if\n `dotenv_path` is `None`.\n verbose: Whether to output a warning the .env file is missing.\n override: Whether to override the system environment variables with the variables\n from the `.env` file.\n encoding: Encoding to be used to read the file.\n Returns:\n Bool: True if at least one environment variable is set else False\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file with it's default parameters. If you need to change the default parameters\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\n to this function as `dotenv_path`.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n dotenv = DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=override,\n encoding=encoding,\n )\n return dotenv.set_as_environment_variables()\n\n\ndef dotenv_values(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> Dict[str, Optional[str]]:\n \"\"\"\n Parse a .env file and return its content as a dict.\n\n The returned dict will have `None` values for keys without values in the .env file.\n For example, `foo=bar` results in `{\"foo\": \"bar\"}` whereas `foo` alone results in\n `{\"foo\": None}`\n\n Parameters:\n dotenv_path: Absolute or relative path to the .env file.\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\n verbose: Whether to output a warning if the .env file is missing.\n encoding: Encoding to be used to read the file.\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n return DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=True,\n encoding=encoding,\n ).dict()\n\n[end of src/dotenv/main.py]","filename":"src/dotenv/main.py","id":"25"},{"content":"\"\"\"Entry point for cli, enables execution with `python -m dotenv`\"\"\"\n\nfrom .cli import cli\n\nif __name__ == \"__main__\":\n cli()\n\n[end of src/dotenv/__main__.py]","filename":"src/dotenv/__main__.py","id":"26"}],"string":"[\n {\n \"content\": \"site_name: python-dotenv\\nrepo_url: https://github.com/theskumar/python-dotenv\\nedit_uri: \\\"\\\"\\ntheme:\\n name: material\\n palette:\\n primary: green\\n features:\\n - toc.follow\\n - navigation.sections\\n\\nmarkdown_extensions:\\n - mdx_truly_sane_lists\\n\\nplugins:\\n - mkdocstrings:\\n handlers:\\n python:\\n rendering:\\n show_root_heading: yes\\n show_submodules: no\\n separate_signature: yes\\n - search\\nnav:\\n - Home: index.md\\n - Changelog: changelog.md\\n - Contributing: contributing.md\\n - Reference: reference.md\\n - License: license.md\\n\\n[end of mkdocs.yml]\",\n \"filename\": \"mkdocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"black~=22.3.0\\nbumpversion\\nclick\\nflake8>=2.2.3\\nipython\\npytest-cov\\npytest>=3.9\\nsh>=2\\ntox\\ntwine\\nwheel\\n\\n[end of requirements.txt]\",\n \"filename\": \"requirements.txt\",\n \"id\": \"2\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"3\"\n },\n {\n \"content\": \".PHONY: clean-pyc clean-build test\\n\\nclean: clean-build clean-pyc\\n\\nclean-build:\\n\\trm -fr build/\\n\\trm -fr dist/\\n\\trm -fr src/*.egg-info\\n\\nclean-pyc:\\n\\tfind . -name '*.pyc' -exec rm -f {} +\\n\\tfind . -name '*.pyo' -exec rm -f {} +\\n\\tfind . -name '*~' -exec rm -f {} +\\n\\nrelease: sdist\\n\\ttwine check dist/*\\n\\ttwine upload dist/*\\n\\nrelease-test: sdist\\n\\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\\n\\nsdist: clean\\n\\tpython setup.py sdist bdist_wheel\\n\\tls -l dist\\n\\ntest:\\n\\tpip install -e .\\n\\tflake8 .\\n\\tpy.test tests/\\n\\ncoverage:\\n\\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\\n\\tcoverage report\\n\\ncoverage-html: coverage\\n\\tcoverage html\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"4\"\n },\n {\n \"content\": \"mdx_truly_sane_lists~=1.2\\nmkdocs-include-markdown-plugin~=3.3.0\\nmkdocs-material~=8.2.9\\nmkdocstrings[python]~=0.18.1\\nmkdocs~=1.3.0\\n\\n[end of requirements-docs.txt]\",\n \"filename\": \"requirements-docs.txt\",\n \"id\": \"5\"\n },\n {\n \"content\": \"include LICENSE *.md *.yml *.toml\\n\\ninclude tox.ini\\nrecursive-include docs *.md\\nrecursive-include tests *.py\\n\\ninclude .bumpversion.cfg\\ninclude .coveragerc\\ninclude .editorconfig\\ninclude Makefile\\ninclude requirements.txt\\ninclude requirements-docs.txt\\ninclude src/dotenv/py.typed\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# see: http://editorconfig.org\\n\\nroot = true\\n\\n[*]\\ncharset = utf-8\\nend_of_line = lf\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\n\\n[*.{py,rst,ini}]\\nindent_style = space\\nindent_size = 4\\n\\n[*.yml]\\nindent_style = space\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"8\"\n },\n {\n \"content\": \"from setuptools import setup\\n\\n\\ndef read_files(files):\\n data = []\\n for file in files:\\n with open(file, encoding=\\\"utf-8\\\") as f:\\n data.append(f.read())\\n return \\\"\\\\n\\\".join(data)\\n\\n\\nlong_description = read_files([\\\"README.md\\\", \\\"CHANGELOG.md\\\"])\\n\\nmeta = {}\\nwith open(\\\"./src/dotenv/version.py\\\", encoding=\\\"utf-8\\\") as f:\\n exec(f.read(), meta)\\n\\nsetup(\\n name=\\\"python-dotenv\\\",\\n description=\\\"Read key-value pairs from a .env file and set them as environment variables\\\",\\n long_description=long_description,\\n long_description_content_type=\\\"text/markdown\\\",\\n version=meta[\\\"__version__\\\"],\\n author=\\\"Saurabh Kumar\\\",\\n author_email=\\\"me+github@saurabh-kumar.com\\\",\\n url=\\\"https://github.com/theskumar/python-dotenv\\\",\\n keywords=[\\n \\\"environment variables\\\",\\n \\\"deployments\\\",\\n \\\"settings\\\",\\n \\\"env\\\",\\n \\\"dotenv\\\",\\n \\\"configurations\\\",\\n \\\"python\\\",\\n ],\\n packages=[\\\"dotenv\\\"],\\n package_dir={\\\"\\\": \\\"src\\\"},\\n package_data={\\n \\\"dotenv\\\": [\\\"py.typed\\\"],\\n },\\n python_requires=\\\">=3.9\\\",\\n extras_require={\\n \\\"cli\\\": [\\n \\\"click>=5.0\\\",\\n ],\\n },\\n entry_points={\\n \\\"console_scripts\\\": [\\n \\\"dotenv=dotenv.__main__:cli\\\",\\n ],\\n },\\n license=\\\"BSD-3-Clause\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Programming Language :: Python :: 3.10\\\",\\n \\\"Programming Language :: Python :: 3.11\\\",\\n \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Topic :: System :: Systems Administration\\\",\\n \\\"Topic :: Utilities\\\",\\n \\\"Environment :: Web Environment\\\",\\n ],\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of CONTRIBUTING.md]\",\n \"filename\": \"CONTRIBUTING.md\",\n \"id\": \"10\"\n },\n {\n \"content\": \"[tox]\\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\\n\\n[gh-actions]\\npython =\\n 3.9: py39\\n 3.10: py310\\n 3.11: py311\\n 3.12: py312\\n 3.13: py313, lint, manifest\\n pypy-3.9: pypy3\\n\\n[testenv]\\ndeps =\\n pytest\\n pytest-cov\\n sh >= 2.0.2, <3\\n click\\n py{39,310,311,312,313,pypy3}: ipython\\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\\ndepends =\\n py{39,310,311,312,313},pypy3: coverage-clean\\n coverage-report: py{39,310,311,312,313},pypy3\\n\\n[testenv:lint]\\nskip_install = true\\ndeps =\\n flake8\\n mypy\\ncommands =\\n flake8 src tests\\n mypy --python-version=3.13 src tests\\n mypy --python-version=3.12 src tests\\n mypy --python-version=3.11 src tests\\n mypy --python-version=3.10 src tests\\n mypy --python-version=3.9 src tests\\n\\n[testenv:manifest]\\ndeps = check-manifest\\nskip_install = true\\ncommands = check-manifest\\n\\n[testenv:coverage-clean]\\ndeps = coverage\\nskip_install = true\\ncommands = coverage erase\\n\\n[testenv:coverage-report]\\ndeps = coverage\\nskip_install = true\\ncommands =\\n coverage report\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"11\"\n },\n {\n \"content\": \"[bumpversion]\\ncurrent_version = 1.0.1\\ncommit = True\\ntag = True\\n\\n[bumpversion:file:src/dotenv/version.py]\\n\\n[flake8]\\nmax-line-length = 120\\nexclude = .tox,.git,docs,venv,.venv,build\\n\\n[mypy]\\ncheck_untyped_defs = true\\nignore_missing_imports = true\\n\\n[metadata]\\ndescription_file = README.md\\n\\n[tool:pytest]\\ntestpaths = tests\\n\\n[coverage:run]\\nrelative_files = True\\nsource = dotenv\\n\\n[coverage:paths]\\nsource =\\n\\tsrc/dotenv\\n\\t.tox/*/lib/python*/site-packages/dotenv\\n\\t.tox/pypy*/site-packages/dotenv\\n\\n[coverage:report]\\nshow_missing = True\\ninclude = */site-packages/dotenv/*\\nexclude_lines =\\n\\tif IS_TYPE_CHECKING:\\n\\tpragma: no cover\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of docs/license.md]\",\n \"filename\": \"docs/license.md\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# ::: dotenv\\n\\n\\n[end of docs/reference.md]\",\n \"filename\": \"docs/reference.md\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of docs/changelog.md]\",\n \"filename\": \"docs/changelog.md\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of docs/index.md]\",\n \"filename\": \"docs/index.md\",\n \"id\": \"16\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of docs/contributing.md]\",\n \"filename\": \"docs/contributing.md\",\n \"id\": \"17\"\n },\n {\n \"content\": \"__version__ = \\\"1.0.1\\\"\\n\\n[end of src/dotenv/version.py]\",\n \"filename\": \"src/dotenv/version.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"import re\\nfrom abc import ABCMeta, abstractmethod\\nfrom typing import Iterator, Mapping, Optional, Pattern\\n\\n_posix_variable: Pattern[str] = re.compile(\\n r\\\"\\\"\\\"\\n \\\\$\\\\{\\n (?P<name>[^\\\\}:]*)\\n (?::-\\n (?P<default>[^\\\\}]*)\\n )?\\n \\\\}\\n \\\"\\\"\\\",\\n re.VERBOSE,\\n)\\n\\n\\nclass Atom(metaclass=ABCMeta):\\n def __ne__(self, other: object) -> bool:\\n result = self.__eq__(other)\\n if result is NotImplemented:\\n return NotImplemented\\n return not result\\n\\n @abstractmethod\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\\n\\n\\nclass Literal(Atom):\\n def __init__(self, value: str) -> None:\\n self.value = value\\n\\n def __repr__(self) -> str:\\n return f\\\"Literal(value={self.value})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return self.value == other.value\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.value))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n return self.value\\n\\n\\nclass Variable(Atom):\\n def __init__(self, name: str, default: Optional[str]) -> None:\\n self.name = name\\n self.default = default\\n\\n def __repr__(self) -> str:\\n return f\\\"Variable(name={self.name}, default={self.default})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return (self.name, self.default) == (other.name, other.default)\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.name, self.default))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n default = self.default if self.default is not None else \\\"\\\"\\n result = env.get(self.name, default)\\n return result if result is not None else \\\"\\\"\\n\\n\\ndef parse_variables(value: str) -> Iterator[Atom]:\\n cursor = 0\\n\\n for match in _posix_variable.finditer(value):\\n (start, end) = match.span()\\n name = match[\\\"name\\\"]\\n default = match[\\\"default\\\"]\\n\\n if start > cursor:\\n yield Literal(value=value[cursor:start])\\n\\n yield Variable(name=name, default=default)\\n cursor = end\\n\\n length = len(value)\\n if cursor < length:\\n yield Literal(value=value[cursor:length])\\n\\n[end of src/dotenv/variables.py]\",\n \"filename\": \"src/dotenv/variables.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from typing import Any, Optional\\n\\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\\n unset_key)\\n\\n\\ndef load_ipython_extension(ipython: Any) -> None:\\n from .ipython import load_ipython_extension\\n load_ipython_extension(ipython)\\n\\n\\ndef get_cli_string(\\n path: Optional[str] = None,\\n action: Optional[str] = None,\\n key: Optional[str] = None,\\n value: Optional[str] = None,\\n quote: Optional[str] = None,\\n):\\n \\\"\\\"\\\"Returns a string suitable for running as a shell script.\\n\\n Useful for converting a arguments passed to a fabric task\\n to be passed to a `local` or `run` command.\\n \\\"\\\"\\\"\\n command = ['dotenv']\\n if quote:\\n command.append(f'-q {quote}')\\n if path:\\n command.append(f'-f {path}')\\n if action:\\n command.append(action)\\n if key:\\n command.append(key)\\n if value:\\n if ' ' in value:\\n command.append(f'\\\"{value}\\\"')\\n else:\\n command.append(value)\\n\\n return ' '.join(command).strip()\\n\\n\\n__all__ = ['get_cli_string',\\n 'load_dotenv',\\n 'dotenv_values',\\n 'get_key',\\n 'set_key',\\n 'unset_key',\\n 'find_dotenv',\\n 'load_ipython_extension']\\n\\n[end of src/dotenv/__init__.py]\",\n \"filename\": \"src/dotenv/__init__.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"import codecs\\nimport re\\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\\n Pattern, Sequence, Tuple)\\n\\n\\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\\n return re.compile(string, re.UNICODE | extra_flags)\\n\\n\\n_newline = make_regex(r\\\"(\\\\r\\\\n|\\\\n|\\\\r)\\\")\\n_multiline_whitespace = make_regex(r\\\"\\\\s*\\\", extra_flags=re.MULTILINE)\\n_whitespace = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*\\\")\\n_export = make_regex(r\\\"(?:export[^\\\\S\\\\r\\\\n]+)?\\\")\\n_single_quoted_key = make_regex(r\\\"'([^']+)'\\\")\\n_unquoted_key = make_regex(r\\\"([^=\\\\#\\\\s]+)\\\")\\n_equal_sign = make_regex(r\\\"(=[^\\\\S\\\\r\\\\n]*)\\\")\\n_single_quoted_value = make_regex(r\\\"'((?:\\\\\\\\'|[^'])*)'\\\")\\n_double_quoted_value = make_regex(r'\\\"((?:\\\\\\\\\\\"|[^\\\"])*)\\\"')\\n_unquoted_value = make_regex(r\\\"([^\\\\r\\\\n]*)\\\")\\n_comment = make_regex(r\\\"(?:[^\\\\S\\\\r\\\\n]*#[^\\\\r\\\\n]*)?\\\")\\n_end_of_line = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*(?:\\\\r\\\\n|\\\\n|\\\\r|$)\\\")\\n_rest_of_line = make_regex(r\\\"[^\\\\r\\\\n]*(?:\\\\r|\\\\n|\\\\r\\\\n)?\\\")\\n_double_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\'\\\\\\\"abfnrtv]\\\")\\n_single_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\']\\\")\\n\\n\\nclass Original(NamedTuple):\\n string: str\\n line: int\\n\\n\\nclass Binding(NamedTuple):\\n key: Optional[str]\\n value: Optional[str]\\n original: Original\\n error: bool\\n\\n\\nclass Position:\\n def __init__(self, chars: int, line: int) -> None:\\n self.chars = chars\\n self.line = line\\n\\n @classmethod\\n def start(cls) -> \\\"Position\\\":\\n return cls(chars=0, line=1)\\n\\n def set(self, other: \\\"Position\\\") -> None:\\n self.chars = other.chars\\n self.line = other.line\\n\\n def advance(self, string: str) -> None:\\n self.chars += len(string)\\n self.line += len(re.findall(_newline, string))\\n\\n\\nclass Error(Exception):\\n pass\\n\\n\\nclass Reader:\\n def __init__(self, stream: IO[str]) -> None:\\n self.string = stream.read()\\n self.position = Position.start()\\n self.mark = Position.start()\\n\\n def has_next(self) -> bool:\\n return self.position.chars < len(self.string)\\n\\n def set_mark(self) -> None:\\n self.mark.set(self.position)\\n\\n def get_marked(self) -> Original:\\n return Original(\\n string=self.string[self.mark.chars:self.position.chars],\\n line=self.mark.line,\\n )\\n\\n def peek(self, count: int) -> str:\\n return self.string[self.position.chars:self.position.chars + count]\\n\\n def read(self, count: int) -> str:\\n result = self.string[self.position.chars:self.position.chars + count]\\n if len(result) < count:\\n raise Error(\\\"read: End of string\\\")\\n self.position.advance(result)\\n return result\\n\\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\\n match = regex.match(self.string, self.position.chars)\\n if match is None:\\n raise Error(\\\"read_regex: Pattern not found\\\")\\n self.position.advance(self.string[match.start():match.end()])\\n return match.groups()\\n\\n\\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\\n def decode_match(match: Match[str]) -> str:\\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\\n\\n return regex.sub(decode_match, string)\\n\\n\\ndef parse_key(reader: Reader) -> Optional[str]:\\n char = reader.peek(1)\\n if char == \\\"#\\\":\\n return None\\n elif char == \\\"'\\\":\\n (key,) = reader.read_regex(_single_quoted_key)\\n else:\\n (key,) = reader.read_regex(_unquoted_key)\\n return key\\n\\n\\ndef parse_unquoted_value(reader: Reader) -> str:\\n (part,) = reader.read_regex(_unquoted_value)\\n return re.sub(r\\\"\\\\s+#.*\\\", \\\"\\\", part).rstrip()\\n\\n\\ndef parse_value(reader: Reader) -> str:\\n char = reader.peek(1)\\n if char == u\\\"'\\\":\\n (value,) = reader.read_regex(_single_quoted_value)\\n return decode_escapes(_single_quote_escapes, value)\\n elif char == u'\\\"':\\n (value,) = reader.read_regex(_double_quoted_value)\\n return decode_escapes(_double_quote_escapes, value)\\n elif char in (u\\\"\\\", u\\\"\\\\n\\\", u\\\"\\\\r\\\"):\\n return u\\\"\\\"\\n else:\\n return parse_unquoted_value(reader)\\n\\n\\ndef parse_binding(reader: Reader) -> Binding:\\n reader.set_mark()\\n try:\\n reader.read_regex(_multiline_whitespace)\\n if not reader.has_next():\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=False,\\n )\\n reader.read_regex(_export)\\n key = parse_key(reader)\\n reader.read_regex(_whitespace)\\n if reader.peek(1) == \\\"=\\\":\\n reader.read_regex(_equal_sign)\\n value: Optional[str] = parse_value(reader)\\n else:\\n value = None\\n reader.read_regex(_comment)\\n reader.read_regex(_end_of_line)\\n return Binding(\\n key=key,\\n value=value,\\n original=reader.get_marked(),\\n error=False,\\n )\\n except Error:\\n reader.read_regex(_rest_of_line)\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=True,\\n )\\n\\n\\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\\n reader = Reader(stream)\\n while reader.has_next():\\n yield parse_binding(reader)\\n\\n[end of src/dotenv/parser.py]\",\n \"filename\": \"src/dotenv/parser.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \"import json\\nimport os\\nimport shlex\\nimport sys\\nfrom contextlib import contextmanager\\nfrom typing import Any, Dict, IO, Iterator, List, Optional\\n\\ntry:\\n import click\\nexcept ImportError:\\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\\\n'\\n 'Run pip install \\\"python-dotenv[cli]\\\" to fix this.')\\n sys.exit(1)\\n\\nfrom .main import dotenv_values, set_key, unset_key\\nfrom .version import __version__\\n\\n\\ndef enumerate_env() -> Optional[str]:\\n \\\"\\\"\\\"\\n Return a path for the ${pwd}/.env file.\\n\\n If pwd does not exist, return None.\\n \\\"\\\"\\\"\\n try:\\n cwd = os.getcwd()\\n except FileNotFoundError:\\n return None\\n path = os.path.join(cwd, '.env')\\n return path\\n\\n\\n@click.group()\\n@click.option('-f', '--file', default=enumerate_env(),\\n type=click.Path(file_okay=True),\\n help=\\\"Location of the .env file, defaults to .env file in current working directory.\\\")\\n@click.option('-q', '--quote', default='always',\\n type=click.Choice(['always', 'never', 'auto']),\\n help=\\\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\\\")\\n@click.option('-e', '--export', default=False,\\n type=click.BOOL,\\n help=\\\"Whether to write the dot file as an executable bash script.\\\")\\n@click.version_option(version=__version__)\\n@click.pass_context\\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\\n \\\"\\\"\\\"This script is used to set, get or unset values from a .env file.\\\"\\\"\\\"\\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\\n\\n\\n@contextmanager\\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\\n \\\"\\\"\\\"\\n Open a file and yield the corresponding (decoded) stream.\\n\\n Exits with error code 2 if the file cannot be opened.\\n \\\"\\\"\\\"\\n\\n try:\\n with open(path) as stream:\\n yield stream\\n except OSError as exc:\\n print(f\\\"Error opening env file: {exc}\\\", file=sys.stderr)\\n exit(2)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.option('--format', default='simple',\\n type=click.Choice(['simple', 'json', 'shell', 'export']),\\n help=\\\"The format in which to display the list. Default format is simple, \\\"\\n \\\"which displays name=value without quotes.\\\")\\ndef list(ctx: click.Context, format: bool) -> None:\\n \\\"\\\"\\\"Display all the stored key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n if format == 'json':\\n click.echo(json.dumps(values, indent=2, sort_keys=True))\\n else:\\n prefix = 'export ' if format == 'export' else ''\\n for k in sorted(values):\\n v = values[k]\\n if v is not None:\\n if format in ('export', 'shell'):\\n v = shlex.quote(v)\\n click.echo(f'{prefix}{k}={v}')\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\n@click.argument('value', required=True)\\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\\n \\\"\\\"\\\"Store the given key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n export = ctx.obj['EXPORT']\\n success, key, value = set_key(file, key, value, quote, export)\\n if success:\\n click.echo(f'{key}={value}')\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef get(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Retrieve the value for the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n stored_value = values.get(key)\\n if stored_value:\\n click.echo(stored_value)\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef unset(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Removes the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n success, key = unset_key(file, key, quote)\\n if success:\\n click.echo(f\\\"Successfully removed {key}\\\")\\n else:\\n exit(1)\\n\\n\\n@cli.command(context_settings={'ignore_unknown_options': True})\\n@click.pass_context\\n@click.option(\\n \\\"--override/--no-override\\\",\\n default=True,\\n help=\\\"Override variables from the environment file with those from the .env file.\\\",\\n)\\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\\n \\\"\\\"\\\"Run command with environment variables present.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n if not os.path.isfile(file):\\n raise click.BadParameter(\\n f'Invalid value for \\\\'-f\\\\' \\\"{file}\\\" does not exist.',\\n ctx=ctx\\n )\\n dotenv_as_dict = {\\n k: v\\n for (k, v) in dotenv_values(file).items()\\n if v is not None and (override or k not in os.environ)\\n }\\n\\n if not commandline:\\n click.echo('No command given.')\\n exit(1)\\n run_command(commandline, dotenv_as_dict)\\n\\n\\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\\n \\\"\\\"\\\"Replace the current process with the specified command.\\n\\n Replaces the current process with the specified command and the variables from `env`\\n added in the current environment variables.\\n\\n Parameters\\n ----------\\n command: List[str]\\n The command and it's parameters\\n env: Dict\\n The additional environment variables\\n\\n Returns\\n -------\\n None\\n This function does not return any value. It replaces the current process with the new one.\\n\\n \\\"\\\"\\\"\\n # copy the current environment variables and add the vales from\\n # `env`\\n cmd_env = os.environ.copy()\\n cmd_env.update(env)\\n\\n os.execvpe(command[0], args=command, env=cmd_env)\\n\\n[end of src/dotenv/cli.py]\",\n \"filename\": \"src/dotenv/cli.py\",\n \"id\": \"22\"\n },\n {\n \"content\": \"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\\n parse_argstring) # type: ignore\\n\\nfrom .main import find_dotenv, load_dotenv\\n\\n\\n@magics_class\\nclass IPythonDotEnv(Magics):\\n\\n @magic_arguments()\\n @argument(\\n '-o', '--override', action='store_true',\\n help=\\\"Indicate to override existing variables\\\"\\n )\\n @argument(\\n '-v', '--verbose', action='store_true',\\n help=\\\"Indicate function calls to be verbose\\\"\\n )\\n @argument('dotenv_path', nargs='?', type=str, default='.env',\\n help='Search in increasingly higher folders for the `dotenv_path`')\\n @line_magic\\n def dotenv(self, line):\\n args = parse_argstring(self.dotenv, line)\\n # Locate the .env file\\n dotenv_path = args.dotenv_path\\n try:\\n dotenv_path = find_dotenv(dotenv_path, True, True)\\n except IOError:\\n print(\\\"cannot find .env file\\\")\\n return\\n\\n # Load the .env file\\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\\n\\n\\ndef load_ipython_extension(ipython):\\n \\\"\\\"\\\"Register the %dotenv magic.\\\"\\\"\\\"\\n ipython.register_magics(IPythonDotEnv)\\n\\n[end of src/dotenv/ipython.py]\",\n \"filename\": \"src/dotenv/ipython.py\",\n \"id\": \"23\"\n },\n {\n \"content\": \"# Marker file for PEP 561\\n\\n[end of src/dotenv/py.typed]\",\n \"filename\": \"src/dotenv/py.typed\",\n \"id\": \"24\"\n },\n {\n \"content\": \"import io\\nimport logging\\nimport os\\nimport pathlib\\nimport shutil\\nimport sys\\nimport tempfile\\nfrom collections import OrderedDict\\nfrom contextlib import contextmanager\\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\\n\\nfrom .parser import Binding, parse_stream\\nfrom .variables import parse_variables\\n\\n# A type alias for a string path to be used for the paths in this file.\\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\\n# only accepts string paths, not byte paths or file descriptors. See\\n# https://github.com/python/typeshed/pull/6832.\\nStrPath = Union[str, \\\"os.PathLike[str]\\\"]\\n\\nlogger = logging.getLogger(__name__)\\n\\n\\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\\n for mapping in mappings:\\n if mapping.error:\\n logger.warning(\\n \\\"python-dotenv could not parse statement starting at line %s\\\",\\n mapping.original.line,\\n )\\n yield mapping\\n\\n\\nclass DotEnv:\\n def __init__(\\n self,\\n dotenv_path: Optional[StrPath],\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n encoding: Optional[str] = None,\\n interpolate: bool = True,\\n override: bool = True,\\n ) -> None:\\n self.dotenv_path: Optional[StrPath] = dotenv_path\\n self.stream: Optional[IO[str]] = stream\\n self._dict: Optional[Dict[str, Optional[str]]] = None\\n self.verbose: bool = verbose\\n self.encoding: Optional[str] = encoding\\n self.interpolate: bool = interpolate\\n self.override: bool = override\\n\\n @contextmanager\\n def _get_stream(self) -> Iterator[IO[str]]:\\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\\n with open(self.dotenv_path, encoding=self.encoding) as stream:\\n yield stream\\n elif self.stream is not None:\\n yield self.stream\\n else:\\n if self.verbose:\\n logger.info(\\n \\\"python-dotenv could not find configuration file %s.\\\",\\n self.dotenv_path or \\\".env\\\",\\n )\\n yield io.StringIO(\\\"\\\")\\n\\n def dict(self) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"Return dotenv as dict\\\"\\\"\\\"\\n if self._dict:\\n return self._dict\\n\\n raw_values = self.parse()\\n\\n if self.interpolate:\\n self._dict = OrderedDict(\\n resolve_variables(raw_values, override=self.override)\\n )\\n else:\\n self._dict = OrderedDict(raw_values)\\n\\n return self._dict\\n\\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\\n with self._get_stream() as stream:\\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\\n if mapping.key is not None:\\n yield mapping.key, mapping.value\\n\\n def set_as_environment_variables(self) -> bool:\\n \\\"\\\"\\\"\\n Load the current dotenv as system environment variable.\\n \\\"\\\"\\\"\\n if not self.dict():\\n return False\\n\\n for k, v in self.dict().items():\\n if k in os.environ and not self.override:\\n continue\\n if v is not None:\\n os.environ[k] = v\\n\\n return True\\n\\n def get(self, key: str) -> Optional[str]:\\n \\\"\\\"\\\" \\\"\\\"\\\"\\n data = self.dict()\\n\\n if key in data:\\n return data[key]\\n\\n if self.verbose:\\n logger.warning(\\\"Key %s not found in %s.\\\", key, self.dotenv_path)\\n\\n return None\\n\\n\\ndef get_key(\\n dotenv_path: StrPath,\\n key_to_get: str,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Optional[str]:\\n \\\"\\\"\\\"\\n Get the value of a given key from the given .env.\\n\\n Returns `None` if the key isn't found or doesn't have a value.\\n \\\"\\\"\\\"\\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\\n\\n\\n@contextmanager\\ndef rewrite(\\n path: StrPath,\\n encoding: Optional[str],\\n) -> Iterator[Tuple[IO[str], IO[str]]]:\\n pathlib.Path(path).touch()\\n\\n with tempfile.NamedTemporaryFile(mode=\\\"w\\\", encoding=encoding, delete=False) as dest:\\n error = None\\n try:\\n with open(path, encoding=encoding) as source:\\n yield (source, dest)\\n except BaseException as err:\\n error = err\\n\\n if error is None:\\n shutil.move(dest.name, path)\\n else:\\n os.unlink(dest.name)\\n raise error from None\\n\\n\\ndef set_key(\\n dotenv_path: StrPath,\\n key_to_set: str,\\n value_to_set: str,\\n quote_mode: str = \\\"always\\\",\\n export: bool = False,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str, str]:\\n \\\"\\\"\\\"\\n Adds or Updates a key/value to the given .env\\n\\n If the .env path given doesn't exist, fails instead of risking creating\\n an orphan .env somewhere in the filesystem\\n \\\"\\\"\\\"\\n if quote_mode not in (\\\"always\\\", \\\"auto\\\", \\\"never\\\"):\\n raise ValueError(f\\\"Unknown quote_mode: {quote_mode}\\\")\\n\\n quote = quote_mode == \\\"always\\\" or (\\n quote_mode == \\\"auto\\\" and not value_to_set.isalnum()\\n )\\n\\n if quote:\\n value_out = \\\"'{}'\\\".format(value_to_set.replace(\\\"'\\\", \\\"\\\\\\\\'\\\"))\\n else:\\n value_out = value_to_set\\n if export:\\n line_out = f\\\"export {key_to_set}={value_out}\\\\n\\\"\\n else:\\n line_out = f\\\"{key_to_set}={value_out}\\\\n\\\"\\n\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n replaced = False\\n missing_newline = False\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_set:\\n dest.write(line_out)\\n replaced = True\\n else:\\n dest.write(mapping.original.string)\\n missing_newline = not mapping.original.string.endswith(\\\"\\\\n\\\")\\n if not replaced:\\n if missing_newline:\\n dest.write(\\\"\\\\n\\\")\\n dest.write(line_out)\\n\\n return True, key_to_set, value_to_set\\n\\n\\ndef unset_key(\\n dotenv_path: StrPath,\\n key_to_unset: str,\\n quote_mode: str = \\\"always\\\",\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str]:\\n \\\"\\\"\\\"\\n Removes a given key from the given `.env` file.\\n\\n If the .env path given doesn't exist, fails.\\n If the given key doesn't exist in the .env, fails.\\n \\\"\\\"\\\"\\n if not os.path.exists(dotenv_path):\\n logger.warning(\\\"Can't delete from %s - it doesn't exist.\\\", dotenv_path)\\n return None, key_to_unset\\n\\n removed = False\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_unset:\\n removed = True\\n else:\\n dest.write(mapping.original.string)\\n\\n if not removed:\\n logger.warning(\\n \\\"Key %s not removed from %s - key doesn't exist.\\\", key_to_unset, dotenv_path\\n )\\n return None, key_to_unset\\n\\n return removed, key_to_unset\\n\\n\\ndef resolve_variables(\\n values: Iterable[Tuple[str, Optional[str]]],\\n override: bool,\\n) -> Mapping[str, Optional[str]]:\\n new_values: Dict[str, Optional[str]] = {}\\n\\n for name, value in values:\\n if value is None:\\n result = None\\n else:\\n atoms = parse_variables(value)\\n env: Dict[str, Optional[str]] = {}\\n if override:\\n env.update(os.environ) # type: ignore\\n env.update(new_values)\\n else:\\n env.update(new_values)\\n env.update(os.environ) # type: ignore\\n result = \\\"\\\".join(atom.resolve(env) for atom in atoms)\\n\\n new_values[name] = result\\n\\n return new_values\\n\\n\\ndef _walk_to_root(path: str) -> Iterator[str]:\\n \\\"\\\"\\\"\\n Yield directories starting from the given directory up to the root\\n \\\"\\\"\\\"\\n if not os.path.exists(path):\\n raise IOError(\\\"Starting path not found\\\")\\n\\n if os.path.isfile(path):\\n path = os.path.dirname(path)\\n\\n last_dir = None\\n current_dir = os.path.abspath(path)\\n while last_dir != current_dir:\\n yield current_dir\\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\\n last_dir, current_dir = current_dir, parent_dir\\n\\n\\ndef find_dotenv(\\n filename: str = \\\".env\\\",\\n raise_error_if_not_found: bool = False,\\n usecwd: bool = False,\\n) -> str:\\n \\\"\\\"\\\"\\n Search in increasingly higher folders for the given file\\n\\n Returns path to the file if found, or an empty string otherwise\\n \\\"\\\"\\\"\\n\\n def _is_interactive():\\n \\\"\\\"\\\"Decide whether this is running in a REPL or IPython notebook\\\"\\\"\\\"\\n try:\\n main = __import__(\\\"__main__\\\", None, None, fromlist=[\\\"__file__\\\"])\\n except ModuleNotFoundError:\\n return False\\n return not hasattr(main, \\\"__file__\\\")\\n\\n if usecwd or _is_interactive() or getattr(sys, \\\"frozen\\\", False):\\n # Should work without __file__, e.g. in REPL or IPython notebook.\\n path = os.getcwd()\\n else:\\n # will work for .py files\\n frame = sys._getframe()\\n current_file = __file__\\n\\n while frame.f_code.co_filename == current_file or not os.path.exists(\\n frame.f_code.co_filename\\n ):\\n assert frame.f_back is not None\\n frame = frame.f_back\\n frame_filename = frame.f_code.co_filename\\n path = os.path.dirname(os.path.abspath(frame_filename))\\n\\n for dirname in _walk_to_root(path):\\n check_path = os.path.join(dirname, filename)\\n if os.path.isfile(check_path):\\n return check_path\\n\\n if raise_error_if_not_found:\\n raise IOError(\\\"File not found\\\")\\n\\n return \\\"\\\"\\n\\n\\ndef load_dotenv(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n override: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> bool:\\n \\\"\\\"\\\"Parse a .env file and then load all the variables found as environment variables.\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to .env file.\\n stream: Text stream (such as `io.StringIO`) with .env content, used if\\n `dotenv_path` is `None`.\\n verbose: Whether to output a warning the .env file is missing.\\n override: Whether to override the system environment variables with the variables\\n from the `.env` file.\\n encoding: Encoding to be used to read the file.\\n Returns:\\n Bool: True if at least one environment variable is set else False\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file with it's default parameters. If you need to change the default parameters\\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\\n to this function as `dotenv_path`.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n dotenv = DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=override,\\n encoding=encoding,\\n )\\n return dotenv.set_as_environment_variables()\\n\\n\\ndef dotenv_values(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"\\n Parse a .env file and return its content as a dict.\\n\\n The returned dict will have `None` values for keys without values in the .env file.\\n For example, `foo=bar` results in `{\\\"foo\\\": \\\"bar\\\"}` whereas `foo` alone results in\\n `{\\\"foo\\\": None}`\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to the .env file.\\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\\n verbose: Whether to output a warning if the .env file is missing.\\n encoding: Encoding to be used to read the file.\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n return DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=True,\\n encoding=encoding,\\n ).dict()\\n\\n[end of src/dotenv/main.py]\",\n \"filename\": \"src/dotenv/main.py\",\n \"id\": \"25\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Entry point for cli, enables execution with `python -m dotenv`\\\"\\\"\\\"\\n\\nfrom .cli import cli\\n\\nif __name__ == \\\"__main__\\\":\\n cli()\\n\\n[end of src/dotenv/__main__.py]\",\n \"filename\": \"src/dotenv/__main__.py\",\n \"id\": \"26\"\n }\n]","isConversational":false}}},{"rowIdx":62,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 62,\n \"num_files\": 27,\n \"repo_id\": \"repo_0062\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n handlers:\n python:\n rendering:\n show_root_heading: yes\n show_submodules: no\n separate_signature: yes\n - search\nnav:\n - Home: index.md\n - Changelog: changelog.md\n - Contributing: contributing.md\n - Reference: reference.md\n - License: license.md\n\n[end of mkdocs.yml]","filename":"mkdocs.yml","id":"0"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"black~=22.3.0\nbumpversion\nclick\nflake8>=2.2.3\nipython\npytest-cov\npytest>=3.9\nsh>=2\ntox\ntwine\nwheel\n\n[end of requirements.txt]","filename":"requirements.txt","id":"2"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"3"},{"content":".PHONY: clean-pyc clean-build test\n\nclean: clean-build clean-pyc\n\nclean-build:\n\trm -fr build/\n\trm -fr dist/\n\trm -fr src/*.egg-info\n\nclean-pyc:\n\tfind . -name '*.pyc' -exec rm -f {} +\n\tfind . -name '*.pyo' -exec rm -f {} +\n\tfind . -name '*~' -exec rm -f {} +\n\nrelease: sdist\n\ttwine check dist/*\n\ttwine upload dist/*\n\nrelease-test: sdist\n\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\n\nsdist: clean\n\tpython setup.py sdist bdist_wheel\n\tls -l dist\n\ntest:\n\tpip install -e .\n\tflake8 .\n\tpy.test tests/\n\ncoverage:\n\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\n\tcoverage report\n\ncoverage-html: coverage\n\tcoverage html\n\n[end of Makefile]","filename":"Makefile","id":"4"},{"content":"mdx_truly_sane_lists~=1.2\nmkdocs-include-markdown-plugin~=3.3.0\nmkdocs-material~=8.2.9\nmkdocstrings[python]~=0.18.1\nmkdocs~=1.3.0\n\n[end of requirements-docs.txt]","filename":"requirements-docs.txt","id":"5"},{"content":"include LICENSE *.md *.yml *.toml\n\ninclude tox.ini\nrecursive-include docs *.md\nrecursive-include tests *.py\n\ninclude .bumpversion.cfg\ninclude .coveragerc\ninclude .editorconfig\ninclude Makefile\ninclude requirements.txt\ninclude requirements-docs.txt\ninclude src/dotenv/py.typed\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"6"},{"content":"# see: http://editorconfig.org\n\nroot = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.{py,rst,ini}]\nindent_style = space\nindent_size = 4\n\n[*.yml]\nindent_style = space\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"7"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of README.md]","filename":"README.md","id":"8"},{"content":"from setuptools import setup\n\n\ndef read_files(files):\n data = []\n for file in files:\n with open(file, encoding=\"utf-8\") as f:\n data.append(f.read())\n return \"\\n\".join(data)\n\n\nlong_description = read_files([\"README.md\", \"CHANGELOG.md\"])\n\nmeta = {}\nwith open(\"./src/dotenv/version.py\", encoding=\"utf-8\") as f:\n exec(f.read(), meta)\n\nsetup(\n name=\"python-dotenv\",\n description=\"Read key-value pairs from a .env file and set them as environment variables\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n version=meta[\"__version__\"],\n author=\"Saurabh Kumar\",\n author_email=\"me+github@saurabh-kumar.com\",\n url=\"https://github.com/theskumar/python-dotenv\",\n keywords=[\n \"environment variables\",\n \"deployments\",\n \"settings\",\n \"env\",\n \"dotenv\",\n \"configurations\",\n \"python\",\n ],\n packages=[\"dotenv\"],\n package_dir={\"\": \"src\"},\n package_data={\n \"dotenv\": [\"py.typed\"],\n },\n python_requires=\">=3.9\",\n extras_require={\n \"cli\": [\n \"click>=5.0\",\n ],\n },\n entry_points={\n \"console_scripts\": [\n \"dotenv=dotenv.__main__:cli\",\n ],\n },\n license=\"BSD-3-Clause\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Topic :: System :: Systems Administration\",\n \"Topic :: Utilities\",\n \"Environment :: Web Environment\",\n ],\n)\n\n[end of setup.py]","filename":"setup.py","id":"9"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of CONTRIBUTING.md]","filename":"CONTRIBUTING.md","id":"10"},{"content":"[tox]\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\n\n[gh-actions]\npython =\n 3.9: py39\n 3.10: py310\n 3.11: py311\n 3.12: py312\n 3.13: py313, lint, manifest\n pypy-3.9: pypy3\n\n[testenv]\ndeps =\n pytest\n pytest-cov\n sh >= 2.0.2, <3\n click\n py{39,310,311,312,313,pypy3}: ipython\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\ndepends =\n py{39,310,311,312,313},pypy3: coverage-clean\n coverage-report: py{39,310,311,312,313},pypy3\n\n[testenv:lint]\nskip_install = true\ndeps =\n flake8\n mypy\ncommands =\n flake8 src tests\n mypy --python-version=3.13 src tests\n mypy --python-version=3.12 src tests\n mypy --python-version=3.11 src tests\n mypy --python-version=3.10 src tests\n mypy --python-version=3.9 src tests\n\n[testenv:manifest]\ndeps = check-manifest\nskip_install = true\ncommands = check-manifest\n\n[testenv:coverage-clean]\ndeps = coverage\nskip_install = true\ncommands = coverage erase\n\n[testenv:coverage-report]\ndeps = coverage\nskip_install = true\ncommands =\n coverage report\n\n[end of tox.ini]","filename":"tox.ini","id":"11"},{"content":"[bumpversion]\ncurrent_version = 1.0.1\ncommit = True\ntag = True\n\n[bumpversion:file:src/dotenv/version.py]\n\n[flake8]\nmax-line-length = 120\nexclude = .tox,.git,docs,venv,.venv,build\n\n[mypy]\ncheck_untyped_defs = true\nignore_missing_imports = true\n\n[metadata]\ndescription_file = README.md\n\n[tool:pytest]\ntestpaths = tests\n\n[coverage:run]\nrelative_files = True\nsource = dotenv\n\n[coverage:paths]\nsource =\n\tsrc/dotenv\n\t.tox/*/lib/python*/site-packages/dotenv\n\t.tox/pypy*/site-packages/dotenv\n\n[coverage:report]\nshow_missing = True\ninclude = */site-packages/dotenv/*\nexclude_lines =\n\tif IS_TYPE_CHECKING:\n\tpragma: no cover\n\n[end of setup.cfg]","filename":"setup.cfg","id":"12"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of docs/license.md]","filename":"docs/license.md","id":"13"},{"content":"# ::: dotenv\n\n\n[end of docs/reference.md]","filename":"docs/reference.md","id":"14"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of docs/changelog.md]","filename":"docs/changelog.md","id":"15"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of docs/index.md]","filename":"docs/index.md","id":"16"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of docs/contributing.md]","filename":"docs/contributing.md","id":"17"},{"content":"__version__ = \"1.0.1\"\n\n[end of src/dotenv/version.py]","filename":"src/dotenv/version.py","id":"18"},{"content":"import re\nfrom abc import ABCMeta, abstractmethod\nfrom typing import Iterator, Mapping, Optional, Pattern\n\n_posix_variable: Pattern[str] = re.compile(\n r\"\"\"\n \\$\\{\n (?P<name>[^\\}:]*)\n (?::-\n (?P<default>[^\\}]*)\n )?\n \\}\n \"\"\",\n re.VERBOSE,\n)\n\n\nclass Atom(metaclass=ABCMeta):\n def __ne__(self, other: object) -> bool:\n result = self.__eq__(other)\n if result is NotImplemented:\n return NotImplemented\n return not result\n\n @abstractmethod\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\n\n\nclass Literal(Atom):\n def __init__(self, value: str) -> None:\n self.value = value\n\n def __repr__(self) -> str:\n return f\"Literal(value={self.value})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return self.value == other.value\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.value))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n return self.value\n\n\nclass Variable(Atom):\n def __init__(self, name: str, default: Optional[str]) -> None:\n self.name = name\n self.default = default\n\n def __repr__(self) -> str:\n return f\"Variable(name={self.name}, default={self.default})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return (self.name, self.default) == (other.name, other.default)\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.name, self.default))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n default = self.default if self.default is not None else \"\"\n result = env.get(self.name, default)\n return result if result is not None else \"\"\n\n\ndef parse_variables(value: str) -> Iterator[Atom]:\n cursor = 0\n\n for match in _posix_variable.finditer(value):\n (start, end) = match.span()\n name = match[\"name\"]\n default = match[\"default\"]\n\n if start > cursor:\n yield Literal(value=value[cursor:start])\n\n yield Variable(name=name, default=default)\n cursor = end\n\n length = len(value)\n if cursor < length:\n yield Literal(value=value[cursor:length])\n\n[end of src/dotenv/variables.py]","filename":"src/dotenv/variables.py","id":"19"},{"content":"from typing import Any, Optional\n\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\n unset_key)\n\n\ndef load_ipython_extension(ipython: Any) -> None:\n from .ipython import load_ipython_extension\n load_ipython_extension(ipython)\n\n\ndef get_cli_string(\n path: Optional[str] = None,\n action: Optional[str] = None,\n key: Optional[str] = None,\n value: Optional[str] = None,\n quote: Optional[str] = None,\n):\n \"\"\"Returns a string suitable for running as a shell script.\n\n Useful for converting a arguments passed to a fabric task\n to be passed to a `local` or `run` command.\n \"\"\"\n command = ['dotenv']\n if quote:\n command.append(f'-q {quote}')\n if path:\n command.append(f'-f {path}')\n if action:\n command.append(action)\n if key:\n command.append(key)\n if value:\n if ' ' in value:\n command.append(f'\"{value}\"')\n else:\n command.append(value)\n\n return ' '.join(command).strip()\n\n\n__all__ = ['get_cli_string',\n 'load_dotenv',\n 'dotenv_values',\n 'get_key',\n 'set_key',\n 'unset_key',\n 'find_dotenv',\n 'load_ipython_extension']\n\n[end of src/dotenv/__init__.py]","filename":"src/dotenv/__init__.py","id":"20"},{"content":"import codecs\nimport re\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\n Pattern, Sequence, Tuple)\n\n\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\n return re.compile(string, re.UNICODE | extra_flags)\n\n\n_newline = make_regex(r\"(\\r\\n|\\n|\\r)\")\n_multiline_whitespace = make_regex(r\"\\s*\", extra_flags=re.MULTILINE)\n_whitespace = make_regex(r\"[^\\S\\r\\n]*\")\n_export = make_regex(r\"(?:export[^\\S\\r\\n]+)?\")\n_single_quoted_key = make_regex(r\"'([^']+)'\")\n_unquoted_key = make_regex(r\"([^=\\#\\s]+)\")\n_equal_sign = make_regex(r\"(=[^\\S\\r\\n]*)\")\n_single_quoted_value = make_regex(r\"'((?:\\\\'|[^'])*)'\")\n_double_quoted_value = make_regex(r'\"((?:\\\\\"|[^\"])*)\"')\n_unquoted_value = make_regex(r\"([^\\r\\n]*)\")\n_comment = make_regex(r\"(?:[^\\S\\r\\n]*#[^\\r\\n]*)?\")\n_end_of_line = make_regex(r\"[^\\S\\r\\n]*(?:\\r\\n|\\n|\\r|$)\")\n_rest_of_line = make_regex(r\"[^\\r\\n]*(?:\\r|\\n|\\r\\n)?\")\n_double_quote_escapes = make_regex(r\"\\\\[\\\\'\\\"abfnrtv]\")\n_single_quote_escapes = make_regex(r\"\\\\[\\\\']\")\n\n\nclass Original(NamedTuple):\n string: str\n line: int\n\n\nclass Binding(NamedTuple):\n key: Optional[str]\n value: Optional[str]\n original: Original\n error: bool\n\n\nclass Position:\n def __init__(self, chars: int, line: int) -> None:\n self.chars = chars\n self.line = line\n\n @classmethod\n def start(cls) -> \"Position\":\n return cls(chars=0, line=1)\n\n def set(self, other: \"Position\") -> None:\n self.chars = other.chars\n self.line = other.line\n\n def advance(self, string: str) -> None:\n self.chars += len(string)\n self.line += len(re.findall(_newline, string))\n\n\nclass Error(Exception):\n pass\n\n\nclass Reader:\n def __init__(self, stream: IO[str]) -> None:\n self.string = stream.read()\n self.position = Position.start()\n self.mark = Position.start()\n\n def has_next(self) -> bool:\n return self.position.chars < len(self.string)\n\n def set_mark(self) -> None:\n self.mark.set(self.position)\n\n def get_marked(self) -> Original:\n return Original(\n string=self.string[self.mark.chars:self.position.chars],\n line=self.mark.line,\n )\n\n def peek(self, count: int) -> str:\n return self.string[self.position.chars:self.position.chars + count]\n\n def read(self, count: int) -> str:\n result = self.string[self.position.chars:self.position.chars + count]\n if len(result) < count:\n raise Error(\"read: End of string\")\n self.position.advance(result)\n return result\n\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\n match = regex.match(self.string, self.position.chars)\n if match is None:\n raise Error(\"read_regex: Pattern not found\")\n self.position.advance(self.string[match.start():match.end()])\n return match.groups()\n\n\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\n def decode_match(match: Match[str]) -> str:\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\n\n return regex.sub(decode_match, string)\n\n\ndef parse_key(reader: Reader) -> Optional[str]:\n char = reader.peek(1)\n if char == \"#\":\n return None\n elif char == \"'\":\n (key,) = reader.read_regex(_single_quoted_key)\n else:\n (key,) = reader.read_regex(_unquoted_key)\n return key\n\n\ndef parse_unquoted_value(reader: Reader) -> str:\n (part,) = reader.read_regex(_unquoted_value)\n return re.sub(r\"\\s+#.*\", \"\", part).rstrip()\n\n\ndef parse_value(reader: Reader) -> str:\n char = reader.peek(1)\n if char == u\"'\":\n (value,) = reader.read_regex(_single_quoted_value)\n return decode_escapes(_single_quote_escapes, value)\n elif char == u'\"':\n (value,) = reader.read_regex(_double_quoted_value)\n return decode_escapes(_double_quote_escapes, value)\n elif char in (u\"\", u\"\\n\", u\"\\r\"):\n return u\"\"\n else:\n return parse_unquoted_value(reader)\n\n\ndef parse_binding(reader: Reader) -> Binding:\n reader.set_mark()\n try:\n reader.read_regex(_multiline_whitespace)\n if not reader.has_next():\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=False,\n )\n reader.read_regex(_export)\n key = parse_key(reader)\n reader.read_regex(_whitespace)\n if reader.peek(1) == \"=\":\n reader.read_regex(_equal_sign)\n value: Optional[str] = parse_value(reader)\n else:\n value = None\n reader.read_regex(_comment)\n reader.read_regex(_end_of_line)\n return Binding(\n key=key,\n value=value,\n original=reader.get_marked(),\n error=False,\n )\n except Error:\n reader.read_regex(_rest_of_line)\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=True,\n )\n\n\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\n reader = Reader(stream)\n while reader.has_next():\n yield parse_binding(reader)\n\n[end of src/dotenv/parser.py]","filename":"src/dotenv/parser.py","id":"21"},{"content":"import json\nimport os\nimport shlex\nimport sys\nfrom contextlib import contextmanager\nfrom typing import Any, Dict, IO, Iterator, List, Optional\n\ntry:\n import click\nexcept ImportError:\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\n'\n 'Run pip install \"python-dotenv[cli]\" to fix this.')\n sys.exit(1)\n\nfrom .main import dotenv_values, set_key, unset_key\nfrom .version import __version__\n\n\ndef enumerate_env() -> Optional[str]:\n \"\"\"\n Return a path for the ${pwd}/.env file.\n\n If pwd does not exist, return None.\n \"\"\"\n try:\n cwd = os.getcwd()\n except FileNotFoundError:\n return None\n path = os.path.join(cwd, '.env')\n return path\n\n\n@click.group()\n@click.option('-f', '--file', default=enumerate_env(),\n type=click.Path(file_okay=True),\n help=\"Location of the .env file, defaults to .env file in current working directory.\")\n@click.option('-q', '--quote', default='always',\n type=click.Choice(['always', 'never', 'auto']),\n help=\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\")\n@click.option('-e', '--export', default=False,\n type=click.BOOL,\n help=\"Whether to write the dot file as an executable bash script.\")\n@click.version_option(version=__version__)\n@click.pass_context\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\n \"\"\"This script is used to set, get or unset values from a .env file.\"\"\"\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\n\n\n@contextmanager\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\n \"\"\"\n Open a file and yield the corresponding (decoded) stream.\n\n Exits with error code 2 if the file cannot be opened.\n \"\"\"\n\n try:\n with open(path) as stream:\n yield stream\n except OSError as exc:\n print(f\"Error opening env file: {exc}\", file=sys.stderr)\n exit(2)\n\n\n@cli.command()\n@click.pass_context\n@click.option('--format', default='simple',\n type=click.Choice(['simple', 'json', 'shell', 'export']),\n help=\"The format in which to display the list. Default format is simple, \"\n \"which displays name=value without quotes.\")\ndef list(ctx: click.Context, format: bool) -> None:\n \"\"\"Display all the stored key/value.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n if format == 'json':\n click.echo(json.dumps(values, indent=2, sort_keys=True))\n else:\n prefix = 'export ' if format == 'export' else ''\n for k in sorted(values):\n v = values[k]\n if v is not None:\n if format in ('export', 'shell'):\n v = shlex.quote(v)\n click.echo(f'{prefix}{k}={v}')\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\n@click.argument('value', required=True)\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\n \"\"\"Store the given key/value.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n export = ctx.obj['EXPORT']\n success, key, value = set_key(file, key, value, quote, export)\n if success:\n click.echo(f'{key}={value}')\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef get(ctx: click.Context, key: Any) -> None:\n \"\"\"Retrieve the value for the given key.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n stored_value = values.get(key)\n if stored_value:\n click.echo(stored_value)\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef unset(ctx: click.Context, key: Any) -> None:\n \"\"\"Removes the given key.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n success, key = unset_key(file, key, quote)\n if success:\n click.echo(f\"Successfully removed {key}\")\n else:\n exit(1)\n\n\n@cli.command(context_settings={'ignore_unknown_options': True})\n@click.pass_context\n@click.option(\n \"--override/--no-override\",\n default=True,\n help=\"Override variables from the environment file with those from the .env file.\",\n)\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\n \"\"\"Run command with environment variables present.\"\"\"\n file = ctx.obj['FILE']\n if not os.path.isfile(file):\n raise click.BadParameter(\n f'Invalid value for \\'-f\\' \"{file}\" does not exist.',\n ctx=ctx\n )\n dotenv_as_dict = {\n k: v\n for (k, v) in dotenv_values(file).items()\n if v is not None and (override or k not in os.environ)\n }\n\n if not commandline:\n click.echo('No command given.')\n exit(1)\n run_command(commandline, dotenv_as_dict)\n\n\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\n \"\"\"Replace the current process with the specified command.\n\n Replaces the current process with the specified command and the variables from `env`\n added in the current environment variables.\n\n Parameters\n ----------\n command: List[str]\n The command and it's parameters\n env: Dict\n The additional environment variables\n\n Returns\n -------\n None\n This function does not return any value. It replaces the current process with the new one.\n\n \"\"\"\n # copy the current environment variables and add the vales from\n # `env`\n cmd_env = os.environ.copy()\n cmd_env.update(env)\n\n os.execvpe(command[0], args=command, env=cmd_env)\n\n[end of src/dotenv/cli.py]","filename":"src/dotenv/cli.py","id":"22"},{"content":"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\n parse_argstring) # type: ignore\n\nfrom .main import find_dotenv, load_dotenv\n\n\n@magics_class\nclass IPythonDotEnv(Magics):\n\n @magic_arguments()\n @argument(\n '-o', '--override', action='store_true',\n help=\"Indicate to override existing variables\"\n )\n @argument(\n '-v', '--verbose', action='store_true',\n help=\"Indicate function calls to be verbose\"\n )\n @argument('dotenv_path', nargs='?', type=str, default='.env',\n help='Search in increasingly higher folders for the `dotenv_path`')\n @line_magic\n def dotenv(self, line):\n args = parse_argstring(self.dotenv, line)\n # Locate the .env file\n dotenv_path = args.dotenv_path\n try:\n dotenv_path = find_dotenv(dotenv_path, True, True)\n except IOError:\n print(\"cannot find .env file\")\n return\n\n # Load the .env file\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\n\n\ndef load_ipython_extension(ipython):\n \"\"\"Register the %dotenv magic.\"\"\"\n ipython.register_magics(IPythonDotEnv)\n\n[end of src/dotenv/ipython.py]","filename":"src/dotenv/ipython.py","id":"23"},{"content":"# Marker file for PEP 561\n\n[end of src/dotenv/py.typed]","filename":"src/dotenv/py.typed","id":"24"},{"content":"import io\nimport logging\nimport os\nimport pathlib\nimport shutil\nimport sys\nimport tempfile\nfrom collections import OrderedDict\nfrom contextlib import contextmanager\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\n\nfrom .parser import Binding, parse_stream\nfrom .variables import parse_variables\n\n# A type alias for a string path to be used for the paths in this file.\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\n# only accepts string paths, not byte paths or file descriptors. See\n# https://github.com/python/typeshed/pull/6832.\nStrPath = Union[str, \"os.PathLike[str]\"]\n\nlogger = logging.getLogger(__name__)\n\n\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\n for mapping in mappings:\n if mapping.error:\n logger.warning(\n \"python-dotenv could not parse statement starting at line %s\",\n mapping.original.line,\n )\n yield mapping\n\n\nclass DotEnv:\n def __init__(\n self,\n dotenv_path: Optional[StrPath],\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n encoding: Optional[str] = None,\n interpolate: bool = True,\n override: bool = True,\n ) -> None:\n self.dotenv_path: Optional[StrPath] = dotenv_path\n self.stream: Optional[IO[str]] = stream\n self._dict: Optional[Dict[str, Optional[str]]] = None\n self.verbose: bool = verbose\n self.encoding: Optional[str] = encoding\n self.interpolate: bool = interpolate\n self.override: bool = override\n\n @contextmanager\n def _get_stream(self) -> Iterator[IO[str]]:\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\n with open(self.dotenv_path, encoding=self.encoding) as stream:\n yield stream\n elif self.stream is not None:\n yield self.stream\n else:\n if self.verbose:\n logger.info(\n \"python-dotenv could not find configuration file %s.\",\n self.dotenv_path or \".env\",\n )\n yield io.StringIO(\"\")\n\n def dict(self) -> Dict[str, Optional[str]]:\n \"\"\"Return dotenv as dict\"\"\"\n if self._dict:\n return self._dict\n\n raw_values = self.parse()\n\n if self.interpolate:\n self._dict = OrderedDict(\n resolve_variables(raw_values, override=self.override)\n )\n else:\n self._dict = OrderedDict(raw_values)\n\n return self._dict\n\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\n with self._get_stream() as stream:\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\n if mapping.key is not None:\n yield mapping.key, mapping.value\n\n def set_as_environment_variables(self) -> bool:\n \"\"\"\n Load the current dotenv as system environment variable.\n \"\"\"\n if not self.dict():\n return False\n\n for k, v in self.dict().items():\n if k in os.environ and not self.override:\n continue\n if v is not None:\n os.environ[k] = v\n\n return True\n\n def get(self, key: str) -> Optional[str]:\n \"\"\" \"\"\"\n data = self.dict()\n\n if key in data:\n return data[key]\n\n if self.verbose:\n logger.warning(\"Key %s not found in %s.\", key, self.dotenv_path)\n\n return None\n\n\ndef get_key(\n dotenv_path: StrPath,\n key_to_get: str,\n encoding: Optional[str] = \"utf-8\",\n) -> Optional[str]:\n \"\"\"\n Get the value of a given key from the given .env.\n\n Returns `None` if the key isn't found or doesn't have a value.\n \"\"\"\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\n\n\n@contextmanager\ndef rewrite(\n path: StrPath,\n encoding: Optional[str],\n) -> Iterator[Tuple[IO[str], IO[str]]]:\n pathlib.Path(path).touch()\n\n with tempfile.NamedTemporaryFile(mode=\"w\", encoding=encoding, delete=False) as dest:\n error = None\n try:\n with open(path, encoding=encoding) as source:\n yield (source, dest)\n except BaseException as err:\n error = err\n\n if error is None:\n shutil.move(dest.name, path)\n else:\n os.unlink(dest.name)\n raise error from None\n\n\ndef set_key(\n dotenv_path: StrPath,\n key_to_set: str,\n value_to_set: str,\n quote_mode: str = \"always\",\n export: bool = False,\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str, str]:\n \"\"\"\n Adds or Updates a key/value to the given .env\n\n If the .env path given doesn't exist, fails instead of risking creating\n an orphan .env somewhere in the filesystem\n \"\"\"\n if quote_mode not in (\"always\", \"auto\", \"never\"):\n raise ValueError(f\"Unknown quote_mode: {quote_mode}\")\n\n quote = quote_mode == \"always\" or (\n quote_mode == \"auto\" and not value_to_set.isalnum()\n )\n\n if quote:\n value_out = \"'{}'\".format(value_to_set.replace(\"'\", \"\\\\'\"))\n else:\n value_out = value_to_set\n if export:\n line_out = f\"export {key_to_set}={value_out}\\n\"\n else:\n line_out = f\"{key_to_set}={value_out}\\n\"\n\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n replaced = False\n missing_newline = False\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_set:\n dest.write(line_out)\n replaced = True\n else:\n dest.write(mapping.original.string)\n missing_newline = not mapping.original.string.endswith(\"\\n\")\n if not replaced:\n if missing_newline:\n dest.write(\"\\n\")\n dest.write(line_out)\n\n return True, key_to_set, value_to_set\n\n\ndef unset_key(\n dotenv_path: StrPath,\n key_to_unset: str,\n quote_mode: str = \"always\",\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str]:\n \"\"\"\n Removes a given key from the given `.env` file.\n\n If the .env path given doesn't exist, fails.\n If the given key doesn't exist in the .env, fails.\n \"\"\"\n if not os.path.exists(dotenv_path):\n logger.warning(\"Can't delete from %s - it doesn't exist.\", dotenv_path)\n return None, key_to_unset\n\n removed = False\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_unset:\n removed = True\n else:\n dest.write(mapping.original.string)\n\n if not removed:\n logger.warning(\n \"Key %s not removed from %s - key doesn't exist.\", key_to_unset, dotenv_path\n )\n return None, key_to_unset\n\n return removed, key_to_unset\n\n\ndef resolve_variables(\n values: Iterable[Tuple[str, Optional[str]]],\n override: bool,\n) -> Mapping[str, Optional[str]]:\n new_values: Dict[str, Optional[str]] = {}\n\n for name, value in values:\n if value is None:\n result = None\n else:\n atoms = parse_variables(value)\n env: Dict[str, Optional[str]] = {}\n if override:\n env.update(os.environ) # type: ignore\n env.update(new_values)\n else:\n env.update(new_values)\n env.update(os.environ) # type: ignore\n result = \"\".join(atom.resolve(env) for atom in atoms)\n\n new_values[name] = result\n\n return new_values\n\n\ndef _walk_to_root(path: str) -> Iterator[str]:\n \"\"\"\n Yield directories starting from the given directory up to the root\n \"\"\"\n if not os.path.exists(path):\n raise IOError(\"Starting path not found\")\n\n if os.path.isfile(path):\n path = os.path.dirname(path)\n\n last_dir = None\n current_dir = os.path.abspath(path)\n while last_dir != current_dir:\n yield current_dir\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\n last_dir, current_dir = current_dir, parent_dir\n\n\ndef find_dotenv(\n filename: str = \".env\",\n raise_error_if_not_found: bool = False,\n usecwd: bool = False,\n) -> str:\n \"\"\"\n Search in increasingly higher folders for the given file\n\n Returns path to the file if found, or an empty string otherwise\n \"\"\"\n\n def _is_interactive():\n \"\"\"Decide whether this is running in a REPL or IPython notebook\"\"\"\n try:\n main = __import__(\"__main__\", None, None, fromlist=[\"__file__\"])\n except ModuleNotFoundError:\n return False\n return not hasattr(main, \"__file__\")\n\n if usecwd or _is_interactive() or getattr(sys, \"frozen\", False):\n # Should work without __file__, e.g. in REPL or IPython notebook.\n path = os.getcwd()\n else:\n # will work for .py files\n frame = sys._getframe()\n current_file = __file__\n\n while frame.f_code.co_filename == current_file or not os.path.exists(\n frame.f_code.co_filename\n ):\n assert frame.f_back is not None\n frame = frame.f_back\n frame_filename = frame.f_code.co_filename\n path = os.path.dirname(os.path.abspath(frame_filename))\n\n for dirname in _walk_to_root(path):\n check_path = os.path.join(dirname, filename)\n if os.path.isfile(check_path):\n return check_path\n\n if raise_error_if_not_found:\n raise IOError(\"File not found\")\n\n return \"\"\n\n\ndef load_dotenv(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n override: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> bool:\n \"\"\"Parse a .env file and then load all the variables found as environment variables.\n\n Parameters:\n dotenv_path: Absolute or relative path to .env file.\n stream: Text stream (such as `io.StringIO`) with .env content, used if\n `dotenv_path` is `None`.\n verbose: Whether to output a warning the .env file is missing.\n override: Whether to override the system environment variables with the variables\n from the `.env` file.\n encoding: Encoding to be used to read the file.\n Returns:\n Bool: True if at least one environment variable is set else False\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file with it's default parameters. If you need to change the default parameters\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\n to this function as `dotenv_path`.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n dotenv = DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=override,\n encoding=encoding,\n )\n return dotenv.set_as_environment_variables()\n\n\ndef dotenv_values(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> Dict[str, Optional[str]]:\n \"\"\"\n Parse a .env file and return its content as a dict.\n\n The returned dict will have `None` values for keys without values in the .env file.\n For example, `foo=bar` results in `{\"foo\": \"bar\"}` whereas `foo` alone results in\n `{\"foo\": None}`\n\n Parameters:\n dotenv_path: Absolute or relative path to the .env file.\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\n verbose: Whether to output a warning if the .env file is missing.\n encoding: Encoding to be used to read the file.\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n return DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=True,\n encoding=encoding,\n ).dict()\n\n[end of src/dotenv/main.py]","filename":"src/dotenv/main.py","id":"25"},{"content":"\"\"\"Entry point for cli, enables execution with `python -m dotenv`\"\"\"\n\nfrom .cli import cli\n\nif __name__ == \"__main__\":\n cli()\n\n[end of src/dotenv/__main__.py]","filename":"src/dotenv/__main__.py","id":"26"}],"string":"[\n {\n \"content\": \"site_name: python-dotenv\\nrepo_url: https://github.com/theskumar/python-dotenv\\nedit_uri: \\\"\\\"\\ntheme:\\n name: material\\n palette:\\n primary: green\\n features:\\n - toc.follow\\n - navigation.sections\\n\\nmarkdown_extensions:\\n - mdx_truly_sane_lists\\n\\nplugins:\\n - mkdocstrings:\\n handlers:\\n python:\\n rendering:\\n show_root_heading: yes\\n show_submodules: no\\n separate_signature: yes\\n - search\\nnav:\\n - Home: index.md\\n - Changelog: changelog.md\\n - Contributing: contributing.md\\n - Reference: reference.md\\n - License: license.md\\n\\n[end of mkdocs.yml]\",\n \"filename\": \"mkdocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"black~=22.3.0\\nbumpversion\\nclick\\nflake8>=2.2.3\\nipython\\npytest-cov\\npytest>=3.9\\nsh>=2\\ntox\\ntwine\\nwheel\\n\\n[end of requirements.txt]\",\n \"filename\": \"requirements.txt\",\n \"id\": \"2\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"3\"\n },\n {\n \"content\": \".PHONY: clean-pyc clean-build test\\n\\nclean: clean-build clean-pyc\\n\\nclean-build:\\n\\trm -fr build/\\n\\trm -fr dist/\\n\\trm -fr src/*.egg-info\\n\\nclean-pyc:\\n\\tfind . -name '*.pyc' -exec rm -f {} +\\n\\tfind . -name '*.pyo' -exec rm -f {} +\\n\\tfind . -name '*~' -exec rm -f {} +\\n\\nrelease: sdist\\n\\ttwine check dist/*\\n\\ttwine upload dist/*\\n\\nrelease-test: sdist\\n\\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\\n\\nsdist: clean\\n\\tpython setup.py sdist bdist_wheel\\n\\tls -l dist\\n\\ntest:\\n\\tpip install -e .\\n\\tflake8 .\\n\\tpy.test tests/\\n\\ncoverage:\\n\\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\\n\\tcoverage report\\n\\ncoverage-html: coverage\\n\\tcoverage html\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"4\"\n },\n {\n \"content\": \"mdx_truly_sane_lists~=1.2\\nmkdocs-include-markdown-plugin~=3.3.0\\nmkdocs-material~=8.2.9\\nmkdocstrings[python]~=0.18.1\\nmkdocs~=1.3.0\\n\\n[end of requirements-docs.txt]\",\n \"filename\": \"requirements-docs.txt\",\n \"id\": \"5\"\n },\n {\n \"content\": \"include LICENSE *.md *.yml *.toml\\n\\ninclude tox.ini\\nrecursive-include docs *.md\\nrecursive-include tests *.py\\n\\ninclude .bumpversion.cfg\\ninclude .coveragerc\\ninclude .editorconfig\\ninclude Makefile\\ninclude requirements.txt\\ninclude requirements-docs.txt\\ninclude src/dotenv/py.typed\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# see: http://editorconfig.org\\n\\nroot = true\\n\\n[*]\\ncharset = utf-8\\nend_of_line = lf\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\n\\n[*.{py,rst,ini}]\\nindent_style = space\\nindent_size = 4\\n\\n[*.yml]\\nindent_style = space\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"8\"\n },\n {\n \"content\": \"from setuptools import setup\\n\\n\\ndef read_files(files):\\n data = []\\n for file in files:\\n with open(file, encoding=\\\"utf-8\\\") as f:\\n data.append(f.read())\\n return \\\"\\\\n\\\".join(data)\\n\\n\\nlong_description = read_files([\\\"README.md\\\", \\\"CHANGELOG.md\\\"])\\n\\nmeta = {}\\nwith open(\\\"./src/dotenv/version.py\\\", encoding=\\\"utf-8\\\") as f:\\n exec(f.read(), meta)\\n\\nsetup(\\n name=\\\"python-dotenv\\\",\\n description=\\\"Read key-value pairs from a .env file and set them as environment variables\\\",\\n long_description=long_description,\\n long_description_content_type=\\\"text/markdown\\\",\\n version=meta[\\\"__version__\\\"],\\n author=\\\"Saurabh Kumar\\\",\\n author_email=\\\"me+github@saurabh-kumar.com\\\",\\n url=\\\"https://github.com/theskumar/python-dotenv\\\",\\n keywords=[\\n \\\"environment variables\\\",\\n \\\"deployments\\\",\\n \\\"settings\\\",\\n \\\"env\\\",\\n \\\"dotenv\\\",\\n \\\"configurations\\\",\\n \\\"python\\\",\\n ],\\n packages=[\\\"dotenv\\\"],\\n package_dir={\\\"\\\": \\\"src\\\"},\\n package_data={\\n \\\"dotenv\\\": [\\\"py.typed\\\"],\\n },\\n python_requires=\\\">=3.9\\\",\\n extras_require={\\n \\\"cli\\\": [\\n \\\"click>=5.0\\\",\\n ],\\n },\\n entry_points={\\n \\\"console_scripts\\\": [\\n \\\"dotenv=dotenv.__main__:cli\\\",\\n ],\\n },\\n license=\\\"BSD-3-Clause\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Programming Language :: Python :: 3.10\\\",\\n \\\"Programming Language :: Python :: 3.11\\\",\\n \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Topic :: System :: Systems Administration\\\",\\n \\\"Topic :: Utilities\\\",\\n \\\"Environment :: Web Environment\\\",\\n ],\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of CONTRIBUTING.md]\",\n \"filename\": \"CONTRIBUTING.md\",\n \"id\": \"10\"\n },\n {\n \"content\": \"[tox]\\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\\n\\n[gh-actions]\\npython =\\n 3.9: py39\\n 3.10: py310\\n 3.11: py311\\n 3.12: py312\\n 3.13: py313, lint, manifest\\n pypy-3.9: pypy3\\n\\n[testenv]\\ndeps =\\n pytest\\n pytest-cov\\n sh >= 2.0.2, <3\\n click\\n py{39,310,311,312,313,pypy3}: ipython\\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\\ndepends =\\n py{39,310,311,312,313},pypy3: coverage-clean\\n coverage-report: py{39,310,311,312,313},pypy3\\n\\n[testenv:lint]\\nskip_install = true\\ndeps =\\n flake8\\n mypy\\ncommands =\\n flake8 src tests\\n mypy --python-version=3.13 src tests\\n mypy --python-version=3.12 src tests\\n mypy --python-version=3.11 src tests\\n mypy --python-version=3.10 src tests\\n mypy --python-version=3.9 src tests\\n\\n[testenv:manifest]\\ndeps = check-manifest\\nskip_install = true\\ncommands = check-manifest\\n\\n[testenv:coverage-clean]\\ndeps = coverage\\nskip_install = true\\ncommands = coverage erase\\n\\n[testenv:coverage-report]\\ndeps = coverage\\nskip_install = true\\ncommands =\\n coverage report\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"11\"\n },\n {\n \"content\": \"[bumpversion]\\ncurrent_version = 1.0.1\\ncommit = True\\ntag = True\\n\\n[bumpversion:file:src/dotenv/version.py]\\n\\n[flake8]\\nmax-line-length = 120\\nexclude = .tox,.git,docs,venv,.venv,build\\n\\n[mypy]\\ncheck_untyped_defs = true\\nignore_missing_imports = true\\n\\n[metadata]\\ndescription_file = README.md\\n\\n[tool:pytest]\\ntestpaths = tests\\n\\n[coverage:run]\\nrelative_files = True\\nsource = dotenv\\n\\n[coverage:paths]\\nsource =\\n\\tsrc/dotenv\\n\\t.tox/*/lib/python*/site-packages/dotenv\\n\\t.tox/pypy*/site-packages/dotenv\\n\\n[coverage:report]\\nshow_missing = True\\ninclude = */site-packages/dotenv/*\\nexclude_lines =\\n\\tif IS_TYPE_CHECKING:\\n\\tpragma: no cover\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of docs/license.md]\",\n \"filename\": \"docs/license.md\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# ::: dotenv\\n\\n\\n[end of docs/reference.md]\",\n \"filename\": \"docs/reference.md\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of docs/changelog.md]\",\n \"filename\": \"docs/changelog.md\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of docs/index.md]\",\n \"filename\": \"docs/index.md\",\n \"id\": \"16\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of docs/contributing.md]\",\n \"filename\": \"docs/contributing.md\",\n \"id\": \"17\"\n },\n {\n \"content\": \"__version__ = \\\"1.0.1\\\"\\n\\n[end of src/dotenv/version.py]\",\n \"filename\": \"src/dotenv/version.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"import re\\nfrom abc import ABCMeta, abstractmethod\\nfrom typing import Iterator, Mapping, Optional, Pattern\\n\\n_posix_variable: Pattern[str] = re.compile(\\n r\\\"\\\"\\\"\\n \\\\$\\\\{\\n (?P<name>[^\\\\}:]*)\\n (?::-\\n (?P<default>[^\\\\}]*)\\n )?\\n \\\\}\\n \\\"\\\"\\\",\\n re.VERBOSE,\\n)\\n\\n\\nclass Atom(metaclass=ABCMeta):\\n def __ne__(self, other: object) -> bool:\\n result = self.__eq__(other)\\n if result is NotImplemented:\\n return NotImplemented\\n return not result\\n\\n @abstractmethod\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\\n\\n\\nclass Literal(Atom):\\n def __init__(self, value: str) -> None:\\n self.value = value\\n\\n def __repr__(self) -> str:\\n return f\\\"Literal(value={self.value})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return self.value == other.value\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.value))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n return self.value\\n\\n\\nclass Variable(Atom):\\n def __init__(self, name: str, default: Optional[str]) -> None:\\n self.name = name\\n self.default = default\\n\\n def __repr__(self) -> str:\\n return f\\\"Variable(name={self.name}, default={self.default})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return (self.name, self.default) == (other.name, other.default)\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.name, self.default))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n default = self.default if self.default is not None else \\\"\\\"\\n result = env.get(self.name, default)\\n return result if result is not None else \\\"\\\"\\n\\n\\ndef parse_variables(value: str) -> Iterator[Atom]:\\n cursor = 0\\n\\n for match in _posix_variable.finditer(value):\\n (start, end) = match.span()\\n name = match[\\\"name\\\"]\\n default = match[\\\"default\\\"]\\n\\n if start > cursor:\\n yield Literal(value=value[cursor:start])\\n\\n yield Variable(name=name, default=default)\\n cursor = end\\n\\n length = len(value)\\n if cursor < length:\\n yield Literal(value=value[cursor:length])\\n\\n[end of src/dotenv/variables.py]\",\n \"filename\": \"src/dotenv/variables.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from typing import Any, Optional\\n\\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\\n unset_key)\\n\\n\\ndef load_ipython_extension(ipython: Any) -> None:\\n from .ipython import load_ipython_extension\\n load_ipython_extension(ipython)\\n\\n\\ndef get_cli_string(\\n path: Optional[str] = None,\\n action: Optional[str] = None,\\n key: Optional[str] = None,\\n value: Optional[str] = None,\\n quote: Optional[str] = None,\\n):\\n \\\"\\\"\\\"Returns a string suitable for running as a shell script.\\n\\n Useful for converting a arguments passed to a fabric task\\n to be passed to a `local` or `run` command.\\n \\\"\\\"\\\"\\n command = ['dotenv']\\n if quote:\\n command.append(f'-q {quote}')\\n if path:\\n command.append(f'-f {path}')\\n if action:\\n command.append(action)\\n if key:\\n command.append(key)\\n if value:\\n if ' ' in value:\\n command.append(f'\\\"{value}\\\"')\\n else:\\n command.append(value)\\n\\n return ' '.join(command).strip()\\n\\n\\n__all__ = ['get_cli_string',\\n 'load_dotenv',\\n 'dotenv_values',\\n 'get_key',\\n 'set_key',\\n 'unset_key',\\n 'find_dotenv',\\n 'load_ipython_extension']\\n\\n[end of src/dotenv/__init__.py]\",\n \"filename\": \"src/dotenv/__init__.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"import codecs\\nimport re\\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\\n Pattern, Sequence, Tuple)\\n\\n\\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\\n return re.compile(string, re.UNICODE | extra_flags)\\n\\n\\n_newline = make_regex(r\\\"(\\\\r\\\\n|\\\\n|\\\\r)\\\")\\n_multiline_whitespace = make_regex(r\\\"\\\\s*\\\", extra_flags=re.MULTILINE)\\n_whitespace = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*\\\")\\n_export = make_regex(r\\\"(?:export[^\\\\S\\\\r\\\\n]+)?\\\")\\n_single_quoted_key = make_regex(r\\\"'([^']+)'\\\")\\n_unquoted_key = make_regex(r\\\"([^=\\\\#\\\\s]+)\\\")\\n_equal_sign = make_regex(r\\\"(=[^\\\\S\\\\r\\\\n]*)\\\")\\n_single_quoted_value = make_regex(r\\\"'((?:\\\\\\\\'|[^'])*)'\\\")\\n_double_quoted_value = make_regex(r'\\\"((?:\\\\\\\\\\\"|[^\\\"])*)\\\"')\\n_unquoted_value = make_regex(r\\\"([^\\\\r\\\\n]*)\\\")\\n_comment = make_regex(r\\\"(?:[^\\\\S\\\\r\\\\n]*#[^\\\\r\\\\n]*)?\\\")\\n_end_of_line = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*(?:\\\\r\\\\n|\\\\n|\\\\r|$)\\\")\\n_rest_of_line = make_regex(r\\\"[^\\\\r\\\\n]*(?:\\\\r|\\\\n|\\\\r\\\\n)?\\\")\\n_double_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\'\\\\\\\"abfnrtv]\\\")\\n_single_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\']\\\")\\n\\n\\nclass Original(NamedTuple):\\n string: str\\n line: int\\n\\n\\nclass Binding(NamedTuple):\\n key: Optional[str]\\n value: Optional[str]\\n original: Original\\n error: bool\\n\\n\\nclass Position:\\n def __init__(self, chars: int, line: int) -> None:\\n self.chars = chars\\n self.line = line\\n\\n @classmethod\\n def start(cls) -> \\\"Position\\\":\\n return cls(chars=0, line=1)\\n\\n def set(self, other: \\\"Position\\\") -> None:\\n self.chars = other.chars\\n self.line = other.line\\n\\n def advance(self, string: str) -> None:\\n self.chars += len(string)\\n self.line += len(re.findall(_newline, string))\\n\\n\\nclass Error(Exception):\\n pass\\n\\n\\nclass Reader:\\n def __init__(self, stream: IO[str]) -> None:\\n self.string = stream.read()\\n self.position = Position.start()\\n self.mark = Position.start()\\n\\n def has_next(self) -> bool:\\n return self.position.chars < len(self.string)\\n\\n def set_mark(self) -> None:\\n self.mark.set(self.position)\\n\\n def get_marked(self) -> Original:\\n return Original(\\n string=self.string[self.mark.chars:self.position.chars],\\n line=self.mark.line,\\n )\\n\\n def peek(self, count: int) -> str:\\n return self.string[self.position.chars:self.position.chars + count]\\n\\n def read(self, count: int) -> str:\\n result = self.string[self.position.chars:self.position.chars + count]\\n if len(result) < count:\\n raise Error(\\\"read: End of string\\\")\\n self.position.advance(result)\\n return result\\n\\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\\n match = regex.match(self.string, self.position.chars)\\n if match is None:\\n raise Error(\\\"read_regex: Pattern not found\\\")\\n self.position.advance(self.string[match.start():match.end()])\\n return match.groups()\\n\\n\\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\\n def decode_match(match: Match[str]) -> str:\\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\\n\\n return regex.sub(decode_match, string)\\n\\n\\ndef parse_key(reader: Reader) -> Optional[str]:\\n char = reader.peek(1)\\n if char == \\\"#\\\":\\n return None\\n elif char == \\\"'\\\":\\n (key,) = reader.read_regex(_single_quoted_key)\\n else:\\n (key,) = reader.read_regex(_unquoted_key)\\n return key\\n\\n\\ndef parse_unquoted_value(reader: Reader) -> str:\\n (part,) = reader.read_regex(_unquoted_value)\\n return re.sub(r\\\"\\\\s+#.*\\\", \\\"\\\", part).rstrip()\\n\\n\\ndef parse_value(reader: Reader) -> str:\\n char = reader.peek(1)\\n if char == u\\\"'\\\":\\n (value,) = reader.read_regex(_single_quoted_value)\\n return decode_escapes(_single_quote_escapes, value)\\n elif char == u'\\\"':\\n (value,) = reader.read_regex(_double_quoted_value)\\n return decode_escapes(_double_quote_escapes, value)\\n elif char in (u\\\"\\\", u\\\"\\\\n\\\", u\\\"\\\\r\\\"):\\n return u\\\"\\\"\\n else:\\n return parse_unquoted_value(reader)\\n\\n\\ndef parse_binding(reader: Reader) -> Binding:\\n reader.set_mark()\\n try:\\n reader.read_regex(_multiline_whitespace)\\n if not reader.has_next():\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=False,\\n )\\n reader.read_regex(_export)\\n key = parse_key(reader)\\n reader.read_regex(_whitespace)\\n if reader.peek(1) == \\\"=\\\":\\n reader.read_regex(_equal_sign)\\n value: Optional[str] = parse_value(reader)\\n else:\\n value = None\\n reader.read_regex(_comment)\\n reader.read_regex(_end_of_line)\\n return Binding(\\n key=key,\\n value=value,\\n original=reader.get_marked(),\\n error=False,\\n )\\n except Error:\\n reader.read_regex(_rest_of_line)\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=True,\\n )\\n\\n\\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\\n reader = Reader(stream)\\n while reader.has_next():\\n yield parse_binding(reader)\\n\\n[end of src/dotenv/parser.py]\",\n \"filename\": \"src/dotenv/parser.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \"import json\\nimport os\\nimport shlex\\nimport sys\\nfrom contextlib import contextmanager\\nfrom typing import Any, Dict, IO, Iterator, List, Optional\\n\\ntry:\\n import click\\nexcept ImportError:\\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\\\n'\\n 'Run pip install \\\"python-dotenv[cli]\\\" to fix this.')\\n sys.exit(1)\\n\\nfrom .main import dotenv_values, set_key, unset_key\\nfrom .version import __version__\\n\\n\\ndef enumerate_env() -> Optional[str]:\\n \\\"\\\"\\\"\\n Return a path for the ${pwd}/.env file.\\n\\n If pwd does not exist, return None.\\n \\\"\\\"\\\"\\n try:\\n cwd = os.getcwd()\\n except FileNotFoundError:\\n return None\\n path = os.path.join(cwd, '.env')\\n return path\\n\\n\\n@click.group()\\n@click.option('-f', '--file', default=enumerate_env(),\\n type=click.Path(file_okay=True),\\n help=\\\"Location of the .env file, defaults to .env file in current working directory.\\\")\\n@click.option('-q', '--quote', default='always',\\n type=click.Choice(['always', 'never', 'auto']),\\n help=\\\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\\\")\\n@click.option('-e', '--export', default=False,\\n type=click.BOOL,\\n help=\\\"Whether to write the dot file as an executable bash script.\\\")\\n@click.version_option(version=__version__)\\n@click.pass_context\\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\\n \\\"\\\"\\\"This script is used to set, get or unset values from a .env file.\\\"\\\"\\\"\\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\\n\\n\\n@contextmanager\\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\\n \\\"\\\"\\\"\\n Open a file and yield the corresponding (decoded) stream.\\n\\n Exits with error code 2 if the file cannot be opened.\\n \\\"\\\"\\\"\\n\\n try:\\n with open(path) as stream:\\n yield stream\\n except OSError as exc:\\n print(f\\\"Error opening env file: {exc}\\\", file=sys.stderr)\\n exit(2)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.option('--format', default='simple',\\n type=click.Choice(['simple', 'json', 'shell', 'export']),\\n help=\\\"The format in which to display the list. Default format is simple, \\\"\\n \\\"which displays name=value without quotes.\\\")\\ndef list(ctx: click.Context, format: bool) -> None:\\n \\\"\\\"\\\"Display all the stored key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n if format == 'json':\\n click.echo(json.dumps(values, indent=2, sort_keys=True))\\n else:\\n prefix = 'export ' if format == 'export' else ''\\n for k in sorted(values):\\n v = values[k]\\n if v is not None:\\n if format in ('export', 'shell'):\\n v = shlex.quote(v)\\n click.echo(f'{prefix}{k}={v}')\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\n@click.argument('value', required=True)\\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\\n \\\"\\\"\\\"Store the given key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n export = ctx.obj['EXPORT']\\n success, key, value = set_key(file, key, value, quote, export)\\n if success:\\n click.echo(f'{key}={value}')\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef get(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Retrieve the value for the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n stored_value = values.get(key)\\n if stored_value:\\n click.echo(stored_value)\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef unset(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Removes the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n success, key = unset_key(file, key, quote)\\n if success:\\n click.echo(f\\\"Successfully removed {key}\\\")\\n else:\\n exit(1)\\n\\n\\n@cli.command(context_settings={'ignore_unknown_options': True})\\n@click.pass_context\\n@click.option(\\n \\\"--override/--no-override\\\",\\n default=True,\\n help=\\\"Override variables from the environment file with those from the .env file.\\\",\\n)\\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\\n \\\"\\\"\\\"Run command with environment variables present.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n if not os.path.isfile(file):\\n raise click.BadParameter(\\n f'Invalid value for \\\\'-f\\\\' \\\"{file}\\\" does not exist.',\\n ctx=ctx\\n )\\n dotenv_as_dict = {\\n k: v\\n for (k, v) in dotenv_values(file).items()\\n if v is not None and (override or k not in os.environ)\\n }\\n\\n if not commandline:\\n click.echo('No command given.')\\n exit(1)\\n run_command(commandline, dotenv_as_dict)\\n\\n\\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\\n \\\"\\\"\\\"Replace the current process with the specified command.\\n\\n Replaces the current process with the specified command and the variables from `env`\\n added in the current environment variables.\\n\\n Parameters\\n ----------\\n command: List[str]\\n The command and it's parameters\\n env: Dict\\n The additional environment variables\\n\\n Returns\\n -------\\n None\\n This function does not return any value. It replaces the current process with the new one.\\n\\n \\\"\\\"\\\"\\n # copy the current environment variables and add the vales from\\n # `env`\\n cmd_env = os.environ.copy()\\n cmd_env.update(env)\\n\\n os.execvpe(command[0], args=command, env=cmd_env)\\n\\n[end of src/dotenv/cli.py]\",\n \"filename\": \"src/dotenv/cli.py\",\n \"id\": \"22\"\n },\n {\n \"content\": \"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\\n parse_argstring) # type: ignore\\n\\nfrom .main import find_dotenv, load_dotenv\\n\\n\\n@magics_class\\nclass IPythonDotEnv(Magics):\\n\\n @magic_arguments()\\n @argument(\\n '-o', '--override', action='store_true',\\n help=\\\"Indicate to override existing variables\\\"\\n )\\n @argument(\\n '-v', '--verbose', action='store_true',\\n help=\\\"Indicate function calls to be verbose\\\"\\n )\\n @argument('dotenv_path', nargs='?', type=str, default='.env',\\n help='Search in increasingly higher folders for the `dotenv_path`')\\n @line_magic\\n def dotenv(self, line):\\n args = parse_argstring(self.dotenv, line)\\n # Locate the .env file\\n dotenv_path = args.dotenv_path\\n try:\\n dotenv_path = find_dotenv(dotenv_path, True, True)\\n except IOError:\\n print(\\\"cannot find .env file\\\")\\n return\\n\\n # Load the .env file\\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\\n\\n\\ndef load_ipython_extension(ipython):\\n \\\"\\\"\\\"Register the %dotenv magic.\\\"\\\"\\\"\\n ipython.register_magics(IPythonDotEnv)\\n\\n[end of src/dotenv/ipython.py]\",\n \"filename\": \"src/dotenv/ipython.py\",\n \"id\": \"23\"\n },\n {\n \"content\": \"# Marker file for PEP 561\\n\\n[end of src/dotenv/py.typed]\",\n \"filename\": \"src/dotenv/py.typed\",\n \"id\": \"24\"\n },\n {\n \"content\": \"import io\\nimport logging\\nimport os\\nimport pathlib\\nimport shutil\\nimport sys\\nimport tempfile\\nfrom collections import OrderedDict\\nfrom contextlib import contextmanager\\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\\n\\nfrom .parser import Binding, parse_stream\\nfrom .variables import parse_variables\\n\\n# A type alias for a string path to be used for the paths in this file.\\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\\n# only accepts string paths, not byte paths or file descriptors. See\\n# https://github.com/python/typeshed/pull/6832.\\nStrPath = Union[str, \\\"os.PathLike[str]\\\"]\\n\\nlogger = logging.getLogger(__name__)\\n\\n\\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\\n for mapping in mappings:\\n if mapping.error:\\n logger.warning(\\n \\\"python-dotenv could not parse statement starting at line %s\\\",\\n mapping.original.line,\\n )\\n yield mapping\\n\\n\\nclass DotEnv:\\n def __init__(\\n self,\\n dotenv_path: Optional[StrPath],\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n encoding: Optional[str] = None,\\n interpolate: bool = True,\\n override: bool = True,\\n ) -> None:\\n self.dotenv_path: Optional[StrPath] = dotenv_path\\n self.stream: Optional[IO[str]] = stream\\n self._dict: Optional[Dict[str, Optional[str]]] = None\\n self.verbose: bool = verbose\\n self.encoding: Optional[str] = encoding\\n self.interpolate: bool = interpolate\\n self.override: bool = override\\n\\n @contextmanager\\n def _get_stream(self) -> Iterator[IO[str]]:\\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\\n with open(self.dotenv_path, encoding=self.encoding) as stream:\\n yield stream\\n elif self.stream is not None:\\n yield self.stream\\n else:\\n if self.verbose:\\n logger.info(\\n \\\"python-dotenv could not find configuration file %s.\\\",\\n self.dotenv_path or \\\".env\\\",\\n )\\n yield io.StringIO(\\\"\\\")\\n\\n def dict(self) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"Return dotenv as dict\\\"\\\"\\\"\\n if self._dict:\\n return self._dict\\n\\n raw_values = self.parse()\\n\\n if self.interpolate:\\n self._dict = OrderedDict(\\n resolve_variables(raw_values, override=self.override)\\n )\\n else:\\n self._dict = OrderedDict(raw_values)\\n\\n return self._dict\\n\\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\\n with self._get_stream() as stream:\\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\\n if mapping.key is not None:\\n yield mapping.key, mapping.value\\n\\n def set_as_environment_variables(self) -> bool:\\n \\\"\\\"\\\"\\n Load the current dotenv as system environment variable.\\n \\\"\\\"\\\"\\n if not self.dict():\\n return False\\n\\n for k, v in self.dict().items():\\n if k in os.environ and not self.override:\\n continue\\n if v is not None:\\n os.environ[k] = v\\n\\n return True\\n\\n def get(self, key: str) -> Optional[str]:\\n \\\"\\\"\\\" \\\"\\\"\\\"\\n data = self.dict()\\n\\n if key in data:\\n return data[key]\\n\\n if self.verbose:\\n logger.warning(\\\"Key %s not found in %s.\\\", key, self.dotenv_path)\\n\\n return None\\n\\n\\ndef get_key(\\n dotenv_path: StrPath,\\n key_to_get: str,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Optional[str]:\\n \\\"\\\"\\\"\\n Get the value of a given key from the given .env.\\n\\n Returns `None` if the key isn't found or doesn't have a value.\\n \\\"\\\"\\\"\\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\\n\\n\\n@contextmanager\\ndef rewrite(\\n path: StrPath,\\n encoding: Optional[str],\\n) -> Iterator[Tuple[IO[str], IO[str]]]:\\n pathlib.Path(path).touch()\\n\\n with tempfile.NamedTemporaryFile(mode=\\\"w\\\", encoding=encoding, delete=False) as dest:\\n error = None\\n try:\\n with open(path, encoding=encoding) as source:\\n yield (source, dest)\\n except BaseException as err:\\n error = err\\n\\n if error is None:\\n shutil.move(dest.name, path)\\n else:\\n os.unlink(dest.name)\\n raise error from None\\n\\n\\ndef set_key(\\n dotenv_path: StrPath,\\n key_to_set: str,\\n value_to_set: str,\\n quote_mode: str = \\\"always\\\",\\n export: bool = False,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str, str]:\\n \\\"\\\"\\\"\\n Adds or Updates a key/value to the given .env\\n\\n If the .env path given doesn't exist, fails instead of risking creating\\n an orphan .env somewhere in the filesystem\\n \\\"\\\"\\\"\\n if quote_mode not in (\\\"always\\\", \\\"auto\\\", \\\"never\\\"):\\n raise ValueError(f\\\"Unknown quote_mode: {quote_mode}\\\")\\n\\n quote = quote_mode == \\\"always\\\" or (\\n quote_mode == \\\"auto\\\" and not value_to_set.isalnum()\\n )\\n\\n if quote:\\n value_out = \\\"'{}'\\\".format(value_to_set.replace(\\\"'\\\", \\\"\\\\\\\\'\\\"))\\n else:\\n value_out = value_to_set\\n if export:\\n line_out = f\\\"export {key_to_set}={value_out}\\\\n\\\"\\n else:\\n line_out = f\\\"{key_to_set}={value_out}\\\\n\\\"\\n\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n replaced = False\\n missing_newline = False\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_set:\\n dest.write(line_out)\\n replaced = True\\n else:\\n dest.write(mapping.original.string)\\n missing_newline = not mapping.original.string.endswith(\\\"\\\\n\\\")\\n if not replaced:\\n if missing_newline:\\n dest.write(\\\"\\\\n\\\")\\n dest.write(line_out)\\n\\n return True, key_to_set, value_to_set\\n\\n\\ndef unset_key(\\n dotenv_path: StrPath,\\n key_to_unset: str,\\n quote_mode: str = \\\"always\\\",\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str]:\\n \\\"\\\"\\\"\\n Removes a given key from the given `.env` file.\\n\\n If the .env path given doesn't exist, fails.\\n If the given key doesn't exist in the .env, fails.\\n \\\"\\\"\\\"\\n if not os.path.exists(dotenv_path):\\n logger.warning(\\\"Can't delete from %s - it doesn't exist.\\\", dotenv_path)\\n return None, key_to_unset\\n\\n removed = False\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_unset:\\n removed = True\\n else:\\n dest.write(mapping.original.string)\\n\\n if not removed:\\n logger.warning(\\n \\\"Key %s not removed from %s - key doesn't exist.\\\", key_to_unset, dotenv_path\\n )\\n return None, key_to_unset\\n\\n return removed, key_to_unset\\n\\n\\ndef resolve_variables(\\n values: Iterable[Tuple[str, Optional[str]]],\\n override: bool,\\n) -> Mapping[str, Optional[str]]:\\n new_values: Dict[str, Optional[str]] = {}\\n\\n for name, value in values:\\n if value is None:\\n result = None\\n else:\\n atoms = parse_variables(value)\\n env: Dict[str, Optional[str]] = {}\\n if override:\\n env.update(os.environ) # type: ignore\\n env.update(new_values)\\n else:\\n env.update(new_values)\\n env.update(os.environ) # type: ignore\\n result = \\\"\\\".join(atom.resolve(env) for atom in atoms)\\n\\n new_values[name] = result\\n\\n return new_values\\n\\n\\ndef _walk_to_root(path: str) -> Iterator[str]:\\n \\\"\\\"\\\"\\n Yield directories starting from the given directory up to the root\\n \\\"\\\"\\\"\\n if not os.path.exists(path):\\n raise IOError(\\\"Starting path not found\\\")\\n\\n if os.path.isfile(path):\\n path = os.path.dirname(path)\\n\\n last_dir = None\\n current_dir = os.path.abspath(path)\\n while last_dir != current_dir:\\n yield current_dir\\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\\n last_dir, current_dir = current_dir, parent_dir\\n\\n\\ndef find_dotenv(\\n filename: str = \\\".env\\\",\\n raise_error_if_not_found: bool = False,\\n usecwd: bool = False,\\n) -> str:\\n \\\"\\\"\\\"\\n Search in increasingly higher folders for the given file\\n\\n Returns path to the file if found, or an empty string otherwise\\n \\\"\\\"\\\"\\n\\n def _is_interactive():\\n \\\"\\\"\\\"Decide whether this is running in a REPL or IPython notebook\\\"\\\"\\\"\\n try:\\n main = __import__(\\\"__main__\\\", None, None, fromlist=[\\\"__file__\\\"])\\n except ModuleNotFoundError:\\n return False\\n return not hasattr(main, \\\"__file__\\\")\\n\\n if usecwd or _is_interactive() or getattr(sys, \\\"frozen\\\", False):\\n # Should work without __file__, e.g. in REPL or IPython notebook.\\n path = os.getcwd()\\n else:\\n # will work for .py files\\n frame = sys._getframe()\\n current_file = __file__\\n\\n while frame.f_code.co_filename == current_file or not os.path.exists(\\n frame.f_code.co_filename\\n ):\\n assert frame.f_back is not None\\n frame = frame.f_back\\n frame_filename = frame.f_code.co_filename\\n path = os.path.dirname(os.path.abspath(frame_filename))\\n\\n for dirname in _walk_to_root(path):\\n check_path = os.path.join(dirname, filename)\\n if os.path.isfile(check_path):\\n return check_path\\n\\n if raise_error_if_not_found:\\n raise IOError(\\\"File not found\\\")\\n\\n return \\\"\\\"\\n\\n\\ndef load_dotenv(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n override: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> bool:\\n \\\"\\\"\\\"Parse a .env file and then load all the variables found as environment variables.\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to .env file.\\n stream: Text stream (such as `io.StringIO`) with .env content, used if\\n `dotenv_path` is `None`.\\n verbose: Whether to output a warning the .env file is missing.\\n override: Whether to override the system environment variables with the variables\\n from the `.env` file.\\n encoding: Encoding to be used to read the file.\\n Returns:\\n Bool: True if at least one environment variable is set else False\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file with it's default parameters. If you need to change the default parameters\\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\\n to this function as `dotenv_path`.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n dotenv = DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=override,\\n encoding=encoding,\\n )\\n return dotenv.set_as_environment_variables()\\n\\n\\ndef dotenv_values(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"\\n Parse a .env file and return its content as a dict.\\n\\n The returned dict will have `None` values for keys without values in the .env file.\\n For example, `foo=bar` results in `{\\\"foo\\\": \\\"bar\\\"}` whereas `foo` alone results in\\n `{\\\"foo\\\": None}`\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to the .env file.\\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\\n verbose: Whether to output a warning if the .env file is missing.\\n encoding: Encoding to be used to read the file.\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n return DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=True,\\n encoding=encoding,\\n ).dict()\\n\\n[end of src/dotenv/main.py]\",\n \"filename\": \"src/dotenv/main.py\",\n \"id\": \"25\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Entry point for cli, enables execution with `python -m dotenv`\\\"\\\"\\\"\\n\\nfrom .cli import cli\\n\\nif __name__ == \\\"__main__\\\":\\n cli()\\n\\n[end of src/dotenv/__main__.py]\",\n \"filename\": \"src/dotenv/__main__.py\",\n \"id\": \"26\"\n }\n]","isConversational":false}}},{"rowIdx":63,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 63,\n \"num_files\": 27,\n \"repo_id\": \"repo_0063\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n handlers:\n python:\n rendering:\n show_root_heading: yes\n show_submodules: no\n separate_signature: yes\n - search\nnav:\n - Home: index.md\n - Changelog: changelog.md\n - Contributing: contributing.md\n - Reference: reference.md\n - License: license.md\n\n[end of mkdocs.yml]","filename":"mkdocs.yml","id":"0"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"black~=22.3.0\nbumpversion\nclick\nflake8>=2.2.3\nipython\npytest-cov\npytest>=3.9\nsh>=2\ntox\ntwine\nwheel\n\n[end of requirements.txt]","filename":"requirements.txt","id":"2"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"3"},{"content":".PHONY: clean-pyc clean-build test\n\nclean: clean-build clean-pyc\n\nclean-build:\n\trm -fr build/\n\trm -fr dist/\n\trm -fr src/*.egg-info\n\nclean-pyc:\n\tfind . -name '*.pyc' -exec rm -f {} +\n\tfind . -name '*.pyo' -exec rm -f {} +\n\tfind . -name '*~' -exec rm -f {} +\n\nrelease: sdist\n\ttwine check dist/*\n\ttwine upload dist/*\n\nrelease-test: sdist\n\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\n\nsdist: clean\n\tpython setup.py sdist bdist_wheel\n\tls -l dist\n\ntest:\n\tpip install -e .\n\tflake8 .\n\tpy.test tests/\n\ncoverage:\n\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\n\tcoverage report\n\ncoverage-html: coverage\n\tcoverage html\n\n[end of Makefile]","filename":"Makefile","id":"4"},{"content":"mdx_truly_sane_lists~=1.2\nmkdocs-include-markdown-plugin~=3.3.0\nmkdocs-material~=8.2.9\nmkdocstrings[python]~=0.18.1\nmkdocs~=1.3.0\n\n[end of requirements-docs.txt]","filename":"requirements-docs.txt","id":"5"},{"content":"include LICENSE *.md *.yml *.toml\n\ninclude tox.ini\nrecursive-include docs *.md\nrecursive-include tests *.py\n\ninclude .bumpversion.cfg\ninclude .coveragerc\ninclude .editorconfig\ninclude Makefile\ninclude requirements.txt\ninclude requirements-docs.txt\ninclude src/dotenv/py.typed\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"6"},{"content":"# see: http://editorconfig.org\n\nroot = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.{py,rst,ini}]\nindent_style = space\nindent_size = 4\n\n[*.yml]\nindent_style = space\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"7"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of README.md]","filename":"README.md","id":"8"},{"content":"from setuptools import setup\n\n\ndef read_files(files):\n data = []\n for file in files:\n with open(file, encoding=\"utf-8\") as f:\n data.append(f.read())\n return \"\\n\".join(data)\n\n\nlong_description = read_files([\"README.md\", \"CHANGELOG.md\"])\n\nmeta = {}\nwith open(\"./src/dotenv/version.py\", encoding=\"utf-8\") as f:\n exec(f.read(), meta)\n\nsetup(\n name=\"python-dotenv\",\n description=\"Read key-value pairs from a .env file and set them as environment variables\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n version=meta[\"__version__\"],\n author=\"Saurabh Kumar\",\n author_email=\"me+github@saurabh-kumar.com\",\n url=\"https://github.com/theskumar/python-dotenv\",\n keywords=[\n \"environment variables\",\n \"deployments\",\n \"settings\",\n \"env\",\n \"dotenv\",\n \"configurations\",\n \"python\",\n ],\n packages=[\"dotenv\"],\n package_dir={\"\": \"src\"},\n package_data={\n \"dotenv\": [\"py.typed\"],\n },\n python_requires=\">=3.9\",\n extras_require={\n \"cli\": [\n \"click>=5.0\",\n ],\n },\n entry_points={\n \"console_scripts\": [\n \"dotenv=dotenv.__main__:cli\",\n ],\n },\n license=\"BSD-3-Clause\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Topic :: System :: Systems Administration\",\n \"Topic :: Utilities\",\n \"Environment :: Web Environment\",\n ],\n)\n\n[end of setup.py]","filename":"setup.py","id":"9"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of CONTRIBUTING.md]","filename":"CONTRIBUTING.md","id":"10"},{"content":"[tox]\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\n\n[gh-actions]\npython =\n 3.9: py39\n 3.10: py310\n 3.11: py311\n 3.12: py312\n 3.13: py313, lint, manifest\n pypy-3.9: pypy3\n\n[testenv]\ndeps =\n pytest\n pytest-cov\n sh >= 2.0.2, <3\n click\n py{39,310,311,312,313,pypy3}: ipython\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\ndepends =\n py{39,310,311,312,313},pypy3: coverage-clean\n coverage-report: py{39,310,311,312,313},pypy3\n\n[testenv:lint]\nskip_install = true\ndeps =\n flake8\n mypy\ncommands =\n flake8 src tests\n mypy --python-version=3.13 src tests\n mypy --python-version=3.12 src tests\n mypy --python-version=3.11 src tests\n mypy --python-version=3.10 src tests\n mypy --python-version=3.9 src tests\n\n[testenv:manifest]\ndeps = check-manifest\nskip_install = true\ncommands = check-manifest\n\n[testenv:coverage-clean]\ndeps = coverage\nskip_install = true\ncommands = coverage erase\n\n[testenv:coverage-report]\ndeps = coverage\nskip_install = true\ncommands =\n coverage report\n\n[end of tox.ini]","filename":"tox.ini","id":"11"},{"content":"[bumpversion]\ncurrent_version = 1.0.1\ncommit = True\ntag = True\n\n[bumpversion:file:src/dotenv/version.py]\n\n[flake8]\nmax-line-length = 120\nexclude = .tox,.git,docs,venv,.venv,build\n\n[mypy]\ncheck_untyped_defs = true\nignore_missing_imports = true\n\n[metadata]\ndescription_file = README.md\n\n[tool:pytest]\ntestpaths = tests\n\n[coverage:run]\nrelative_files = True\nsource = dotenv\n\n[coverage:paths]\nsource =\n\tsrc/dotenv\n\t.tox/*/lib/python*/site-packages/dotenv\n\t.tox/pypy*/site-packages/dotenv\n\n[coverage:report]\nshow_missing = True\ninclude = */site-packages/dotenv/*\nexclude_lines =\n\tif IS_TYPE_CHECKING:\n\tpragma: no cover\n\n[end of setup.cfg]","filename":"setup.cfg","id":"12"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of docs/license.md]","filename":"docs/license.md","id":"13"},{"content":"# ::: dotenv\n\n\n[end of docs/reference.md]","filename":"docs/reference.md","id":"14"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of docs/changelog.md]","filename":"docs/changelog.md","id":"15"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of docs/index.md]","filename":"docs/index.md","id":"16"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of docs/contributing.md]","filename":"docs/contributing.md","id":"17"},{"content":"__version__ = \"1.0.1\"\n\n[end of src/dotenv/version.py]","filename":"src/dotenv/version.py","id":"18"},{"content":"import re\nfrom abc import ABCMeta, abstractmethod\nfrom typing import Iterator, Mapping, Optional, Pattern\n\n_posix_variable: Pattern[str] = re.compile(\n r\"\"\"\n \\$\\{\n (?P<name>[^\\}:]*)\n (?::-\n (?P<default>[^\\}]*)\n )?\n \\}\n \"\"\",\n re.VERBOSE,\n)\n\n\nclass Atom(metaclass=ABCMeta):\n def __ne__(self, other: object) -> bool:\n result = self.__eq__(other)\n if result is NotImplemented:\n return NotImplemented\n return not result\n\n @abstractmethod\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\n\n\nclass Literal(Atom):\n def __init__(self, value: str) -> None:\n self.value = value\n\n def __repr__(self) -> str:\n return f\"Literal(value={self.value})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return self.value == other.value\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.value))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n return self.value\n\n\nclass Variable(Atom):\n def __init__(self, name: str, default: Optional[str]) -> None:\n self.name = name\n self.default = default\n\n def __repr__(self) -> str:\n return f\"Variable(name={self.name}, default={self.default})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return (self.name, self.default) == (other.name, other.default)\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.name, self.default))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n default = self.default if self.default is not None else \"\"\n result = env.get(self.name, default)\n return result if result is not None else \"\"\n\n\ndef parse_variables(value: str) -> Iterator[Atom]:\n cursor = 0\n\n for match in _posix_variable.finditer(value):\n (start, end) = match.span()\n name = match[\"name\"]\n default = match[\"default\"]\n\n if start > cursor:\n yield Literal(value=value[cursor:start])\n\n yield Variable(name=name, default=default)\n cursor = end\n\n length = len(value)\n if cursor < length:\n yield Literal(value=value[cursor:length])\n\n[end of src/dotenv/variables.py]","filename":"src/dotenv/variables.py","id":"19"},{"content":"from typing import Any, Optional\n\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\n unset_key)\n\n\ndef load_ipython_extension(ipython: Any) -> None:\n from .ipython import load_ipython_extension\n load_ipython_extension(ipython)\n\n\ndef get_cli_string(\n path: Optional[str] = None,\n action: Optional[str] = None,\n key: Optional[str] = None,\n value: Optional[str] = None,\n quote: Optional[str] = None,\n):\n \"\"\"Returns a string suitable for running as a shell script.\n\n Useful for converting a arguments passed to a fabric task\n to be passed to a `local` or `run` command.\n \"\"\"\n command = ['dotenv']\n if quote:\n command.append(f'-q {quote}')\n if path:\n command.append(f'-f {path}')\n if action:\n command.append(action)\n if key:\n command.append(key)\n if value:\n if ' ' in value:\n command.append(f'\"{value}\"')\n else:\n command.append(value)\n\n return ' '.join(command).strip()\n\n\n__all__ = ['get_cli_string',\n 'load_dotenv',\n 'dotenv_values',\n 'get_key',\n 'set_key',\n 'unset_key',\n 'find_dotenv',\n 'load_ipython_extension']\n\n[end of src/dotenv/__init__.py]","filename":"src/dotenv/__init__.py","id":"20"},{"content":"import codecs\nimport re\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\n Pattern, Sequence, Tuple)\n\n\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\n return re.compile(string, re.UNICODE | extra_flags)\n\n\n_newline = make_regex(r\"(\\r\\n|\\n|\\r)\")\n_multiline_whitespace = make_regex(r\"\\s*\", extra_flags=re.MULTILINE)\n_whitespace = make_regex(r\"[^\\S\\r\\n]*\")\n_export = make_regex(r\"(?:export[^\\S\\r\\n]+)?\")\n_single_quoted_key = make_regex(r\"'([^']+)'\")\n_unquoted_key = make_regex(r\"([^=\\#\\s]+)\")\n_equal_sign = make_regex(r\"(=[^\\S\\r\\n]*)\")\n_single_quoted_value = make_regex(r\"'((?:\\\\'|[^'])*)'\")\n_double_quoted_value = make_regex(r'\"((?:\\\\\"|[^\"])*)\"')\n_unquoted_value = make_regex(r\"([^\\r\\n]*)\")\n_comment = make_regex(r\"(?:[^\\S\\r\\n]*#[^\\r\\n]*)?\")\n_end_of_line = make_regex(r\"[^\\S\\r\\n]*(?:\\r\\n|\\n|\\r|$)\")\n_rest_of_line = make_regex(r\"[^\\r\\n]*(?:\\r|\\n|\\r\\n)?\")\n_double_quote_escapes = make_regex(r\"\\\\[\\\\'\\\"abfnrtv]\")\n_single_quote_escapes = make_regex(r\"\\\\[\\\\']\")\n\n\nclass Original(NamedTuple):\n string: str\n line: int\n\n\nclass Binding(NamedTuple):\n key: Optional[str]\n value: Optional[str]\n original: Original\n error: bool\n\n\nclass Position:\n def __init__(self, chars: int, line: int) -> None:\n self.chars = chars\n self.line = line\n\n @classmethod\n def start(cls) -> \"Position\":\n return cls(chars=0, line=1)\n\n def set(self, other: \"Position\") -> None:\n self.chars = other.chars\n self.line = other.line\n\n def advance(self, string: str) -> None:\n self.chars += len(string)\n self.line += len(re.findall(_newline, string))\n\n\nclass Error(Exception):\n pass\n\n\nclass Reader:\n def __init__(self, stream: IO[str]) -> None:\n self.string = stream.read()\n self.position = Position.start()\n self.mark = Position.start()\n\n def has_next(self) -> bool:\n return self.position.chars < len(self.string)\n\n def set_mark(self) -> None:\n self.mark.set(self.position)\n\n def get_marked(self) -> Original:\n return Original(\n string=self.string[self.mark.chars:self.position.chars],\n line=self.mark.line,\n )\n\n def peek(self, count: int) -> str:\n return self.string[self.position.chars:self.position.chars + count]\n\n def read(self, count: int) -> str:\n result = self.string[self.position.chars:self.position.chars + count]\n if len(result) < count:\n raise Error(\"read: End of string\")\n self.position.advance(result)\n return result\n\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\n match = regex.match(self.string, self.position.chars)\n if match is None:\n raise Error(\"read_regex: Pattern not found\")\n self.position.advance(self.string[match.start():match.end()])\n return match.groups()\n\n\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\n def decode_match(match: Match[str]) -> str:\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\n\n return regex.sub(decode_match, string)\n\n\ndef parse_key(reader: Reader) -> Optional[str]:\n char = reader.peek(1)\n if char == \"#\":\n return None\n elif char == \"'\":\n (key,) = reader.read_regex(_single_quoted_key)\n else:\n (key,) = reader.read_regex(_unquoted_key)\n return key\n\n\ndef parse_unquoted_value(reader: Reader) -> str:\n (part,) = reader.read_regex(_unquoted_value)\n return re.sub(r\"\\s+#.*\", \"\", part).rstrip()\n\n\ndef parse_value(reader: Reader) -> str:\n char = reader.peek(1)\n if char == u\"'\":\n (value,) = reader.read_regex(_single_quoted_value)\n return decode_escapes(_single_quote_escapes, value)\n elif char == u'\"':\n (value,) = reader.read_regex(_double_quoted_value)\n return decode_escapes(_double_quote_escapes, value)\n elif char in (u\"\", u\"\\n\", u\"\\r\"):\n return u\"\"\n else:\n return parse_unquoted_value(reader)\n\n\ndef parse_binding(reader: Reader) -> Binding:\n reader.set_mark()\n try:\n reader.read_regex(_multiline_whitespace)\n if not reader.has_next():\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=False,\n )\n reader.read_regex(_export)\n key = parse_key(reader)\n reader.read_regex(_whitespace)\n if reader.peek(1) == \"=\":\n reader.read_regex(_equal_sign)\n value: Optional[str] = parse_value(reader)\n else:\n value = None\n reader.read_regex(_comment)\n reader.read_regex(_end_of_line)\n return Binding(\n key=key,\n value=value,\n original=reader.get_marked(),\n error=False,\n )\n except Error:\n reader.read_regex(_rest_of_line)\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=True,\n )\n\n\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\n reader = Reader(stream)\n while reader.has_next():\n yield parse_binding(reader)\n\n[end of src/dotenv/parser.py]","filename":"src/dotenv/parser.py","id":"21"},{"content":"import json\nimport os\nimport shlex\nimport sys\nfrom contextlib import contextmanager\nfrom typing import Any, Dict, IO, Iterator, List, Optional\n\ntry:\n import click\nexcept ImportError:\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\n'\n 'Run pip install \"python-dotenv[cli]\" to fix this.')\n sys.exit(1)\n\nfrom .main import dotenv_values, set_key, unset_key\nfrom .version import __version__\n\n\ndef enumerate_env() -> Optional[str]:\n \"\"\"\n Return a path for the ${pwd}/.env file.\n\n If pwd does not exist, return None.\n \"\"\"\n try:\n cwd = os.getcwd()\n except FileNotFoundError:\n return None\n path = os.path.join(cwd, '.env')\n return path\n\n\n@click.group()\n@click.option('-f', '--file', default=enumerate_env(),\n type=click.Path(file_okay=True),\n help=\"Location of the .env file, defaults to .env file in current working directory.\")\n@click.option('-q', '--quote', default='always',\n type=click.Choice(['always', 'never', 'auto']),\n help=\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\")\n@click.option('-e', '--export', default=False,\n type=click.BOOL,\n help=\"Whether to write the dot file as an executable bash script.\")\n@click.version_option(version=__version__)\n@click.pass_context\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\n \"\"\"This script is used to set, get or unset values from a .env file.\"\"\"\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\n\n\n@contextmanager\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\n \"\"\"\n Open a file and yield the corresponding (decoded) stream.\n\n Exits with error code 2 if the file cannot be opened.\n \"\"\"\n\n try:\n with open(path) as stream:\n yield stream\n except OSError as exc:\n print(f\"Error opening env file: {exc}\", file=sys.stderr)\n exit(2)\n\n\n@cli.command()\n@click.pass_context\n@click.option('--format', default='simple',\n type=click.Choice(['simple', 'json', 'shell', 'export']),\n help=\"The format in which to display the list. Default format is simple, \"\n \"which displays name=value without quotes.\")\ndef list(ctx: click.Context, format: bool) -> None:\n \"\"\"Display all the stored key/value.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n if format == 'json':\n click.echo(json.dumps(values, indent=2, sort_keys=True))\n else:\n prefix = 'export ' if format == 'export' else ''\n for k in sorted(values):\n v = values[k]\n if v is not None:\n if format in ('export', 'shell'):\n v = shlex.quote(v)\n click.echo(f'{prefix}{k}={v}')\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\n@click.argument('value', required=True)\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\n \"\"\"Store the given key/value.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n export = ctx.obj['EXPORT']\n success, key, value = set_key(file, key, value, quote, export)\n if success:\n click.echo(f'{key}={value}')\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef get(ctx: click.Context, key: Any) -> None:\n \"\"\"Retrieve the value for the given key.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n stored_value = values.get(key)\n if stored_value:\n click.echo(stored_value)\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef unset(ctx: click.Context, key: Any) -> None:\n \"\"\"Removes the given key.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n success, key = unset_key(file, key, quote)\n if success:\n click.echo(f\"Successfully removed {key}\")\n else:\n exit(1)\n\n\n@cli.command(context_settings={'ignore_unknown_options': True})\n@click.pass_context\n@click.option(\n \"--override/--no-override\",\n default=True,\n help=\"Override variables from the environment file with those from the .env file.\",\n)\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\n \"\"\"Run command with environment variables present.\"\"\"\n file = ctx.obj['FILE']\n if not os.path.isfile(file):\n raise click.BadParameter(\n f'Invalid value for \\'-f\\' \"{file}\" does not exist.',\n ctx=ctx\n )\n dotenv_as_dict = {\n k: v\n for (k, v) in dotenv_values(file).items()\n if v is not None and (override or k not in os.environ)\n }\n\n if not commandline:\n click.echo('No command given.')\n exit(1)\n run_command(commandline, dotenv_as_dict)\n\n\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\n \"\"\"Replace the current process with the specified command.\n\n Replaces the current process with the specified command and the variables from `env`\n added in the current environment variables.\n\n Parameters\n ----------\n command: List[str]\n The command and it's parameters\n env: Dict\n The additional environment variables\n\n Returns\n -------\n None\n This function does not return any value. It replaces the current process with the new one.\n\n \"\"\"\n # copy the current environment variables and add the vales from\n # `env`\n cmd_env = os.environ.copy()\n cmd_env.update(env)\n\n os.execvpe(command[0], args=command, env=cmd_env)\n\n[end of src/dotenv/cli.py]","filename":"src/dotenv/cli.py","id":"22"},{"content":"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\n parse_argstring) # type: ignore\n\nfrom .main import find_dotenv, load_dotenv\n\n\n@magics_class\nclass IPythonDotEnv(Magics):\n\n @magic_arguments()\n @argument(\n '-o', '--override', action='store_true',\n help=\"Indicate to override existing variables\"\n )\n @argument(\n '-v', '--verbose', action='store_true',\n help=\"Indicate function calls to be verbose\"\n )\n @argument('dotenv_path', nargs='?', type=str, default='.env',\n help='Search in increasingly higher folders for the `dotenv_path`')\n @line_magic\n def dotenv(self, line):\n args = parse_argstring(self.dotenv, line)\n # Locate the .env file\n dotenv_path = args.dotenv_path\n try:\n dotenv_path = find_dotenv(dotenv_path, True, True)\n except IOError:\n print(\"cannot find .env file\")\n return\n\n # Load the .env file\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\n\n\ndef load_ipython_extension(ipython):\n \"\"\"Register the %dotenv magic.\"\"\"\n ipython.register_magics(IPythonDotEnv)\n\n[end of src/dotenv/ipython.py]","filename":"src/dotenv/ipython.py","id":"23"},{"content":"# Marker file for PEP 561\n\n[end of src/dotenv/py.typed]","filename":"src/dotenv/py.typed","id":"24"},{"content":"import io\nimport logging\nimport os\nimport pathlib\nimport shutil\nimport sys\nimport tempfile\nfrom collections import OrderedDict\nfrom contextlib import contextmanager\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\n\nfrom .parser import Binding, parse_stream\nfrom .variables import parse_variables\n\n# A type alias for a string path to be used for the paths in this file.\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\n# only accepts string paths, not byte paths or file descriptors. See\n# https://github.com/python/typeshed/pull/6832.\nStrPath = Union[str, \"os.PathLike[str]\"]\n\nlogger = logging.getLogger(__name__)\n\n\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\n for mapping in mappings:\n if mapping.error:\n logger.warning(\n \"python-dotenv could not parse statement starting at line %s\",\n mapping.original.line,\n )\n yield mapping\n\n\nclass DotEnv:\n def __init__(\n self,\n dotenv_path: Optional[StrPath],\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n encoding: Optional[str] = None,\n interpolate: bool = True,\n override: bool = True,\n ) -> None:\n self.dotenv_path: Optional[StrPath] = dotenv_path\n self.stream: Optional[IO[str]] = stream\n self._dict: Optional[Dict[str, Optional[str]]] = None\n self.verbose: bool = verbose\n self.encoding: Optional[str] = encoding\n self.interpolate: bool = interpolate\n self.override: bool = override\n\n @contextmanager\n def _get_stream(self) -> Iterator[IO[str]]:\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\n with open(self.dotenv_path, encoding=self.encoding) as stream:\n yield stream\n elif self.stream is not None:\n yield self.stream\n else:\n if self.verbose:\n logger.info(\n \"python-dotenv could not find configuration file %s.\",\n self.dotenv_path or \".env\",\n )\n yield io.StringIO(\"\")\n\n def dict(self) -> Dict[str, Optional[str]]:\n \"\"\"Return dotenv as dict\"\"\"\n if self._dict:\n return self._dict\n\n raw_values = self.parse()\n\n if self.interpolate:\n self._dict = OrderedDict(\n resolve_variables(raw_values, override=self.override)\n )\n else:\n self._dict = OrderedDict(raw_values)\n\n return self._dict\n\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\n with self._get_stream() as stream:\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\n if mapping.key is not None:\n yield mapping.key, mapping.value\n\n def set_as_environment_variables(self) -> bool:\n \"\"\"\n Load the current dotenv as system environment variable.\n \"\"\"\n if not self.dict():\n return False\n\n for k, v in self.dict().items():\n if k in os.environ and not self.override:\n continue\n if v is not None:\n os.environ[k] = v\n\n return True\n\n def get(self, key: str) -> Optional[str]:\n \"\"\" \"\"\"\n data = self.dict()\n\n if key in data:\n return data[key]\n\n if self.verbose:\n logger.warning(\"Key %s not found in %s.\", key, self.dotenv_path)\n\n return None\n\n\ndef get_key(\n dotenv_path: StrPath,\n key_to_get: str,\n encoding: Optional[str] = \"utf-8\",\n) -> Optional[str]:\n \"\"\"\n Get the value of a given key from the given .env.\n\n Returns `None` if the key isn't found or doesn't have a value.\n \"\"\"\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\n\n\n@contextmanager\ndef rewrite(\n path: StrPath,\n encoding: Optional[str],\n) -> Iterator[Tuple[IO[str], IO[str]]]:\n pathlib.Path(path).touch()\n\n with tempfile.NamedTemporaryFile(mode=\"w\", encoding=encoding, delete=False) as dest:\n error = None\n try:\n with open(path, encoding=encoding) as source:\n yield (source, dest)\n except BaseException as err:\n error = err\n\n if error is None:\n shutil.move(dest.name, path)\n else:\n os.unlink(dest.name)\n raise error from None\n\n\ndef set_key(\n dotenv_path: StrPath,\n key_to_set: str,\n value_to_set: str,\n quote_mode: str = \"always\",\n export: bool = False,\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str, str]:\n \"\"\"\n Adds or Updates a key/value to the given .env\n\n If the .env path given doesn't exist, fails instead of risking creating\n an orphan .env somewhere in the filesystem\n \"\"\"\n if quote_mode not in (\"always\", \"auto\", \"never\"):\n raise ValueError(f\"Unknown quote_mode: {quote_mode}\")\n\n quote = quote_mode == \"always\" or (\n quote_mode == \"auto\" and not value_to_set.isalnum()\n )\n\n if quote:\n value_out = \"'{}'\".format(value_to_set.replace(\"'\", \"\\\\'\"))\n else:\n value_out = value_to_set\n if export:\n line_out = f\"export {key_to_set}={value_out}\\n\"\n else:\n line_out = f\"{key_to_set}={value_out}\\n\"\n\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n replaced = False\n missing_newline = False\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_set:\n dest.write(line_out)\n replaced = True\n else:\n dest.write(mapping.original.string)\n missing_newline = not mapping.original.string.endswith(\"\\n\")\n if not replaced:\n if missing_newline:\n dest.write(\"\\n\")\n dest.write(line_out)\n\n return True, key_to_set, value_to_set\n\n\ndef unset_key(\n dotenv_path: StrPath,\n key_to_unset: str,\n quote_mode: str = \"always\",\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str]:\n \"\"\"\n Removes a given key from the given `.env` file.\n\n If the .env path given doesn't exist, fails.\n If the given key doesn't exist in the .env, fails.\n \"\"\"\n if not os.path.exists(dotenv_path):\n logger.warning(\"Can't delete from %s - it doesn't exist.\", dotenv_path)\n return None, key_to_unset\n\n removed = False\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_unset:\n removed = True\n else:\n dest.write(mapping.original.string)\n\n if not removed:\n logger.warning(\n \"Key %s not removed from %s - key doesn't exist.\", key_to_unset, dotenv_path\n )\n return None, key_to_unset\n\n return removed, key_to_unset\n\n\ndef resolve_variables(\n values: Iterable[Tuple[str, Optional[str]]],\n override: bool,\n) -> Mapping[str, Optional[str]]:\n new_values: Dict[str, Optional[str]] = {}\n\n for name, value in values:\n if value is None:\n result = None\n else:\n atoms = parse_variables(value)\n env: Dict[str, Optional[str]] = {}\n if override:\n env.update(os.environ) # type: ignore\n env.update(new_values)\n else:\n env.update(new_values)\n env.update(os.environ) # type: ignore\n result = \"\".join(atom.resolve(env) for atom in atoms)\n\n new_values[name] = result\n\n return new_values\n\n\ndef _walk_to_root(path: str) -> Iterator[str]:\n \"\"\"\n Yield directories starting from the given directory up to the root\n \"\"\"\n if not os.path.exists(path):\n raise IOError(\"Starting path not found\")\n\n if os.path.isfile(path):\n path = os.path.dirname(path)\n\n last_dir = None\n current_dir = os.path.abspath(path)\n while last_dir != current_dir:\n yield current_dir\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\n last_dir, current_dir = current_dir, parent_dir\n\n\ndef find_dotenv(\n filename: str = \".env\",\n raise_error_if_not_found: bool = False,\n usecwd: bool = False,\n) -> str:\n \"\"\"\n Search in increasingly higher folders for the given file\n\n Returns path to the file if found, or an empty string otherwise\n \"\"\"\n\n def _is_interactive():\n \"\"\"Decide whether this is running in a REPL or IPython notebook\"\"\"\n try:\n main = __import__(\"__main__\", None, None, fromlist=[\"__file__\"])\n except ModuleNotFoundError:\n return False\n return not hasattr(main, \"__file__\")\n\n if usecwd or _is_interactive() or getattr(sys, \"frozen\", False):\n # Should work without __file__, e.g. in REPL or IPython notebook.\n path = os.getcwd()\n else:\n # will work for .py files\n frame = sys._getframe()\n current_file = __file__\n\n while frame.f_code.co_filename == current_file or not os.path.exists(\n frame.f_code.co_filename\n ):\n assert frame.f_back is not None\n frame = frame.f_back\n frame_filename = frame.f_code.co_filename\n path = os.path.dirname(os.path.abspath(frame_filename))\n\n for dirname in _walk_to_root(path):\n check_path = os.path.join(dirname, filename)\n if os.path.isfile(check_path):\n return check_path\n\n if raise_error_if_not_found:\n raise IOError(\"File not found\")\n\n return \"\"\n\n\ndef load_dotenv(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n override: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> bool:\n \"\"\"Parse a .env file and then load all the variables found as environment variables.\n\n Parameters:\n dotenv_path: Absolute or relative path to .env file.\n stream: Text stream (such as `io.StringIO`) with .env content, used if\n `dotenv_path` is `None`.\n verbose: Whether to output a warning the .env file is missing.\n override: Whether to override the system environment variables with the variables\n from the `.env` file.\n encoding: Encoding to be used to read the file.\n Returns:\n Bool: True if at least one environment variable is set else False\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file with it's default parameters. If you need to change the default parameters\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\n to this function as `dotenv_path`.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n dotenv = DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=override,\n encoding=encoding,\n )\n return dotenv.set_as_environment_variables()\n\n\ndef dotenv_values(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> Dict[str, Optional[str]]:\n \"\"\"\n Parse a .env file and return its content as a dict.\n\n The returned dict will have `None` values for keys without values in the .env file.\n For example, `foo=bar` results in `{\"foo\": \"bar\"}` whereas `foo` alone results in\n `{\"foo\": None}`\n\n Parameters:\n dotenv_path: Absolute or relative path to the .env file.\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\n verbose: Whether to output a warning if the .env file is missing.\n encoding: Encoding to be used to read the file.\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n return DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=True,\n encoding=encoding,\n ).dict()\n\n[end of src/dotenv/main.py]","filename":"src/dotenv/main.py","id":"25"},{"content":"\"\"\"Entry point for cli, enables execution with `python -m dotenv`\"\"\"\n\nfrom .cli import cli\n\nif __name__ == \"__main__\":\n cli()\n\n[end of src/dotenv/__main__.py]","filename":"src/dotenv/__main__.py","id":"26"}],"string":"[\n {\n \"content\": \"site_name: python-dotenv\\nrepo_url: https://github.com/theskumar/python-dotenv\\nedit_uri: \\\"\\\"\\ntheme:\\n name: material\\n palette:\\n primary: green\\n features:\\n - toc.follow\\n - navigation.sections\\n\\nmarkdown_extensions:\\n - mdx_truly_sane_lists\\n\\nplugins:\\n - mkdocstrings:\\n handlers:\\n python:\\n rendering:\\n show_root_heading: yes\\n show_submodules: no\\n separate_signature: yes\\n - search\\nnav:\\n - Home: index.md\\n - Changelog: changelog.md\\n - Contributing: contributing.md\\n - Reference: reference.md\\n - License: license.md\\n\\n[end of mkdocs.yml]\",\n \"filename\": \"mkdocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"black~=22.3.0\\nbumpversion\\nclick\\nflake8>=2.2.3\\nipython\\npytest-cov\\npytest>=3.9\\nsh>=2\\ntox\\ntwine\\nwheel\\n\\n[end of requirements.txt]\",\n \"filename\": \"requirements.txt\",\n \"id\": \"2\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"3\"\n },\n {\n \"content\": \".PHONY: clean-pyc clean-build test\\n\\nclean: clean-build clean-pyc\\n\\nclean-build:\\n\\trm -fr build/\\n\\trm -fr dist/\\n\\trm -fr src/*.egg-info\\n\\nclean-pyc:\\n\\tfind . -name '*.pyc' -exec rm -f {} +\\n\\tfind . -name '*.pyo' -exec rm -f {} +\\n\\tfind . -name '*~' -exec rm -f {} +\\n\\nrelease: sdist\\n\\ttwine check dist/*\\n\\ttwine upload dist/*\\n\\nrelease-test: sdist\\n\\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\\n\\nsdist: clean\\n\\tpython setup.py sdist bdist_wheel\\n\\tls -l dist\\n\\ntest:\\n\\tpip install -e .\\n\\tflake8 .\\n\\tpy.test tests/\\n\\ncoverage:\\n\\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\\n\\tcoverage report\\n\\ncoverage-html: coverage\\n\\tcoverage html\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"4\"\n },\n {\n \"content\": \"mdx_truly_sane_lists~=1.2\\nmkdocs-include-markdown-plugin~=3.3.0\\nmkdocs-material~=8.2.9\\nmkdocstrings[python]~=0.18.1\\nmkdocs~=1.3.0\\n\\n[end of requirements-docs.txt]\",\n \"filename\": \"requirements-docs.txt\",\n \"id\": \"5\"\n },\n {\n \"content\": \"include LICENSE *.md *.yml *.toml\\n\\ninclude tox.ini\\nrecursive-include docs *.md\\nrecursive-include tests *.py\\n\\ninclude .bumpversion.cfg\\ninclude .coveragerc\\ninclude .editorconfig\\ninclude Makefile\\ninclude requirements.txt\\ninclude requirements-docs.txt\\ninclude src/dotenv/py.typed\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# see: http://editorconfig.org\\n\\nroot = true\\n\\n[*]\\ncharset = utf-8\\nend_of_line = lf\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\n\\n[*.{py,rst,ini}]\\nindent_style = space\\nindent_size = 4\\n\\n[*.yml]\\nindent_style = space\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"8\"\n },\n {\n \"content\": \"from setuptools import setup\\n\\n\\ndef read_files(files):\\n data = []\\n for file in files:\\n with open(file, encoding=\\\"utf-8\\\") as f:\\n data.append(f.read())\\n return \\\"\\\\n\\\".join(data)\\n\\n\\nlong_description = read_files([\\\"README.md\\\", \\\"CHANGELOG.md\\\"])\\n\\nmeta = {}\\nwith open(\\\"./src/dotenv/version.py\\\", encoding=\\\"utf-8\\\") as f:\\n exec(f.read(), meta)\\n\\nsetup(\\n name=\\\"python-dotenv\\\",\\n description=\\\"Read key-value pairs from a .env file and set them as environment variables\\\",\\n long_description=long_description,\\n long_description_content_type=\\\"text/markdown\\\",\\n version=meta[\\\"__version__\\\"],\\n author=\\\"Saurabh Kumar\\\",\\n author_email=\\\"me+github@saurabh-kumar.com\\\",\\n url=\\\"https://github.com/theskumar/python-dotenv\\\",\\n keywords=[\\n \\\"environment variables\\\",\\n \\\"deployments\\\",\\n \\\"settings\\\",\\n \\\"env\\\",\\n \\\"dotenv\\\",\\n \\\"configurations\\\",\\n \\\"python\\\",\\n ],\\n packages=[\\\"dotenv\\\"],\\n package_dir={\\\"\\\": \\\"src\\\"},\\n package_data={\\n \\\"dotenv\\\": [\\\"py.typed\\\"],\\n },\\n python_requires=\\\">=3.9\\\",\\n extras_require={\\n \\\"cli\\\": [\\n \\\"click>=5.0\\\",\\n ],\\n },\\n entry_points={\\n \\\"console_scripts\\\": [\\n \\\"dotenv=dotenv.__main__:cli\\\",\\n ],\\n },\\n license=\\\"BSD-3-Clause\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Programming Language :: Python :: 3.10\\\",\\n \\\"Programming Language :: Python :: 3.11\\\",\\n \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Topic :: System :: Systems Administration\\\",\\n \\\"Topic :: Utilities\\\",\\n \\\"Environment :: Web Environment\\\",\\n ],\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of CONTRIBUTING.md]\",\n \"filename\": \"CONTRIBUTING.md\",\n \"id\": \"10\"\n },\n {\n \"content\": \"[tox]\\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\\n\\n[gh-actions]\\npython =\\n 3.9: py39\\n 3.10: py310\\n 3.11: py311\\n 3.12: py312\\n 3.13: py313, lint, manifest\\n pypy-3.9: pypy3\\n\\n[testenv]\\ndeps =\\n pytest\\n pytest-cov\\n sh >= 2.0.2, <3\\n click\\n py{39,310,311,312,313,pypy3}: ipython\\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\\ndepends =\\n py{39,310,311,312,313},pypy3: coverage-clean\\n coverage-report: py{39,310,311,312,313},pypy3\\n\\n[testenv:lint]\\nskip_install = true\\ndeps =\\n flake8\\n mypy\\ncommands =\\n flake8 src tests\\n mypy --python-version=3.13 src tests\\n mypy --python-version=3.12 src tests\\n mypy --python-version=3.11 src tests\\n mypy --python-version=3.10 src tests\\n mypy --python-version=3.9 src tests\\n\\n[testenv:manifest]\\ndeps = check-manifest\\nskip_install = true\\ncommands = check-manifest\\n\\n[testenv:coverage-clean]\\ndeps = coverage\\nskip_install = true\\ncommands = coverage erase\\n\\n[testenv:coverage-report]\\ndeps = coverage\\nskip_install = true\\ncommands =\\n coverage report\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"11\"\n },\n {\n \"content\": \"[bumpversion]\\ncurrent_version = 1.0.1\\ncommit = True\\ntag = True\\n\\n[bumpversion:file:src/dotenv/version.py]\\n\\n[flake8]\\nmax-line-length = 120\\nexclude = .tox,.git,docs,venv,.venv,build\\n\\n[mypy]\\ncheck_untyped_defs = true\\nignore_missing_imports = true\\n\\n[metadata]\\ndescription_file = README.md\\n\\n[tool:pytest]\\ntestpaths = tests\\n\\n[coverage:run]\\nrelative_files = True\\nsource = dotenv\\n\\n[coverage:paths]\\nsource =\\n\\tsrc/dotenv\\n\\t.tox/*/lib/python*/site-packages/dotenv\\n\\t.tox/pypy*/site-packages/dotenv\\n\\n[coverage:report]\\nshow_missing = True\\ninclude = */site-packages/dotenv/*\\nexclude_lines =\\n\\tif IS_TYPE_CHECKING:\\n\\tpragma: no cover\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of docs/license.md]\",\n \"filename\": \"docs/license.md\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# ::: dotenv\\n\\n\\n[end of docs/reference.md]\",\n \"filename\": \"docs/reference.md\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of docs/changelog.md]\",\n \"filename\": \"docs/changelog.md\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of docs/index.md]\",\n \"filename\": \"docs/index.md\",\n \"id\": \"16\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of docs/contributing.md]\",\n \"filename\": \"docs/contributing.md\",\n \"id\": \"17\"\n },\n {\n \"content\": \"__version__ = \\\"1.0.1\\\"\\n\\n[end of src/dotenv/version.py]\",\n \"filename\": \"src/dotenv/version.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"import re\\nfrom abc import ABCMeta, abstractmethod\\nfrom typing import Iterator, Mapping, Optional, Pattern\\n\\n_posix_variable: Pattern[str] = re.compile(\\n r\\\"\\\"\\\"\\n \\\\$\\\\{\\n (?P<name>[^\\\\}:]*)\\n (?::-\\n (?P<default>[^\\\\}]*)\\n )?\\n \\\\}\\n \\\"\\\"\\\",\\n re.VERBOSE,\\n)\\n\\n\\nclass Atom(metaclass=ABCMeta):\\n def __ne__(self, other: object) -> bool:\\n result = self.__eq__(other)\\n if result is NotImplemented:\\n return NotImplemented\\n return not result\\n\\n @abstractmethod\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\\n\\n\\nclass Literal(Atom):\\n def __init__(self, value: str) -> None:\\n self.value = value\\n\\n def __repr__(self) -> str:\\n return f\\\"Literal(value={self.value})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return self.value == other.value\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.value))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n return self.value\\n\\n\\nclass Variable(Atom):\\n def __init__(self, name: str, default: Optional[str]) -> None:\\n self.name = name\\n self.default = default\\n\\n def __repr__(self) -> str:\\n return f\\\"Variable(name={self.name}, default={self.default})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return (self.name, self.default) == (other.name, other.default)\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.name, self.default))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n default = self.default if self.default is not None else \\\"\\\"\\n result = env.get(self.name, default)\\n return result if result is not None else \\\"\\\"\\n\\n\\ndef parse_variables(value: str) -> Iterator[Atom]:\\n cursor = 0\\n\\n for match in _posix_variable.finditer(value):\\n (start, end) = match.span()\\n name = match[\\\"name\\\"]\\n default = match[\\\"default\\\"]\\n\\n if start > cursor:\\n yield Literal(value=value[cursor:start])\\n\\n yield Variable(name=name, default=default)\\n cursor = end\\n\\n length = len(value)\\n if cursor < length:\\n yield Literal(value=value[cursor:length])\\n\\n[end of src/dotenv/variables.py]\",\n \"filename\": \"src/dotenv/variables.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from typing import Any, Optional\\n\\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\\n unset_key)\\n\\n\\ndef load_ipython_extension(ipython: Any) -> None:\\n from .ipython import load_ipython_extension\\n load_ipython_extension(ipython)\\n\\n\\ndef get_cli_string(\\n path: Optional[str] = None,\\n action: Optional[str] = None,\\n key: Optional[str] = None,\\n value: Optional[str] = None,\\n quote: Optional[str] = None,\\n):\\n \\\"\\\"\\\"Returns a string suitable for running as a shell script.\\n\\n Useful for converting a arguments passed to a fabric task\\n to be passed to a `local` or `run` command.\\n \\\"\\\"\\\"\\n command = ['dotenv']\\n if quote:\\n command.append(f'-q {quote}')\\n if path:\\n command.append(f'-f {path}')\\n if action:\\n command.append(action)\\n if key:\\n command.append(key)\\n if value:\\n if ' ' in value:\\n command.append(f'\\\"{value}\\\"')\\n else:\\n command.append(value)\\n\\n return ' '.join(command).strip()\\n\\n\\n__all__ = ['get_cli_string',\\n 'load_dotenv',\\n 'dotenv_values',\\n 'get_key',\\n 'set_key',\\n 'unset_key',\\n 'find_dotenv',\\n 'load_ipython_extension']\\n\\n[end of src/dotenv/__init__.py]\",\n \"filename\": \"src/dotenv/__init__.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"import codecs\\nimport re\\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\\n Pattern, Sequence, Tuple)\\n\\n\\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\\n return re.compile(string, re.UNICODE | extra_flags)\\n\\n\\n_newline = make_regex(r\\\"(\\\\r\\\\n|\\\\n|\\\\r)\\\")\\n_multiline_whitespace = make_regex(r\\\"\\\\s*\\\", extra_flags=re.MULTILINE)\\n_whitespace = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*\\\")\\n_export = make_regex(r\\\"(?:export[^\\\\S\\\\r\\\\n]+)?\\\")\\n_single_quoted_key = make_regex(r\\\"'([^']+)'\\\")\\n_unquoted_key = make_regex(r\\\"([^=\\\\#\\\\s]+)\\\")\\n_equal_sign = make_regex(r\\\"(=[^\\\\S\\\\r\\\\n]*)\\\")\\n_single_quoted_value = make_regex(r\\\"'((?:\\\\\\\\'|[^'])*)'\\\")\\n_double_quoted_value = make_regex(r'\\\"((?:\\\\\\\\\\\"|[^\\\"])*)\\\"')\\n_unquoted_value = make_regex(r\\\"([^\\\\r\\\\n]*)\\\")\\n_comment = make_regex(r\\\"(?:[^\\\\S\\\\r\\\\n]*#[^\\\\r\\\\n]*)?\\\")\\n_end_of_line = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*(?:\\\\r\\\\n|\\\\n|\\\\r|$)\\\")\\n_rest_of_line = make_regex(r\\\"[^\\\\r\\\\n]*(?:\\\\r|\\\\n|\\\\r\\\\n)?\\\")\\n_double_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\'\\\\\\\"abfnrtv]\\\")\\n_single_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\']\\\")\\n\\n\\nclass Original(NamedTuple):\\n string: str\\n line: int\\n\\n\\nclass Binding(NamedTuple):\\n key: Optional[str]\\n value: Optional[str]\\n original: Original\\n error: bool\\n\\n\\nclass Position:\\n def __init__(self, chars: int, line: int) -> None:\\n self.chars = chars\\n self.line = line\\n\\n @classmethod\\n def start(cls) -> \\\"Position\\\":\\n return cls(chars=0, line=1)\\n\\n def set(self, other: \\\"Position\\\") -> None:\\n self.chars = other.chars\\n self.line = other.line\\n\\n def advance(self, string: str) -> None:\\n self.chars += len(string)\\n self.line += len(re.findall(_newline, string))\\n\\n\\nclass Error(Exception):\\n pass\\n\\n\\nclass Reader:\\n def __init__(self, stream: IO[str]) -> None:\\n self.string = stream.read()\\n self.position = Position.start()\\n self.mark = Position.start()\\n\\n def has_next(self) -> bool:\\n return self.position.chars < len(self.string)\\n\\n def set_mark(self) -> None:\\n self.mark.set(self.position)\\n\\n def get_marked(self) -> Original:\\n return Original(\\n string=self.string[self.mark.chars:self.position.chars],\\n line=self.mark.line,\\n )\\n\\n def peek(self, count: int) -> str:\\n return self.string[self.position.chars:self.position.chars + count]\\n\\n def read(self, count: int) -> str:\\n result = self.string[self.position.chars:self.position.chars + count]\\n if len(result) < count:\\n raise Error(\\\"read: End of string\\\")\\n self.position.advance(result)\\n return result\\n\\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\\n match = regex.match(self.string, self.position.chars)\\n if match is None:\\n raise Error(\\\"read_regex: Pattern not found\\\")\\n self.position.advance(self.string[match.start():match.end()])\\n return match.groups()\\n\\n\\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\\n def decode_match(match: Match[str]) -> str:\\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\\n\\n return regex.sub(decode_match, string)\\n\\n\\ndef parse_key(reader: Reader) -> Optional[str]:\\n char = reader.peek(1)\\n if char == \\\"#\\\":\\n return None\\n elif char == \\\"'\\\":\\n (key,) = reader.read_regex(_single_quoted_key)\\n else:\\n (key,) = reader.read_regex(_unquoted_key)\\n return key\\n\\n\\ndef parse_unquoted_value(reader: Reader) -> str:\\n (part,) = reader.read_regex(_unquoted_value)\\n return re.sub(r\\\"\\\\s+#.*\\\", \\\"\\\", part).rstrip()\\n\\n\\ndef parse_value(reader: Reader) -> str:\\n char = reader.peek(1)\\n if char == u\\\"'\\\":\\n (value,) = reader.read_regex(_single_quoted_value)\\n return decode_escapes(_single_quote_escapes, value)\\n elif char == u'\\\"':\\n (value,) = reader.read_regex(_double_quoted_value)\\n return decode_escapes(_double_quote_escapes, value)\\n elif char in (u\\\"\\\", u\\\"\\\\n\\\", u\\\"\\\\r\\\"):\\n return u\\\"\\\"\\n else:\\n return parse_unquoted_value(reader)\\n\\n\\ndef parse_binding(reader: Reader) -> Binding:\\n reader.set_mark()\\n try:\\n reader.read_regex(_multiline_whitespace)\\n if not reader.has_next():\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=False,\\n )\\n reader.read_regex(_export)\\n key = parse_key(reader)\\n reader.read_regex(_whitespace)\\n if reader.peek(1) == \\\"=\\\":\\n reader.read_regex(_equal_sign)\\n value: Optional[str] = parse_value(reader)\\n else:\\n value = None\\n reader.read_regex(_comment)\\n reader.read_regex(_end_of_line)\\n return Binding(\\n key=key,\\n value=value,\\n original=reader.get_marked(),\\n error=False,\\n )\\n except Error:\\n reader.read_regex(_rest_of_line)\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=True,\\n )\\n\\n\\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\\n reader = Reader(stream)\\n while reader.has_next():\\n yield parse_binding(reader)\\n\\n[end of src/dotenv/parser.py]\",\n \"filename\": \"src/dotenv/parser.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \"import json\\nimport os\\nimport shlex\\nimport sys\\nfrom contextlib import contextmanager\\nfrom typing import Any, Dict, IO, Iterator, List, Optional\\n\\ntry:\\n import click\\nexcept ImportError:\\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\\\n'\\n 'Run pip install \\\"python-dotenv[cli]\\\" to fix this.')\\n sys.exit(1)\\n\\nfrom .main import dotenv_values, set_key, unset_key\\nfrom .version import __version__\\n\\n\\ndef enumerate_env() -> Optional[str]:\\n \\\"\\\"\\\"\\n Return a path for the ${pwd}/.env file.\\n\\n If pwd does not exist, return None.\\n \\\"\\\"\\\"\\n try:\\n cwd = os.getcwd()\\n except FileNotFoundError:\\n return None\\n path = os.path.join(cwd, '.env')\\n return path\\n\\n\\n@click.group()\\n@click.option('-f', '--file', default=enumerate_env(),\\n type=click.Path(file_okay=True),\\n help=\\\"Location of the .env file, defaults to .env file in current working directory.\\\")\\n@click.option('-q', '--quote', default='always',\\n type=click.Choice(['always', 'never', 'auto']),\\n help=\\\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\\\")\\n@click.option('-e', '--export', default=False,\\n type=click.BOOL,\\n help=\\\"Whether to write the dot file as an executable bash script.\\\")\\n@click.version_option(version=__version__)\\n@click.pass_context\\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\\n \\\"\\\"\\\"This script is used to set, get or unset values from a .env file.\\\"\\\"\\\"\\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\\n\\n\\n@contextmanager\\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\\n \\\"\\\"\\\"\\n Open a file and yield the corresponding (decoded) stream.\\n\\n Exits with error code 2 if the file cannot be opened.\\n \\\"\\\"\\\"\\n\\n try:\\n with open(path) as stream:\\n yield stream\\n except OSError as exc:\\n print(f\\\"Error opening env file: {exc}\\\", file=sys.stderr)\\n exit(2)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.option('--format', default='simple',\\n type=click.Choice(['simple', 'json', 'shell', 'export']),\\n help=\\\"The format in which to display the list. Default format is simple, \\\"\\n \\\"which displays name=value without quotes.\\\")\\ndef list(ctx: click.Context, format: bool) -> None:\\n \\\"\\\"\\\"Display all the stored key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n if format == 'json':\\n click.echo(json.dumps(values, indent=2, sort_keys=True))\\n else:\\n prefix = 'export ' if format == 'export' else ''\\n for k in sorted(values):\\n v = values[k]\\n if v is not None:\\n if format in ('export', 'shell'):\\n v = shlex.quote(v)\\n click.echo(f'{prefix}{k}={v}')\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\n@click.argument('value', required=True)\\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\\n \\\"\\\"\\\"Store the given key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n export = ctx.obj['EXPORT']\\n success, key, value = set_key(file, key, value, quote, export)\\n if success:\\n click.echo(f'{key}={value}')\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef get(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Retrieve the value for the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n stored_value = values.get(key)\\n if stored_value:\\n click.echo(stored_value)\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef unset(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Removes the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n success, key = unset_key(file, key, quote)\\n if success:\\n click.echo(f\\\"Successfully removed {key}\\\")\\n else:\\n exit(1)\\n\\n\\n@cli.command(context_settings={'ignore_unknown_options': True})\\n@click.pass_context\\n@click.option(\\n \\\"--override/--no-override\\\",\\n default=True,\\n help=\\\"Override variables from the environment file with those from the .env file.\\\",\\n)\\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\\n \\\"\\\"\\\"Run command with environment variables present.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n if not os.path.isfile(file):\\n raise click.BadParameter(\\n f'Invalid value for \\\\'-f\\\\' \\\"{file}\\\" does not exist.',\\n ctx=ctx\\n )\\n dotenv_as_dict = {\\n k: v\\n for (k, v) in dotenv_values(file).items()\\n if v is not None and (override or k not in os.environ)\\n }\\n\\n if not commandline:\\n click.echo('No command given.')\\n exit(1)\\n run_command(commandline, dotenv_as_dict)\\n\\n\\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\\n \\\"\\\"\\\"Replace the current process with the specified command.\\n\\n Replaces the current process with the specified command and the variables from `env`\\n added in the current environment variables.\\n\\n Parameters\\n ----------\\n command: List[str]\\n The command and it's parameters\\n env: Dict\\n The additional environment variables\\n\\n Returns\\n -------\\n None\\n This function does not return any value. It replaces the current process with the new one.\\n\\n \\\"\\\"\\\"\\n # copy the current environment variables and add the vales from\\n # `env`\\n cmd_env = os.environ.copy()\\n cmd_env.update(env)\\n\\n os.execvpe(command[0], args=command, env=cmd_env)\\n\\n[end of src/dotenv/cli.py]\",\n \"filename\": \"src/dotenv/cli.py\",\n \"id\": \"22\"\n },\n {\n \"content\": \"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\\n parse_argstring) # type: ignore\\n\\nfrom .main import find_dotenv, load_dotenv\\n\\n\\n@magics_class\\nclass IPythonDotEnv(Magics):\\n\\n @magic_arguments()\\n @argument(\\n '-o', '--override', action='store_true',\\n help=\\\"Indicate to override existing variables\\\"\\n )\\n @argument(\\n '-v', '--verbose', action='store_true',\\n help=\\\"Indicate function calls to be verbose\\\"\\n )\\n @argument('dotenv_path', nargs='?', type=str, default='.env',\\n help='Search in increasingly higher folders for the `dotenv_path`')\\n @line_magic\\n def dotenv(self, line):\\n args = parse_argstring(self.dotenv, line)\\n # Locate the .env file\\n dotenv_path = args.dotenv_path\\n try:\\n dotenv_path = find_dotenv(dotenv_path, True, True)\\n except IOError:\\n print(\\\"cannot find .env file\\\")\\n return\\n\\n # Load the .env file\\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\\n\\n\\ndef load_ipython_extension(ipython):\\n \\\"\\\"\\\"Register the %dotenv magic.\\\"\\\"\\\"\\n ipython.register_magics(IPythonDotEnv)\\n\\n[end of src/dotenv/ipython.py]\",\n \"filename\": \"src/dotenv/ipython.py\",\n \"id\": \"23\"\n },\n {\n \"content\": \"# Marker file for PEP 561\\n\\n[end of src/dotenv/py.typed]\",\n \"filename\": \"src/dotenv/py.typed\",\n \"id\": \"24\"\n },\n {\n \"content\": \"import io\\nimport logging\\nimport os\\nimport pathlib\\nimport shutil\\nimport sys\\nimport tempfile\\nfrom collections import OrderedDict\\nfrom contextlib import contextmanager\\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\\n\\nfrom .parser import Binding, parse_stream\\nfrom .variables import parse_variables\\n\\n# A type alias for a string path to be used for the paths in this file.\\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\\n# only accepts string paths, not byte paths or file descriptors. See\\n# https://github.com/python/typeshed/pull/6832.\\nStrPath = Union[str, \\\"os.PathLike[str]\\\"]\\n\\nlogger = logging.getLogger(__name__)\\n\\n\\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\\n for mapping in mappings:\\n if mapping.error:\\n logger.warning(\\n \\\"python-dotenv could not parse statement starting at line %s\\\",\\n mapping.original.line,\\n )\\n yield mapping\\n\\n\\nclass DotEnv:\\n def __init__(\\n self,\\n dotenv_path: Optional[StrPath],\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n encoding: Optional[str] = None,\\n interpolate: bool = True,\\n override: bool = True,\\n ) -> None:\\n self.dotenv_path: Optional[StrPath] = dotenv_path\\n self.stream: Optional[IO[str]] = stream\\n self._dict: Optional[Dict[str, Optional[str]]] = None\\n self.verbose: bool = verbose\\n self.encoding: Optional[str] = encoding\\n self.interpolate: bool = interpolate\\n self.override: bool = override\\n\\n @contextmanager\\n def _get_stream(self) -> Iterator[IO[str]]:\\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\\n with open(self.dotenv_path, encoding=self.encoding) as stream:\\n yield stream\\n elif self.stream is not None:\\n yield self.stream\\n else:\\n if self.verbose:\\n logger.info(\\n \\\"python-dotenv could not find configuration file %s.\\\",\\n self.dotenv_path or \\\".env\\\",\\n )\\n yield io.StringIO(\\\"\\\")\\n\\n def dict(self) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"Return dotenv as dict\\\"\\\"\\\"\\n if self._dict:\\n return self._dict\\n\\n raw_values = self.parse()\\n\\n if self.interpolate:\\n self._dict = OrderedDict(\\n resolve_variables(raw_values, override=self.override)\\n )\\n else:\\n self._dict = OrderedDict(raw_values)\\n\\n return self._dict\\n\\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\\n with self._get_stream() as stream:\\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\\n if mapping.key is not None:\\n yield mapping.key, mapping.value\\n\\n def set_as_environment_variables(self) -> bool:\\n \\\"\\\"\\\"\\n Load the current dotenv as system environment variable.\\n \\\"\\\"\\\"\\n if not self.dict():\\n return False\\n\\n for k, v in self.dict().items():\\n if k in os.environ and not self.override:\\n continue\\n if v is not None:\\n os.environ[k] = v\\n\\n return True\\n\\n def get(self, key: str) -> Optional[str]:\\n \\\"\\\"\\\" \\\"\\\"\\\"\\n data = self.dict()\\n\\n if key in data:\\n return data[key]\\n\\n if self.verbose:\\n logger.warning(\\\"Key %s not found in %s.\\\", key, self.dotenv_path)\\n\\n return None\\n\\n\\ndef get_key(\\n dotenv_path: StrPath,\\n key_to_get: str,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Optional[str]:\\n \\\"\\\"\\\"\\n Get the value of a given key from the given .env.\\n\\n Returns `None` if the key isn't found or doesn't have a value.\\n \\\"\\\"\\\"\\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\\n\\n\\n@contextmanager\\ndef rewrite(\\n path: StrPath,\\n encoding: Optional[str],\\n) -> Iterator[Tuple[IO[str], IO[str]]]:\\n pathlib.Path(path).touch()\\n\\n with tempfile.NamedTemporaryFile(mode=\\\"w\\\", encoding=encoding, delete=False) as dest:\\n error = None\\n try:\\n with open(path, encoding=encoding) as source:\\n yield (source, dest)\\n except BaseException as err:\\n error = err\\n\\n if error is None:\\n shutil.move(dest.name, path)\\n else:\\n os.unlink(dest.name)\\n raise error from None\\n\\n\\ndef set_key(\\n dotenv_path: StrPath,\\n key_to_set: str,\\n value_to_set: str,\\n quote_mode: str = \\\"always\\\",\\n export: bool = False,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str, str]:\\n \\\"\\\"\\\"\\n Adds or Updates a key/value to the given .env\\n\\n If the .env path given doesn't exist, fails instead of risking creating\\n an orphan .env somewhere in the filesystem\\n \\\"\\\"\\\"\\n if quote_mode not in (\\\"always\\\", \\\"auto\\\", \\\"never\\\"):\\n raise ValueError(f\\\"Unknown quote_mode: {quote_mode}\\\")\\n\\n quote = quote_mode == \\\"always\\\" or (\\n quote_mode == \\\"auto\\\" and not value_to_set.isalnum()\\n )\\n\\n if quote:\\n value_out = \\\"'{}'\\\".format(value_to_set.replace(\\\"'\\\", \\\"\\\\\\\\'\\\"))\\n else:\\n value_out = value_to_set\\n if export:\\n line_out = f\\\"export {key_to_set}={value_out}\\\\n\\\"\\n else:\\n line_out = f\\\"{key_to_set}={value_out}\\\\n\\\"\\n\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n replaced = False\\n missing_newline = False\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_set:\\n dest.write(line_out)\\n replaced = True\\n else:\\n dest.write(mapping.original.string)\\n missing_newline = not mapping.original.string.endswith(\\\"\\\\n\\\")\\n if not replaced:\\n if missing_newline:\\n dest.write(\\\"\\\\n\\\")\\n dest.write(line_out)\\n\\n return True, key_to_set, value_to_set\\n\\n\\ndef unset_key(\\n dotenv_path: StrPath,\\n key_to_unset: str,\\n quote_mode: str = \\\"always\\\",\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str]:\\n \\\"\\\"\\\"\\n Removes a given key from the given `.env` file.\\n\\n If the .env path given doesn't exist, fails.\\n If the given key doesn't exist in the .env, fails.\\n \\\"\\\"\\\"\\n if not os.path.exists(dotenv_path):\\n logger.warning(\\\"Can't delete from %s - it doesn't exist.\\\", dotenv_path)\\n return None, key_to_unset\\n\\n removed = False\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_unset:\\n removed = True\\n else:\\n dest.write(mapping.original.string)\\n\\n if not removed:\\n logger.warning(\\n \\\"Key %s not removed from %s - key doesn't exist.\\\", key_to_unset, dotenv_path\\n )\\n return None, key_to_unset\\n\\n return removed, key_to_unset\\n\\n\\ndef resolve_variables(\\n values: Iterable[Tuple[str, Optional[str]]],\\n override: bool,\\n) -> Mapping[str, Optional[str]]:\\n new_values: Dict[str, Optional[str]] = {}\\n\\n for name, value in values:\\n if value is None:\\n result = None\\n else:\\n atoms = parse_variables(value)\\n env: Dict[str, Optional[str]] = {}\\n if override:\\n env.update(os.environ) # type: ignore\\n env.update(new_values)\\n else:\\n env.update(new_values)\\n env.update(os.environ) # type: ignore\\n result = \\\"\\\".join(atom.resolve(env) for atom in atoms)\\n\\n new_values[name] = result\\n\\n return new_values\\n\\n\\ndef _walk_to_root(path: str) -> Iterator[str]:\\n \\\"\\\"\\\"\\n Yield directories starting from the given directory up to the root\\n \\\"\\\"\\\"\\n if not os.path.exists(path):\\n raise IOError(\\\"Starting path not found\\\")\\n\\n if os.path.isfile(path):\\n path = os.path.dirname(path)\\n\\n last_dir = None\\n current_dir = os.path.abspath(path)\\n while last_dir != current_dir:\\n yield current_dir\\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\\n last_dir, current_dir = current_dir, parent_dir\\n\\n\\ndef find_dotenv(\\n filename: str = \\\".env\\\",\\n raise_error_if_not_found: bool = False,\\n usecwd: bool = False,\\n) -> str:\\n \\\"\\\"\\\"\\n Search in increasingly higher folders for the given file\\n\\n Returns path to the file if found, or an empty string otherwise\\n \\\"\\\"\\\"\\n\\n def _is_interactive():\\n \\\"\\\"\\\"Decide whether this is running in a REPL or IPython notebook\\\"\\\"\\\"\\n try:\\n main = __import__(\\\"__main__\\\", None, None, fromlist=[\\\"__file__\\\"])\\n except ModuleNotFoundError:\\n return False\\n return not hasattr(main, \\\"__file__\\\")\\n\\n if usecwd or _is_interactive() or getattr(sys, \\\"frozen\\\", False):\\n # Should work without __file__, e.g. in REPL or IPython notebook.\\n path = os.getcwd()\\n else:\\n # will work for .py files\\n frame = sys._getframe()\\n current_file = __file__\\n\\n while frame.f_code.co_filename == current_file or not os.path.exists(\\n frame.f_code.co_filename\\n ):\\n assert frame.f_back is not None\\n frame = frame.f_back\\n frame_filename = frame.f_code.co_filename\\n path = os.path.dirname(os.path.abspath(frame_filename))\\n\\n for dirname in _walk_to_root(path):\\n check_path = os.path.join(dirname, filename)\\n if os.path.isfile(check_path):\\n return check_path\\n\\n if raise_error_if_not_found:\\n raise IOError(\\\"File not found\\\")\\n\\n return \\\"\\\"\\n\\n\\ndef load_dotenv(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n override: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> bool:\\n \\\"\\\"\\\"Parse a .env file and then load all the variables found as environment variables.\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to .env file.\\n stream: Text stream (such as `io.StringIO`) with .env content, used if\\n `dotenv_path` is `None`.\\n verbose: Whether to output a warning the .env file is missing.\\n override: Whether to override the system environment variables with the variables\\n from the `.env` file.\\n encoding: Encoding to be used to read the file.\\n Returns:\\n Bool: True if at least one environment variable is set else False\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file with it's default parameters. If you need to change the default parameters\\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\\n to this function as `dotenv_path`.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n dotenv = DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=override,\\n encoding=encoding,\\n )\\n return dotenv.set_as_environment_variables()\\n\\n\\ndef dotenv_values(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"\\n Parse a .env file and return its content as a dict.\\n\\n The returned dict will have `None` values for keys without values in the .env file.\\n For example, `foo=bar` results in `{\\\"foo\\\": \\\"bar\\\"}` whereas `foo` alone results in\\n `{\\\"foo\\\": None}`\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to the .env file.\\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\\n verbose: Whether to output a warning if the .env file is missing.\\n encoding: Encoding to be used to read the file.\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n return DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=True,\\n encoding=encoding,\\n ).dict()\\n\\n[end of src/dotenv/main.py]\",\n \"filename\": \"src/dotenv/main.py\",\n \"id\": \"25\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Entry point for cli, enables execution with `python -m dotenv`\\\"\\\"\\\"\\n\\nfrom .cli import cli\\n\\nif __name__ == \\\"__main__\\\":\\n cli()\\n\\n[end of src/dotenv/__main__.py]\",\n \"filename\": \"src/dotenv/__main__.py\",\n \"id\": \"26\"\n }\n]","isConversational":false}}},{"rowIdx":64,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 64,\n \"num_files\": 27,\n \"repo_id\": \"repo_0064\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n handlers:\n python:\n rendering:\n show_root_heading: yes\n show_submodules: no\n separate_signature: yes\n - search\nnav:\n - Home: index.md\n - Changelog: changelog.md\n - Contributing: contributing.md\n - Reference: reference.md\n - License: license.md\n\n[end of mkdocs.yml]","filename":"mkdocs.yml","id":"0"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"black~=22.3.0\nbumpversion\nclick\nflake8>=2.2.3\nipython\npytest-cov\npytest>=3.9\nsh>=2\ntox\ntwine\nwheel\n\n[end of requirements.txt]","filename":"requirements.txt","id":"2"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"3"},{"content":".PHONY: clean-pyc clean-build test\n\nclean: clean-build clean-pyc\n\nclean-build:\n\trm -fr build/\n\trm -fr dist/\n\trm -fr src/*.egg-info\n\nclean-pyc:\n\tfind . -name '*.pyc' -exec rm -f {} +\n\tfind . -name '*.pyo' -exec rm -f {} +\n\tfind . -name '*~' -exec rm -f {} +\n\nrelease: sdist\n\ttwine check dist/*\n\ttwine upload dist/*\n\nrelease-test: sdist\n\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\n\nsdist: clean\n\tpython setup.py sdist bdist_wheel\n\tls -l dist\n\ntest:\n\tpip install -e .\n\tflake8 .\n\tpy.test tests/\n\ncoverage:\n\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\n\tcoverage report\n\ncoverage-html: coverage\n\tcoverage html\n\n[end of Makefile]","filename":"Makefile","id":"4"},{"content":"mdx_truly_sane_lists~=1.2\nmkdocs-include-markdown-plugin~=3.3.0\nmkdocs-material~=8.2.9\nmkdocstrings[python]~=0.18.1\nmkdocs~=1.3.0\n\n[end of requirements-docs.txt]","filename":"requirements-docs.txt","id":"5"},{"content":"include LICENSE *.md *.yml *.toml\n\ninclude tox.ini\nrecursive-include docs *.md\nrecursive-include tests *.py\n\ninclude .bumpversion.cfg\ninclude .coveragerc\ninclude .editorconfig\ninclude Makefile\ninclude requirements.txt\ninclude requirements-docs.txt\ninclude src/dotenv/py.typed\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"6"},{"content":"# see: http://editorconfig.org\n\nroot = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.{py,rst,ini}]\nindent_style = space\nindent_size = 4\n\n[*.yml]\nindent_style = space\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"7"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of README.md]","filename":"README.md","id":"8"},{"content":"from setuptools import setup\n\n\ndef read_files(files):\n data = []\n for file in files:\n with open(file, encoding=\"utf-8\") as f:\n data.append(f.read())\n return \"\\n\".join(data)\n\n\nlong_description = read_files([\"README.md\", \"CHANGELOG.md\"])\n\nmeta = {}\nwith open(\"./src/dotenv/version.py\", encoding=\"utf-8\") as f:\n exec(f.read(), meta)\n\nsetup(\n name=\"python-dotenv\",\n description=\"Read key-value pairs from a .env file and set them as environment variables\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n version=meta[\"__version__\"],\n author=\"Saurabh Kumar\",\n author_email=\"me+github@saurabh-kumar.com\",\n url=\"https://github.com/theskumar/python-dotenv\",\n keywords=[\n \"environment variables\",\n \"deployments\",\n \"settings\",\n \"env\",\n \"dotenv\",\n \"configurations\",\n \"python\",\n ],\n packages=[\"dotenv\"],\n package_dir={\"\": \"src\"},\n package_data={\n \"dotenv\": [\"py.typed\"],\n },\n python_requires=\">=3.9\",\n extras_require={\n \"cli\": [\n \"click>=5.0\",\n ],\n },\n entry_points={\n \"console_scripts\": [\n \"dotenv=dotenv.__main__:cli\",\n ],\n },\n license=\"BSD-3-Clause\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Topic :: System :: Systems Administration\",\n \"Topic :: Utilities\",\n \"Environment :: Web Environment\",\n ],\n)\n\n[end of setup.py]","filename":"setup.py","id":"9"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of CONTRIBUTING.md]","filename":"CONTRIBUTING.md","id":"10"},{"content":"[tox]\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\n\n[gh-actions]\npython =\n 3.9: py39\n 3.10: py310\n 3.11: py311\n 3.12: py312\n 3.13: py313, lint, manifest\n pypy-3.9: pypy3\n\n[testenv]\ndeps =\n pytest\n pytest-cov\n sh >= 2.0.2, <3\n click\n py{39,310,311,312,313,pypy3}: ipython\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\ndepends =\n py{39,310,311,312,313},pypy3: coverage-clean\n coverage-report: py{39,310,311,312,313},pypy3\n\n[testenv:lint]\nskip_install = true\ndeps =\n flake8\n mypy\ncommands =\n flake8 src tests\n mypy --python-version=3.13 src tests\n mypy --python-version=3.12 src tests\n mypy --python-version=3.11 src tests\n mypy --python-version=3.10 src tests\n mypy --python-version=3.9 src tests\n\n[testenv:manifest]\ndeps = check-manifest\nskip_install = true\ncommands = check-manifest\n\n[testenv:coverage-clean]\ndeps = coverage\nskip_install = true\ncommands = coverage erase\n\n[testenv:coverage-report]\ndeps = coverage\nskip_install = true\ncommands =\n coverage report\n\n[end of tox.ini]","filename":"tox.ini","id":"11"},{"content":"[bumpversion]\ncurrent_version = 1.0.1\ncommit = True\ntag = True\n\n[bumpversion:file:src/dotenv/version.py]\n\n[flake8]\nmax-line-length = 120\nexclude = .tox,.git,docs,venv,.venv,build\n\n[mypy]\ncheck_untyped_defs = true\nignore_missing_imports = true\n\n[metadata]\ndescription_file = README.md\n\n[tool:pytest]\ntestpaths = tests\n\n[coverage:run]\nrelative_files = True\nsource = dotenv\n\n[coverage:paths]\nsource =\n\tsrc/dotenv\n\t.tox/*/lib/python*/site-packages/dotenv\n\t.tox/pypy*/site-packages/dotenv\n\n[coverage:report]\nshow_missing = True\ninclude = */site-packages/dotenv/*\nexclude_lines =\n\tif IS_TYPE_CHECKING:\n\tpragma: no cover\n\n[end of setup.cfg]","filename":"setup.cfg","id":"12"},{"content":"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n- Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n- Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n- Neither the name of django-dotenv nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of docs/license.md]","filename":"docs/license.md","id":"13"},{"content":"# ::: dotenv\n\n\n[end of docs/reference.md]","filename":"docs/reference.md","id":"14"},{"content":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n\n## [Unreleased]\n\n- Drop support for Python 3.8\n- Add support for python 3.13\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\n\n## [1.0.1] - 2024-01-23\n\n**Fixed**\n\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\n\n**Misc**\n* Use pathlib.Path in tests ([#466] by [@eumiro])\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\n* Use https in README links ([#474] by [@Nicals])\n\n## [1.0.0] - 2023-02-24\n\n**Fixed**\n\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\n\n## [0.21.1] - 2023-01-21\n\n**Added**\n\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\n* Modernize variables code (#434 by [@Nougat-Waffle])\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\n\n\n**Fixed**\n\n* Fix Out-of-scope error when \"dest\" variable is undefined (#413 by [@theGOTOguy])\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\n\n## [0.21.0] - 2022-09-03\n\n**Added**\n\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\n* CLI: add --format= option to list command. (#407 by [@sammck])\n\n**Fixed**\n\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\n* Improve documentation for variables without a value (#390 by [@bbc2])\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\n* Update README.md (#415 by [@harveer07])\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\n\n## [0.20.0] - 2022-03-24\n\n**Added**\n\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\n (#379 by [@bbc2])\n\n**Fixed**\n\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\n [@mgorny]).\n- Don't build universal wheels (#387 by [@bbc2]).\n\n## [0.19.2] - 2021-11-11\n\n**Fixed**\n\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\n [@bbc2])\n\n## [0.19.1] - 2021-08-09\n\n**Added**\n\n- Add support for Python 3.10. (#359 by [@theskumar])\n\n## [0.19.0] - 2021-07-24\n\n**Changed**\n\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\n by [@bbc2]).\n\n**Added**\n\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\n (`IO[str]`), which includes values like `io.StringIO(\"foo\")` and `open(\"file.env\",\n \"r\")` (#348 by [@bbc2]).\n\n## [0.18.0] - 2021-06-20\n\n**Changed**\n\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\n `set_key` (#330 by [@bbc2]).\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\n by [@bbc2]):\n - Use single quotes instead of double quotes.\n - Don't strip surrounding quotes.\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\n (as determined by `string.isalnum`).\n\n## [0.17.1] - 2021-04-29\n\n**Fixed**\n\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\n\n## [0.17.0] - 2021-04-02\n\n**Changed**\n\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\n\n**Added**\n\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\n\n## [0.16.0] - 2021-03-27\n\n**Changed**\n\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\n now `\"utf-8\"` instead of `None` (#306 by [@bbc2]).\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\n\n## [0.15.0] - 2020-10-28\n\n**Added**\n\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\n [@jadutter]).\n\n**Changed**\n\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\n found (#270 by [@jadutter]).\n\n**Fixed**\n\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\n- Fix parsing of unquoted values containing several adjacent space or tab characters\n (#277 by [@bbc2], review by [@x-yuri]).\n\n## [0.14.0] - 2020-07-03\n\n**Changed**\n\n- Privilege definition in file over the environment in variable expansion (#256 by\n [@elbehery95]).\n\n**Fixed**\n\n- Improve error message for when file isn't found (#245 by [@snobu]).\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\n\n## [0.13.0] - 2020-04-16\n\n**Added**\n\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\n\n## [0.12.0] - 2020-02-28\n\n**Changed**\n\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\n [@gergelyk]).\n\n**Fixed**\n\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\n- Remove warning when last line is empty (#238 by [@bbc2]).\n\n## [0.11.0] - 2020-02-07\n\n**Added**\n\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\n (#232 by [@ulyssessouza]).\n\n**Changed**\n\n- Use logging instead of warnings (#231 by [@bbc2]).\n\n**Fixed**\n\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\n- Fix PyPI classifiers (#228 by [@bbc2]).\n\n## [0.10.5] - 2020-01-19\n\n**Fixed**\n\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\n - Don't print warning when key has no value.\n - Reject more malformed lines (e.g. \"A: B\", \"a='b',c\").\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\n\n## [0.10.4] - 2020-01-17\n\n**Added**\n\n- Make typing optional (#179 by [@techalchemy]).\n- Print a warning on malformed line (#211 by [@bbc2]).\n- Support keys without a value (#220 by [@ulyssessouza]).\n\n## 0.10.3\n\n- Improve interactive mode detection ([@andrewsmith])([#183]).\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\n - Interpret escapes as control characters only in double-quoted strings.\n - Interpret `#` as start of comment only if preceded by whitespace.\n\n## 0.10.2\n\n- Add type hints and expose them to users ([@qnighy])([#172])\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\n ([@theskumar])([@earlbread])([#161])\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\n\n## 0.10.1\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\n\n## 0.10.0\n\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\n- Add support for trailing comments ([@bbc2])([#148])\n- Add backslashes support in values ([@bbc2])([#148])\n- Add support for newlines in values ([@bbc2])([#148])\n- Force environment variables to str with Python2 on Windows ([@greyli])\n- Drop Python 3.3 support ([@greyli])\n- Fix stderr/-out/-in redirection ([@venthur])\n\n\n## 0.9.0\n\n- Add `--version` parameter to cli ([@venthur])\n- Enable loading from current directory ([@cjauvin])\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\n\n## 0.8.1\n\n- Add tests for docs ([@Flimm])\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\n\n## 0.8.0\n\n- `set_key` and `unset_key` only modified the affected file instead of\n parsing and re-writing file, this causes comments and other file\n entact as it is.\n- Add support for `export` prefix in the line.\n- Internal refractoring ([@theskumar])\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\n\n## 0.7.1\n\n- Remove hard dependency on iPython ([@theskumar])\n\n## 0.7.0\n\n- Add support to override system environment variable via .env.\n ([@milonimrod](https://github.com/milonimrod))\n ([\\#63](https://github.com/theskumar/python-dotenv/issues/63))\n- Disable \".env not found\" warning by default\n ([@maxkoryukov](https://github.com/maxkoryukov))\n ([\\#57](https://github.com/theskumar/python-dotenv/issues/57))\n\n## 0.6.5\n\n- Add support for special characters `\\`.\n ([@pjona](https://github.com/pjona))\n ([\\#60](https://github.com/theskumar/python-dotenv/issues/60))\n\n## 0.6.4\n\n- Fix issue with single quotes ([@Flimm])\n ([\\#52](https://github.com/theskumar/python-dotenv/issues/52))\n\n## 0.6.3\n\n- Handle unicode exception in setup.py\n ([\\#46](https://github.com/theskumar/python-dotenv/issues/46))\n\n## 0.6.2\n\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\n- Add iPython Support\n ([@tillahoffmann](https://github.com/tillahoffmann))\n\n## 0.6.0\n\n- Drop support for Python 2.6\n- Handle escaped characters and newlines in quoted values. (Thanks\n [@iameugenejo](https://github.com/iameugenejo))\n- Remove any spaces around unquoted key/value. (Thanks\n [@paulochf](https://github.com/paulochf))\n- Added POSIX variable expansion. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla))\n\n## 0.5.1\n\n- Fix `find_dotenv` - it now start search from the file where this\n function is called from.\n\n## 0.5.0\n\n- Add `find_dotenv` method that will try to find a `.env` file.\n (Thanks [@isms](https://github.com/isms))\n\n## 0.4.0\n\n- cli: Added `-q/--quote` option to control the behaviour of quotes\n around values in `.env`. (Thanks\n [@hugochinchilla](https://github.com/hugochinchilla)).\n- Improved test coverage.\n\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\n\n[@alanjds]: https://github.com/alanjds\n[@altendky]: https://github.com/altendky\n[@andrewsmith]: https://github.com/andrewsmith\n[@asyncee]: https://github.com/asyncee\n[@bbc2]: https://github.com/bbc2\n[@befeleme]: https://github.com/befeleme\n[@cjauvin]: https://github.com/cjauvin\n[@eaf]: https://github.com/eaf\n[@earlbread]: https://github.com/earlbread\n[@eekstunt]: https://github.com/eekstunt\n[@eggplants]: https://github.com/@eggplants\n[@ekohl]: https://github.com/ekohl\n[@elbehery95]: https://github.com/elbehery95\n[@eumiro]: https://github.com/eumiro\n[@Flimm]: https://github.com/Flimm\n[@freddyaboulton]: https://github.com/freddyaboulton\n[@gergelyk]: https://github.com/gergelyk\n[@gongqingkui]: https://github.com/gongqingkui\n[@greyli]: https://github.com/greyli\n[@harveer07]: https://github.com/@harveer07\n[@jadutter]: https://github.com/jadutter\n[@jankislinger]: https://github.com/jankislinger\n[@jctanner]: https://github.com/jctanner\n[@larsks]: https://github.com/@larsks\n[@lsmith77]: https://github.com/lsmith77\n[@mgorny]: https://github.com/mgorny\n[@naorlivne]: https://github.com/@naorlivne\n[@Nicals]: https://github.com/Nicals\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\n[@qnighy]: https://github.com/qnighy\n[@Qwerty-133]: https://github.com/Qwerty-133\n[@rabinadk1]: https://github.com/@rabinadk1\n[@sammck]: https://github.com/@sammck\n[@samwyma]: https://github.com/samwyma\n[@snobu]: https://github.com/snobu\n[@techalchemy]: https://github.com/techalchemy\n[@theGOTOguy]: https://github.com/theGOTOguy\n[@theskumar]: https://github.com/theskumar\n[@ulyssessouza]: https://github.com/ulyssessouza\n[@venthur]: https://github.com/venthur\n[@x-yuri]: https://github.com/x-yuri\n[@yannham]: https://github.com/yannham\n[@zueve]: https://github.com/zueve\n\n\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\n\n[end of docs/changelog.md]","filename":"docs/changelog.md","id":"15"},{"content":"# python-dotenv\n\n[![Build Status][build_status_badge]][build_status_link]\n[![PyPI version][pypi_badge]][pypi_link]\n\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\nvariables. It helps in the development of applications following the\n[12-factor](https://12factor.net/) principles.\n\n- [Getting Started](#getting-started)\n- [Other Use Cases](#other-use-cases)\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\n * [Load .env files in IPython](#load-env-files-in-ipython)\n- [Command-line Interface](#command-line-interface)\n- [File format](#file-format)\n * [Multiline values](#multiline-values)\n * [Variable expansion](#variable-expansion)\n- [Related Projects](#related-projects)\n- [Acknowledgements](#acknowledgements)\n\n## Getting Started\n\n```shell\npip install python-dotenv\n```\n\nIf your application takes its configuration from environment variables, like a 12-factor\napplication, launching it in development is not very practical because you have to set\nthose environment variables yourself.\n\nTo help you with that, you can add python-dotenv to your application to make it load the\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\nconfigurable via the environment:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv() # take environment variables\n\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\n# `os.getenv`) as if they came from the actual environment.\n```\n\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\n\nTo configure the development environment, add a `.env` in the root directory of your\nproject:\n\n```\n.\n├── .env\n└── foo.py\n```\n\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\n\n```bash\n# Development settings\nDOMAIN=example.org\nADMIN_EMAIL=admin@${DOMAIN}\nROOT_URL=${DOMAIN}/app\n```\n\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\n\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\nsecrets like a password.\n\nSee the section \"File format\" below for more information about what you can write in a\n`.env` file.\n\n## Other Use Cases\n\n### Load configuration without altering the environment\n\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\n`.env` file.\n\n```python\nfrom dotenv import dotenv_values\n\nconfig = dotenv_values(\".env\") # config = {\"USER\": \"foo\", \"EMAIL\": \"foo@example.org\"}\n```\n\nThis notably enables advanced configuration management:\n\n```python\nimport os\nfrom dotenv import dotenv_values\n\nconfig = {\n **dotenv_values(\".env.shared\"), # load shared development variables\n **dotenv_values(\".env.secret\"), # load sensitive variables\n **os.environ, # override loaded values with environment variables\n}\n```\n\n### Parse configuration as a stream\n\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\nargument. It is thus possible to load the variables from sources other than the\nfilesystem (e.g. the network).\n\n```python\nfrom io import StringIO\n\nfrom dotenv import load_dotenv\n\nconfig = StringIO(\"USER=foo\\nEMAIL=foo@example.org\")\nload_dotenv(stream=config)\n```\n\n### Load .env files in IPython\n\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\n`.env` file:\n\n```python\n%load_ext dotenv\n%dotenv\n```\n\nYou can also specify a path:\n\n```python\n%dotenv relative/or/absolute/path/to/.env\n```\n\nOptional flags:\n\n- `-o` to override existing variables.\n- `-v` for increased verbosity.\n\n## Command-line Interface\n\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\nwithout manually opening it.\n\n```shell\n$ pip install \"python-dotenv[cli]\"\n$ dotenv set USER foo\n$ dotenv set EMAIL foo@example.org\n$ dotenv list\nUSER=foo\nEMAIL=foo@example.org\n$ dotenv list --format=json\n{\n \"USER\": \"foo\",\n \"EMAIL\": \"foo@example.org\"\n}\n$ dotenv run -- python foo.py\n```\n\nRun `dotenv --help` for more information about the options and subcommands.\n\n## File format\n\nThe format is not formally specified and still improves over time. That being said,\n`.env` files should mostly look like Bash files.\n\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\nby a comment. Lines can start with the `export` directive, which does not affect their\ninterpretation.\n\nAllowed escape sequences:\n\n- in single-quoted values: `\\\\`, `\\'`\n- in double-quoted values: `\\\\`, `\\'`, `\\\"`, `\\a`, `\\b`, `\\f`, `\\n`, `\\r`, `\\t`, `\\v`\n\n### Multiline values\n\nIt is possible for single- or double-quoted values to span multiple lines. The following\nexamples are equivalent:\n\n```bash\nFOO=\"first line\nsecond line\"\n```\n\n```bash\nFOO=\"first line\\nsecond line\"\n```\n\n### Variable without a value\n\nA variable can have no value:\n\n```bash\nFOO\n```\n\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\n`{\"FOO\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\n\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\nempty string.\n\n### Variable expansion\n\npython-dotenv can interpolate variables using POSIX variable expansion.\n\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\nfirst of the values defined in the following list:\n\n- Value of that variable in the `.env` file.\n- Value of that variable in the environment.\n- Default value, if provided.\n- Empty string.\n\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\ndefined in the following list:\n\n- Value of that variable in the environment.\n- Value of that variable in the `.env` file.\n- Default value, if provided.\n- Empty string.\n\n## Related Projects\n\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\n Procfile-based applications.\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\n- [django-environ](https://github.com/joke2k/django-environ)\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\n- [django-configuration](https://github.com/jezdez/django-configurations)\n- [dump-env](https://github.com/sobolevn/dump-env)\n- [environs](https://github.com/sloria/environs)\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\n- [parse_it](https://github.com/naorlivne/parse_it)\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\n\n## Acknowledgements\n\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\nwithout the support of these [awesome\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\n\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\n[pypi_link]: https://badge.fury.io/py/python-dotenv\n[python_streams]: https://docs.python.org/3/library/io.html\n\n[end of docs/index.md]","filename":"docs/index.md","id":"16"},{"content":"Contributing\n============\n\nAll the contributions are welcome! Please open [an\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\na pull request.\n\nExecuting the tests:\n\n $ pip install -r requirements.txt\n $ pip install -e .\n $ flake8\n $ pytest\n\nor with [tox](https://pypi.org/project/tox/) installed:\n\n $ tox\n\n\nDocumentation is published with [mkdocs]():\n\n```shell\n$ pip install -r requirements-docs.txt\n$ pip install -e .\n$ mkdocs serve\n```\n\nOpen http://127.0.0.1:8000/ to view the documentation locally.\n\n\n[end of docs/contributing.md]","filename":"docs/contributing.md","id":"17"},{"content":"__version__ = \"1.0.1\"\n\n[end of src/dotenv/version.py]","filename":"src/dotenv/version.py","id":"18"},{"content":"import re\nfrom abc import ABCMeta, abstractmethod\nfrom typing import Iterator, Mapping, Optional, Pattern\n\n_posix_variable: Pattern[str] = re.compile(\n r\"\"\"\n \\$\\{\n (?P<name>[^\\}:]*)\n (?::-\n (?P<default>[^\\}]*)\n )?\n \\}\n \"\"\",\n re.VERBOSE,\n)\n\n\nclass Atom(metaclass=ABCMeta):\n def __ne__(self, other: object) -> bool:\n result = self.__eq__(other)\n if result is NotImplemented:\n return NotImplemented\n return not result\n\n @abstractmethod\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\n\n\nclass Literal(Atom):\n def __init__(self, value: str) -> None:\n self.value = value\n\n def __repr__(self) -> str:\n return f\"Literal(value={self.value})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return self.value == other.value\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.value))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n return self.value\n\n\nclass Variable(Atom):\n def __init__(self, name: str, default: Optional[str]) -> None:\n self.name = name\n self.default = default\n\n def __repr__(self) -> str:\n return f\"Variable(name={self.name}, default={self.default})\"\n\n def __eq__(self, other: object) -> bool:\n if not isinstance(other, self.__class__):\n return NotImplemented\n return (self.name, self.default) == (other.name, other.default)\n\n def __hash__(self) -> int:\n return hash((self.__class__, self.name, self.default))\n\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\n default = self.default if self.default is not None else \"\"\n result = env.get(self.name, default)\n return result if result is not None else \"\"\n\n\ndef parse_variables(value: str) -> Iterator[Atom]:\n cursor = 0\n\n for match in _posix_variable.finditer(value):\n (start, end) = match.span()\n name = match[\"name\"]\n default = match[\"default\"]\n\n if start > cursor:\n yield Literal(value=value[cursor:start])\n\n yield Variable(name=name, default=default)\n cursor = end\n\n length = len(value)\n if cursor < length:\n yield Literal(value=value[cursor:length])\n\n[end of src/dotenv/variables.py]","filename":"src/dotenv/variables.py","id":"19"},{"content":"from typing import Any, Optional\n\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\n unset_key)\n\n\ndef load_ipython_extension(ipython: Any) -> None:\n from .ipython import load_ipython_extension\n load_ipython_extension(ipython)\n\n\ndef get_cli_string(\n path: Optional[str] = None,\n action: Optional[str] = None,\n key: Optional[str] = None,\n value: Optional[str] = None,\n quote: Optional[str] = None,\n):\n \"\"\"Returns a string suitable for running as a shell script.\n\n Useful for converting a arguments passed to a fabric task\n to be passed to a `local` or `run` command.\n \"\"\"\n command = ['dotenv']\n if quote:\n command.append(f'-q {quote}')\n if path:\n command.append(f'-f {path}')\n if action:\n command.append(action)\n if key:\n command.append(key)\n if value:\n if ' ' in value:\n command.append(f'\"{value}\"')\n else:\n command.append(value)\n\n return ' '.join(command).strip()\n\n\n__all__ = ['get_cli_string',\n 'load_dotenv',\n 'dotenv_values',\n 'get_key',\n 'set_key',\n 'unset_key',\n 'find_dotenv',\n 'load_ipython_extension']\n\n[end of src/dotenv/__init__.py]","filename":"src/dotenv/__init__.py","id":"20"},{"content":"import codecs\nimport re\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\n Pattern, Sequence, Tuple)\n\n\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\n return re.compile(string, re.UNICODE | extra_flags)\n\n\n_newline = make_regex(r\"(\\r\\n|\\n|\\r)\")\n_multiline_whitespace = make_regex(r\"\\s*\", extra_flags=re.MULTILINE)\n_whitespace = make_regex(r\"[^\\S\\r\\n]*\")\n_export = make_regex(r\"(?:export[^\\S\\r\\n]+)?\")\n_single_quoted_key = make_regex(r\"'([^']+)'\")\n_unquoted_key = make_regex(r\"([^=\\#\\s]+)\")\n_equal_sign = make_regex(r\"(=[^\\S\\r\\n]*)\")\n_single_quoted_value = make_regex(r\"'((?:\\\\'|[^'])*)'\")\n_double_quoted_value = make_regex(r'\"((?:\\\\\"|[^\"])*)\"')\n_unquoted_value = make_regex(r\"([^\\r\\n]*)\")\n_comment = make_regex(r\"(?:[^\\S\\r\\n]*#[^\\r\\n]*)?\")\n_end_of_line = make_regex(r\"[^\\S\\r\\n]*(?:\\r\\n|\\n|\\r|$)\")\n_rest_of_line = make_regex(r\"[^\\r\\n]*(?:\\r|\\n|\\r\\n)?\")\n_double_quote_escapes = make_regex(r\"\\\\[\\\\'\\\"abfnrtv]\")\n_single_quote_escapes = make_regex(r\"\\\\[\\\\']\")\n\n\nclass Original(NamedTuple):\n string: str\n line: int\n\n\nclass Binding(NamedTuple):\n key: Optional[str]\n value: Optional[str]\n original: Original\n error: bool\n\n\nclass Position:\n def __init__(self, chars: int, line: int) -> None:\n self.chars = chars\n self.line = line\n\n @classmethod\n def start(cls) -> \"Position\":\n return cls(chars=0, line=1)\n\n def set(self, other: \"Position\") -> None:\n self.chars = other.chars\n self.line = other.line\n\n def advance(self, string: str) -> None:\n self.chars += len(string)\n self.line += len(re.findall(_newline, string))\n\n\nclass Error(Exception):\n pass\n\n\nclass Reader:\n def __init__(self, stream: IO[str]) -> None:\n self.string = stream.read()\n self.position = Position.start()\n self.mark = Position.start()\n\n def has_next(self) -> bool:\n return self.position.chars < len(self.string)\n\n def set_mark(self) -> None:\n self.mark.set(self.position)\n\n def get_marked(self) -> Original:\n return Original(\n string=self.string[self.mark.chars:self.position.chars],\n line=self.mark.line,\n )\n\n def peek(self, count: int) -> str:\n return self.string[self.position.chars:self.position.chars + count]\n\n def read(self, count: int) -> str:\n result = self.string[self.position.chars:self.position.chars + count]\n if len(result) < count:\n raise Error(\"read: End of string\")\n self.position.advance(result)\n return result\n\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\n match = regex.match(self.string, self.position.chars)\n if match is None:\n raise Error(\"read_regex: Pattern not found\")\n self.position.advance(self.string[match.start():match.end()])\n return match.groups()\n\n\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\n def decode_match(match: Match[str]) -> str:\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\n\n return regex.sub(decode_match, string)\n\n\ndef parse_key(reader: Reader) -> Optional[str]:\n char = reader.peek(1)\n if char == \"#\":\n return None\n elif char == \"'\":\n (key,) = reader.read_regex(_single_quoted_key)\n else:\n (key,) = reader.read_regex(_unquoted_key)\n return key\n\n\ndef parse_unquoted_value(reader: Reader) -> str:\n (part,) = reader.read_regex(_unquoted_value)\n return re.sub(r\"\\s+#.*\", \"\", part).rstrip()\n\n\ndef parse_value(reader: Reader) -> str:\n char = reader.peek(1)\n if char == u\"'\":\n (value,) = reader.read_regex(_single_quoted_value)\n return decode_escapes(_single_quote_escapes, value)\n elif char == u'\"':\n (value,) = reader.read_regex(_double_quoted_value)\n return decode_escapes(_double_quote_escapes, value)\n elif char in (u\"\", u\"\\n\", u\"\\r\"):\n return u\"\"\n else:\n return parse_unquoted_value(reader)\n\n\ndef parse_binding(reader: Reader) -> Binding:\n reader.set_mark()\n try:\n reader.read_regex(_multiline_whitespace)\n if not reader.has_next():\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=False,\n )\n reader.read_regex(_export)\n key = parse_key(reader)\n reader.read_regex(_whitespace)\n if reader.peek(1) == \"=\":\n reader.read_regex(_equal_sign)\n value: Optional[str] = parse_value(reader)\n else:\n value = None\n reader.read_regex(_comment)\n reader.read_regex(_end_of_line)\n return Binding(\n key=key,\n value=value,\n original=reader.get_marked(),\n error=False,\n )\n except Error:\n reader.read_regex(_rest_of_line)\n return Binding(\n key=None,\n value=None,\n original=reader.get_marked(),\n error=True,\n )\n\n\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\n reader = Reader(stream)\n while reader.has_next():\n yield parse_binding(reader)\n\n[end of src/dotenv/parser.py]","filename":"src/dotenv/parser.py","id":"21"},{"content":"import json\nimport os\nimport shlex\nimport sys\nfrom contextlib import contextmanager\nfrom typing import Any, Dict, IO, Iterator, List, Optional\n\ntry:\n import click\nexcept ImportError:\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\n'\n 'Run pip install \"python-dotenv[cli]\" to fix this.')\n sys.exit(1)\n\nfrom .main import dotenv_values, set_key, unset_key\nfrom .version import __version__\n\n\ndef enumerate_env() -> Optional[str]:\n \"\"\"\n Return a path for the ${pwd}/.env file.\n\n If pwd does not exist, return None.\n \"\"\"\n try:\n cwd = os.getcwd()\n except FileNotFoundError:\n return None\n path = os.path.join(cwd, '.env')\n return path\n\n\n@click.group()\n@click.option('-f', '--file', default=enumerate_env(),\n type=click.Path(file_okay=True),\n help=\"Location of the .env file, defaults to .env file in current working directory.\")\n@click.option('-q', '--quote', default='always',\n type=click.Choice(['always', 'never', 'auto']),\n help=\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\")\n@click.option('-e', '--export', default=False,\n type=click.BOOL,\n help=\"Whether to write the dot file as an executable bash script.\")\n@click.version_option(version=__version__)\n@click.pass_context\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\n \"\"\"This script is used to set, get or unset values from a .env file.\"\"\"\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\n\n\n@contextmanager\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\n \"\"\"\n Open a file and yield the corresponding (decoded) stream.\n\n Exits with error code 2 if the file cannot be opened.\n \"\"\"\n\n try:\n with open(path) as stream:\n yield stream\n except OSError as exc:\n print(f\"Error opening env file: {exc}\", file=sys.stderr)\n exit(2)\n\n\n@cli.command()\n@click.pass_context\n@click.option('--format', default='simple',\n type=click.Choice(['simple', 'json', 'shell', 'export']),\n help=\"The format in which to display the list. Default format is simple, \"\n \"which displays name=value without quotes.\")\ndef list(ctx: click.Context, format: bool) -> None:\n \"\"\"Display all the stored key/value.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n if format == 'json':\n click.echo(json.dumps(values, indent=2, sort_keys=True))\n else:\n prefix = 'export ' if format == 'export' else ''\n for k in sorted(values):\n v = values[k]\n if v is not None:\n if format in ('export', 'shell'):\n v = shlex.quote(v)\n click.echo(f'{prefix}{k}={v}')\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\n@click.argument('value', required=True)\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\n \"\"\"Store the given key/value.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n export = ctx.obj['EXPORT']\n success, key, value = set_key(file, key, value, quote, export)\n if success:\n click.echo(f'{key}={value}')\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef get(ctx: click.Context, key: Any) -> None:\n \"\"\"Retrieve the value for the given key.\"\"\"\n file = ctx.obj['FILE']\n\n with stream_file(file) as stream:\n values = dotenv_values(stream=stream)\n\n stored_value = values.get(key)\n if stored_value:\n click.echo(stored_value)\n else:\n exit(1)\n\n\n@cli.command()\n@click.pass_context\n@click.argument('key', required=True)\ndef unset(ctx: click.Context, key: Any) -> None:\n \"\"\"Removes the given key.\"\"\"\n file = ctx.obj['FILE']\n quote = ctx.obj['QUOTE']\n success, key = unset_key(file, key, quote)\n if success:\n click.echo(f\"Successfully removed {key}\")\n else:\n exit(1)\n\n\n@cli.command(context_settings={'ignore_unknown_options': True})\n@click.pass_context\n@click.option(\n \"--override/--no-override\",\n default=True,\n help=\"Override variables from the environment file with those from the .env file.\",\n)\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\n \"\"\"Run command with environment variables present.\"\"\"\n file = ctx.obj['FILE']\n if not os.path.isfile(file):\n raise click.BadParameter(\n f'Invalid value for \\'-f\\' \"{file}\" does not exist.',\n ctx=ctx\n )\n dotenv_as_dict = {\n k: v\n for (k, v) in dotenv_values(file).items()\n if v is not None and (override or k not in os.environ)\n }\n\n if not commandline:\n click.echo('No command given.')\n exit(1)\n run_command(commandline, dotenv_as_dict)\n\n\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\n \"\"\"Replace the current process with the specified command.\n\n Replaces the current process with the specified command and the variables from `env`\n added in the current environment variables.\n\n Parameters\n ----------\n command: List[str]\n The command and it's parameters\n env: Dict\n The additional environment variables\n\n Returns\n -------\n None\n This function does not return any value. It replaces the current process with the new one.\n\n \"\"\"\n # copy the current environment variables and add the vales from\n # `env`\n cmd_env = os.environ.copy()\n cmd_env.update(env)\n\n os.execvpe(command[0], args=command, env=cmd_env)\n\n[end of src/dotenv/cli.py]","filename":"src/dotenv/cli.py","id":"22"},{"content":"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\n parse_argstring) # type: ignore\n\nfrom .main import find_dotenv, load_dotenv\n\n\n@magics_class\nclass IPythonDotEnv(Magics):\n\n @magic_arguments()\n @argument(\n '-o', '--override', action='store_true',\n help=\"Indicate to override existing variables\"\n )\n @argument(\n '-v', '--verbose', action='store_true',\n help=\"Indicate function calls to be verbose\"\n )\n @argument('dotenv_path', nargs='?', type=str, default='.env',\n help='Search in increasingly higher folders for the `dotenv_path`')\n @line_magic\n def dotenv(self, line):\n args = parse_argstring(self.dotenv, line)\n # Locate the .env file\n dotenv_path = args.dotenv_path\n try:\n dotenv_path = find_dotenv(dotenv_path, True, True)\n except IOError:\n print(\"cannot find .env file\")\n return\n\n # Load the .env file\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\n\n\ndef load_ipython_extension(ipython):\n \"\"\"Register the %dotenv magic.\"\"\"\n ipython.register_magics(IPythonDotEnv)\n\n[end of src/dotenv/ipython.py]","filename":"src/dotenv/ipython.py","id":"23"},{"content":"# Marker file for PEP 561\n\n[end of src/dotenv/py.typed]","filename":"src/dotenv/py.typed","id":"24"},{"content":"import io\nimport logging\nimport os\nimport pathlib\nimport shutil\nimport sys\nimport tempfile\nfrom collections import OrderedDict\nfrom contextlib import contextmanager\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\n\nfrom .parser import Binding, parse_stream\nfrom .variables import parse_variables\n\n# A type alias for a string path to be used for the paths in this file.\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\n# only accepts string paths, not byte paths or file descriptors. See\n# https://github.com/python/typeshed/pull/6832.\nStrPath = Union[str, \"os.PathLike[str]\"]\n\nlogger = logging.getLogger(__name__)\n\n\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\n for mapping in mappings:\n if mapping.error:\n logger.warning(\n \"python-dotenv could not parse statement starting at line %s\",\n mapping.original.line,\n )\n yield mapping\n\n\nclass DotEnv:\n def __init__(\n self,\n dotenv_path: Optional[StrPath],\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n encoding: Optional[str] = None,\n interpolate: bool = True,\n override: bool = True,\n ) -> None:\n self.dotenv_path: Optional[StrPath] = dotenv_path\n self.stream: Optional[IO[str]] = stream\n self._dict: Optional[Dict[str, Optional[str]]] = None\n self.verbose: bool = verbose\n self.encoding: Optional[str] = encoding\n self.interpolate: bool = interpolate\n self.override: bool = override\n\n @contextmanager\n def _get_stream(self) -> Iterator[IO[str]]:\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\n with open(self.dotenv_path, encoding=self.encoding) as stream:\n yield stream\n elif self.stream is not None:\n yield self.stream\n else:\n if self.verbose:\n logger.info(\n \"python-dotenv could not find configuration file %s.\",\n self.dotenv_path or \".env\",\n )\n yield io.StringIO(\"\")\n\n def dict(self) -> Dict[str, Optional[str]]:\n \"\"\"Return dotenv as dict\"\"\"\n if self._dict:\n return self._dict\n\n raw_values = self.parse()\n\n if self.interpolate:\n self._dict = OrderedDict(\n resolve_variables(raw_values, override=self.override)\n )\n else:\n self._dict = OrderedDict(raw_values)\n\n return self._dict\n\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\n with self._get_stream() as stream:\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\n if mapping.key is not None:\n yield mapping.key, mapping.value\n\n def set_as_environment_variables(self) -> bool:\n \"\"\"\n Load the current dotenv as system environment variable.\n \"\"\"\n if not self.dict():\n return False\n\n for k, v in self.dict().items():\n if k in os.environ and not self.override:\n continue\n if v is not None:\n os.environ[k] = v\n\n return True\n\n def get(self, key: str) -> Optional[str]:\n \"\"\" \"\"\"\n data = self.dict()\n\n if key in data:\n return data[key]\n\n if self.verbose:\n logger.warning(\"Key %s not found in %s.\", key, self.dotenv_path)\n\n return None\n\n\ndef get_key(\n dotenv_path: StrPath,\n key_to_get: str,\n encoding: Optional[str] = \"utf-8\",\n) -> Optional[str]:\n \"\"\"\n Get the value of a given key from the given .env.\n\n Returns `None` if the key isn't found or doesn't have a value.\n \"\"\"\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\n\n\n@contextmanager\ndef rewrite(\n path: StrPath,\n encoding: Optional[str],\n) -> Iterator[Tuple[IO[str], IO[str]]]:\n pathlib.Path(path).touch()\n\n with tempfile.NamedTemporaryFile(mode=\"w\", encoding=encoding, delete=False) as dest:\n error = None\n try:\n with open(path, encoding=encoding) as source:\n yield (source, dest)\n except BaseException as err:\n error = err\n\n if error is None:\n shutil.move(dest.name, path)\n else:\n os.unlink(dest.name)\n raise error from None\n\n\ndef set_key(\n dotenv_path: StrPath,\n key_to_set: str,\n value_to_set: str,\n quote_mode: str = \"always\",\n export: bool = False,\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str, str]:\n \"\"\"\n Adds or Updates a key/value to the given .env\n\n If the .env path given doesn't exist, fails instead of risking creating\n an orphan .env somewhere in the filesystem\n \"\"\"\n if quote_mode not in (\"always\", \"auto\", \"never\"):\n raise ValueError(f\"Unknown quote_mode: {quote_mode}\")\n\n quote = quote_mode == \"always\" or (\n quote_mode == \"auto\" and not value_to_set.isalnum()\n )\n\n if quote:\n value_out = \"'{}'\".format(value_to_set.replace(\"'\", \"\\\\'\"))\n else:\n value_out = value_to_set\n if export:\n line_out = f\"export {key_to_set}={value_out}\\n\"\n else:\n line_out = f\"{key_to_set}={value_out}\\n\"\n\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n replaced = False\n missing_newline = False\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_set:\n dest.write(line_out)\n replaced = True\n else:\n dest.write(mapping.original.string)\n missing_newline = not mapping.original.string.endswith(\"\\n\")\n if not replaced:\n if missing_newline:\n dest.write(\"\\n\")\n dest.write(line_out)\n\n return True, key_to_set, value_to_set\n\n\ndef unset_key(\n dotenv_path: StrPath,\n key_to_unset: str,\n quote_mode: str = \"always\",\n encoding: Optional[str] = \"utf-8\",\n) -> Tuple[Optional[bool], str]:\n \"\"\"\n Removes a given key from the given `.env` file.\n\n If the .env path given doesn't exist, fails.\n If the given key doesn't exist in the .env, fails.\n \"\"\"\n if not os.path.exists(dotenv_path):\n logger.warning(\"Can't delete from %s - it doesn't exist.\", dotenv_path)\n return None, key_to_unset\n\n removed = False\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\n if mapping.key == key_to_unset:\n removed = True\n else:\n dest.write(mapping.original.string)\n\n if not removed:\n logger.warning(\n \"Key %s not removed from %s - key doesn't exist.\", key_to_unset, dotenv_path\n )\n return None, key_to_unset\n\n return removed, key_to_unset\n\n\ndef resolve_variables(\n values: Iterable[Tuple[str, Optional[str]]],\n override: bool,\n) -> Mapping[str, Optional[str]]:\n new_values: Dict[str, Optional[str]] = {}\n\n for name, value in values:\n if value is None:\n result = None\n else:\n atoms = parse_variables(value)\n env: Dict[str, Optional[str]] = {}\n if override:\n env.update(os.environ) # type: ignore\n env.update(new_values)\n else:\n env.update(new_values)\n env.update(os.environ) # type: ignore\n result = \"\".join(atom.resolve(env) for atom in atoms)\n\n new_values[name] = result\n\n return new_values\n\n\ndef _walk_to_root(path: str) -> Iterator[str]:\n \"\"\"\n Yield directories starting from the given directory up to the root\n \"\"\"\n if not os.path.exists(path):\n raise IOError(\"Starting path not found\")\n\n if os.path.isfile(path):\n path = os.path.dirname(path)\n\n last_dir = None\n current_dir = os.path.abspath(path)\n while last_dir != current_dir:\n yield current_dir\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\n last_dir, current_dir = current_dir, parent_dir\n\n\ndef find_dotenv(\n filename: str = \".env\",\n raise_error_if_not_found: bool = False,\n usecwd: bool = False,\n) -> str:\n \"\"\"\n Search in increasingly higher folders for the given file\n\n Returns path to the file if found, or an empty string otherwise\n \"\"\"\n\n def _is_interactive():\n \"\"\"Decide whether this is running in a REPL or IPython notebook\"\"\"\n try:\n main = __import__(\"__main__\", None, None, fromlist=[\"__file__\"])\n except ModuleNotFoundError:\n return False\n return not hasattr(main, \"__file__\")\n\n if usecwd or _is_interactive() or getattr(sys, \"frozen\", False):\n # Should work without __file__, e.g. in REPL or IPython notebook.\n path = os.getcwd()\n else:\n # will work for .py files\n frame = sys._getframe()\n current_file = __file__\n\n while frame.f_code.co_filename == current_file or not os.path.exists(\n frame.f_code.co_filename\n ):\n assert frame.f_back is not None\n frame = frame.f_back\n frame_filename = frame.f_code.co_filename\n path = os.path.dirname(os.path.abspath(frame_filename))\n\n for dirname in _walk_to_root(path):\n check_path = os.path.join(dirname, filename)\n if os.path.isfile(check_path):\n return check_path\n\n if raise_error_if_not_found:\n raise IOError(\"File not found\")\n\n return \"\"\n\n\ndef load_dotenv(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n override: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> bool:\n \"\"\"Parse a .env file and then load all the variables found as environment variables.\n\n Parameters:\n dotenv_path: Absolute or relative path to .env file.\n stream: Text stream (such as `io.StringIO`) with .env content, used if\n `dotenv_path` is `None`.\n verbose: Whether to output a warning the .env file is missing.\n override: Whether to override the system environment variables with the variables\n from the `.env` file.\n encoding: Encoding to be used to read the file.\n Returns:\n Bool: True if at least one environment variable is set else False\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file with it's default parameters. If you need to change the default parameters\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\n to this function as `dotenv_path`.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n dotenv = DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=override,\n encoding=encoding,\n )\n return dotenv.set_as_environment_variables()\n\n\ndef dotenv_values(\n dotenv_path: Optional[StrPath] = None,\n stream: Optional[IO[str]] = None,\n verbose: bool = False,\n interpolate: bool = True,\n encoding: Optional[str] = \"utf-8\",\n) -> Dict[str, Optional[str]]:\n \"\"\"\n Parse a .env file and return its content as a dict.\n\n The returned dict will have `None` values for keys without values in the .env file.\n For example, `foo=bar` results in `{\"foo\": \"bar\"}` whereas `foo` alone results in\n `{\"foo\": None}`\n\n Parameters:\n dotenv_path: Absolute or relative path to the .env file.\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\n verbose: Whether to output a warning if the .env file is missing.\n encoding: Encoding to be used to read the file.\n\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\n .env file.\n \"\"\"\n if dotenv_path is None and stream is None:\n dotenv_path = find_dotenv()\n\n return DotEnv(\n dotenv_path=dotenv_path,\n stream=stream,\n verbose=verbose,\n interpolate=interpolate,\n override=True,\n encoding=encoding,\n ).dict()\n\n[end of src/dotenv/main.py]","filename":"src/dotenv/main.py","id":"25"},{"content":"\"\"\"Entry point for cli, enables execution with `python -m dotenv`\"\"\"\n\nfrom .cli import cli\n\nif __name__ == \"__main__\":\n cli()\n\n[end of src/dotenv/__main__.py]","filename":"src/dotenv/__main__.py","id":"26"}],"string":"[\n {\n \"content\": \"site_name: python-dotenv\\nrepo_url: https://github.com/theskumar/python-dotenv\\nedit_uri: \\\"\\\"\\ntheme:\\n name: material\\n palette:\\n primary: green\\n features:\\n - toc.follow\\n - navigation.sections\\n\\nmarkdown_extensions:\\n - mdx_truly_sane_lists\\n\\nplugins:\\n - mkdocstrings:\\n handlers:\\n python:\\n rendering:\\n show_root_heading: yes\\n show_submodules: no\\n separate_signature: yes\\n - search\\nnav:\\n - Home: index.md\\n - Changelog: changelog.md\\n - Contributing: contributing.md\\n - Reference: reference.md\\n - License: license.md\\n\\n[end of mkdocs.yml]\",\n \"filename\": \"mkdocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"black~=22.3.0\\nbumpversion\\nclick\\nflake8>=2.2.3\\nipython\\npytest-cov\\npytest>=3.9\\nsh>=2\\ntox\\ntwine\\nwheel\\n\\n[end of requirements.txt]\",\n \"filename\": \"requirements.txt\",\n \"id\": \"2\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"3\"\n },\n {\n \"content\": \".PHONY: clean-pyc clean-build test\\n\\nclean: clean-build clean-pyc\\n\\nclean-build:\\n\\trm -fr build/\\n\\trm -fr dist/\\n\\trm -fr src/*.egg-info\\n\\nclean-pyc:\\n\\tfind . -name '*.pyc' -exec rm -f {} +\\n\\tfind . -name '*.pyo' -exec rm -f {} +\\n\\tfind . -name '*~' -exec rm -f {} +\\n\\nrelease: sdist\\n\\ttwine check dist/*\\n\\ttwine upload dist/*\\n\\nrelease-test: sdist\\n\\ttwine upload --repository-url https://test.pypi.org/legacy/ dist/*\\n\\nsdist: clean\\n\\tpython setup.py sdist bdist_wheel\\n\\tls -l dist\\n\\ntest:\\n\\tpip install -e .\\n\\tflake8 .\\n\\tpy.test tests/\\n\\ncoverage:\\n\\tcoverage run --source=dotenv --omit='*tests*' -m py.test tests/ -v --tb=native\\n\\tcoverage report\\n\\ncoverage-html: coverage\\n\\tcoverage html\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"4\"\n },\n {\n \"content\": \"mdx_truly_sane_lists~=1.2\\nmkdocs-include-markdown-plugin~=3.3.0\\nmkdocs-material~=8.2.9\\nmkdocstrings[python]~=0.18.1\\nmkdocs~=1.3.0\\n\\n[end of requirements-docs.txt]\",\n \"filename\": \"requirements-docs.txt\",\n \"id\": \"5\"\n },\n {\n \"content\": \"include LICENSE *.md *.yml *.toml\\n\\ninclude tox.ini\\nrecursive-include docs *.md\\nrecursive-include tests *.py\\n\\ninclude .bumpversion.cfg\\ninclude .coveragerc\\ninclude .editorconfig\\ninclude Makefile\\ninclude requirements.txt\\ninclude requirements-docs.txt\\ninclude src/dotenv/py.typed\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# see: http://editorconfig.org\\n\\nroot = true\\n\\n[*]\\ncharset = utf-8\\nend_of_line = lf\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\n\\n[*.{py,rst,ini}]\\nindent_style = space\\nindent_size = 4\\n\\n[*.yml]\\nindent_style = space\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"8\"\n },\n {\n \"content\": \"from setuptools import setup\\n\\n\\ndef read_files(files):\\n data = []\\n for file in files:\\n with open(file, encoding=\\\"utf-8\\\") as f:\\n data.append(f.read())\\n return \\\"\\\\n\\\".join(data)\\n\\n\\nlong_description = read_files([\\\"README.md\\\", \\\"CHANGELOG.md\\\"])\\n\\nmeta = {}\\nwith open(\\\"./src/dotenv/version.py\\\", encoding=\\\"utf-8\\\") as f:\\n exec(f.read(), meta)\\n\\nsetup(\\n name=\\\"python-dotenv\\\",\\n description=\\\"Read key-value pairs from a .env file and set them as environment variables\\\",\\n long_description=long_description,\\n long_description_content_type=\\\"text/markdown\\\",\\n version=meta[\\\"__version__\\\"],\\n author=\\\"Saurabh Kumar\\\",\\n author_email=\\\"me+github@saurabh-kumar.com\\\",\\n url=\\\"https://github.com/theskumar/python-dotenv\\\",\\n keywords=[\\n \\\"environment variables\\\",\\n \\\"deployments\\\",\\n \\\"settings\\\",\\n \\\"env\\\",\\n \\\"dotenv\\\",\\n \\\"configurations\\\",\\n \\\"python\\\",\\n ],\\n packages=[\\\"dotenv\\\"],\\n package_dir={\\\"\\\": \\\"src\\\"},\\n package_data={\\n \\\"dotenv\\\": [\\\"py.typed\\\"],\\n },\\n python_requires=\\\">=3.9\\\",\\n extras_require={\\n \\\"cli\\\": [\\n \\\"click>=5.0\\\",\\n ],\\n },\\n entry_points={\\n \\\"console_scripts\\\": [\\n \\\"dotenv=dotenv.__main__:cli\\\",\\n ],\\n },\\n license=\\\"BSD-3-Clause\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.9\\\",\\n \\\"Programming Language :: Python :: 3.10\\\",\\n \\\"Programming Language :: Python :: 3.11\\\",\\n \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: Implementation :: PyPy\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Topic :: System :: Systems Administration\\\",\\n \\\"Topic :: Utilities\\\",\\n \\\"Environment :: Web Environment\\\",\\n ],\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of CONTRIBUTING.md]\",\n \"filename\": \"CONTRIBUTING.md\",\n \"id\": \"10\"\n },\n {\n \"content\": \"[tox]\\nenvlist = lint,py{39,310,311,312,313},pypy3,manifest,coverage-report\\n\\n[gh-actions]\\npython =\\n 3.9: py39\\n 3.10: py310\\n 3.11: py311\\n 3.12: py312\\n 3.13: py313, lint, manifest\\n pypy-3.9: pypy3\\n\\n[testenv]\\ndeps =\\n pytest\\n pytest-cov\\n sh >= 2.0.2, <3\\n click\\n py{39,310,311,312,313,pypy3}: ipython\\ncommands = pytest --cov --cov-report=term-missing --cov-config setup.cfg {posargs}\\ndepends =\\n py{39,310,311,312,313},pypy3: coverage-clean\\n coverage-report: py{39,310,311,312,313},pypy3\\n\\n[testenv:lint]\\nskip_install = true\\ndeps =\\n flake8\\n mypy\\ncommands =\\n flake8 src tests\\n mypy --python-version=3.13 src tests\\n mypy --python-version=3.12 src tests\\n mypy --python-version=3.11 src tests\\n mypy --python-version=3.10 src tests\\n mypy --python-version=3.9 src tests\\n\\n[testenv:manifest]\\ndeps = check-manifest\\nskip_install = true\\ncommands = check-manifest\\n\\n[testenv:coverage-clean]\\ndeps = coverage\\nskip_install = true\\ncommands = coverage erase\\n\\n[testenv:coverage-report]\\ndeps = coverage\\nskip_install = true\\ncommands =\\n coverage report\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"11\"\n },\n {\n \"content\": \"[bumpversion]\\ncurrent_version = 1.0.1\\ncommit = True\\ntag = True\\n\\n[bumpversion:file:src/dotenv/version.py]\\n\\n[flake8]\\nmax-line-length = 120\\nexclude = .tox,.git,docs,venv,.venv,build\\n\\n[mypy]\\ncheck_untyped_defs = true\\nignore_missing_imports = true\\n\\n[metadata]\\ndescription_file = README.md\\n\\n[tool:pytest]\\ntestpaths = tests\\n\\n[coverage:run]\\nrelative_files = True\\nsource = dotenv\\n\\n[coverage:paths]\\nsource =\\n\\tsrc/dotenv\\n\\t.tox/*/lib/python*/site-packages/dotenv\\n\\t.tox/pypy*/site-packages/dotenv\\n\\n[coverage:report]\\nshow_missing = True\\ninclude = */site-packages/dotenv/*\\nexclude_lines =\\n\\tif IS_TYPE_CHECKING:\\n\\tpragma: no cover\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dotenv-rw), 2013, Jacob Kaplan-Moss (django-dotenv)\\n\\nRedistribution and use in source and binary forms, with or without modification,\\nare permitted provided that the following conditions are met:\\n\\n- Redistributions of source code must retain the above copyright notice,\\n this list of conditions and the following disclaimer.\\n\\n- Redistributions in binary form must reproduce the above copyright notice,\\n this list of conditions and the following disclaimer in the documentation\\n and/or other materials provided with the distribution.\\n\\n- Neither the name of django-dotenv nor the names of its contributors\\n may be used to endorse or promote products derived from this software\\n without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of docs/license.md]\",\n \"filename\": \"docs/license.md\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# ::: dotenv\\n\\n\\n[end of docs/reference.md]\",\n \"filename\": \"docs/reference.md\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# Changelog\\n\\nAll notable changes to this project will be documented in this file.\\n\\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this\\nproject adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\\n\\n## [Unreleased]\\n\\n- Drop support for Python 3.8\\n- Add support for python 3.13\\n- Enhance `dotenv run`, switch to `execvpe` for better resource management and signal handling ([#523]) by [@eekstunt]\\n\\n## [1.0.1] - 2024-01-23\\n\\n**Fixed**\\n\\n* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])\\n* Allow modules using `load_dotenv` to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])\\n* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])\\n\\n**Misc**\\n* Use pathlib.Path in tests ([#466] by [@eumiro])\\n* Fix year in release date in changelog.md ([#454] by [@jankislinger])\\n* Use https in README links ([#474] by [@Nicals])\\n\\n## [1.0.0] - 2023-02-24\\n\\n**Fixed**\\n\\n* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])\\n* Handle situations where the cwd does not exist. (#446 by [@jctanner])\\n\\n## [0.21.1] - 2023-01-21\\n\\n**Added**\\n\\n* Use Python 3.11 non-beta in CI (#438 by [@bbc2])\\n* Modernize variables code (#434 by [@Nougat-Waffle])\\n* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])\\n* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])\\n* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])\\n* Updated License to align with BSD OSI template (#433 by [@lsmith77])\\n\\n\\n**Fixed**\\n\\n* Fix Out-of-scope error when \\\"dest\\\" variable is undefined (#413 by [@theGOTOguy])\\n* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])\\n* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])\\n\\n## [0.21.0] - 2022-09-03\\n\\n**Added**\\n\\n* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])\\n* `load_dotenv` function now returns `False`. (#388 by [@larsks])\\n* CLI: add --format= option to list command. (#407 by [@sammck])\\n\\n**Fixed**\\n\\n* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])\\n* Use `open` instead of `io.open`. (#389 by [@rabinadk1])\\n* Improve documentation for variables without a value (#390 by [@bbc2])\\n* Add `parse_it` to Related Projects (#410 by [@naorlivne])\\n* Update README.md (#415 by [@harveer07])\\n* Improve documentation with direct use of MkDocs (#398 by [@bbc2])\\n\\n## [0.20.0] - 2022-03-24\\n\\n**Added**\\n\\n- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.\\n (#379 by [@bbc2])\\n\\n**Fixed**\\n\\n- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by\\n [@mgorny]).\\n- Don't build universal wheels (#387 by [@bbc2]).\\n\\n## [0.19.2] - 2021-11-11\\n\\n**Fixed**\\n\\n- In `set_key`, add missing newline character before new entry if necessary. (#361 by\\n [@bbc2])\\n\\n## [0.19.1] - 2021-08-09\\n\\n**Added**\\n\\n- Add support for Python 3.10. (#359 by [@theskumar])\\n\\n## [0.19.0] - 2021-07-24\\n\\n**Changed**\\n\\n- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341\\n by [@bbc2]).\\n\\n**Added**\\n\\n- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,\\n os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).\\n- The `stream` argument of `load_dotenv` and `dotenv_values` can now be a text stream\\n (`IO[str]`), which includes values like `io.StringIO(\\\"foo\\\")` and `open(\\\"file.env\\\",\\n \\\"r\\\")` (#348 by [@bbc2]).\\n\\n## [0.18.0] - 2021-06-20\\n\\n**Changed**\\n\\n- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in\\n `set_key` (#330 by [@bbc2]).\\n- When writing a value to a .env file with `set_key` or `dotenv set <key> <value>` (#330\\n by [@bbc2]):\\n - Use single quotes instead of double quotes.\\n - Don't strip surrounding quotes.\\n - In `auto` mode, don't add quotes if the value is only made of alphanumeric characters\\n (as determined by `string.isalnum`).\\n\\n## [0.17.1] - 2021-04-29\\n\\n**Fixed**\\n\\n- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).\\n\\n## [0.17.0] - 2021-04-02\\n\\n**Changed**\\n\\n- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).\\n\\n**Added**\\n\\n- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).\\n\\n## [0.16.0] - 2021-03-27\\n\\n**Changed**\\n\\n- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is\\n now `\\\"utf-8\\\"` instead of `None` (#306 by [@bbc2]).\\n- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).\\n\\n## [0.15.0] - 2020-10-28\\n\\n**Added**\\n\\n- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by\\n [@jadutter]).\\n\\n**Changed**\\n\\n- Make `set` command create the `.env` file in the current directory if no `.env` file was\\n found (#270 by [@jadutter]).\\n\\n**Fixed**\\n\\n- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).\\n- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).\\n- Fix parsing of unquoted values containing several adjacent space or tab characters\\n (#277 by [@bbc2], review by [@x-yuri]).\\n\\n## [0.14.0] - 2020-07-03\\n\\n**Changed**\\n\\n- Privilege definition in file over the environment in variable expansion (#256 by\\n [@elbehery95]).\\n\\n**Fixed**\\n\\n- Improve error message for when file isn't found (#245 by [@snobu]).\\n- Use HTTPS URL in package meta data (#251 by [@ekohl]).\\n\\n## [0.13.0] - 2020-04-16\\n\\n**Added**\\n\\n- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).\\n\\n## [0.12.0] - 2020-02-28\\n\\n**Changed**\\n\\n- Use current working directory to find `.env` when bundled by PyInstaller (#213 by\\n [@gergelyk]).\\n\\n**Fixed**\\n\\n- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).\\n- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).\\n- Remove warning when last line is empty (#238 by [@bbc2]).\\n\\n## [0.11.0] - 2020-02-07\\n\\n**Added**\\n\\n- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation\\n (#232 by [@ulyssessouza]).\\n\\n**Changed**\\n\\n- Use logging instead of warnings (#231 by [@bbc2]).\\n\\n**Fixed**\\n\\n- Fix installation in non-UTF-8 environments (#225 by [@altendky]).\\n- Fix PyPI classifiers (#228 by [@bbc2]).\\n\\n## [0.10.5] - 2020-01-19\\n\\n**Fixed**\\n\\n- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):\\n - Don't print warning when key has no value.\\n - Reject more malformed lines (e.g. \\\"A: B\\\", \\\"a='b',c\\\").\\n- Fix handling of lines with just a comment (#224 by [@bbc2]).\\n\\n## [0.10.4] - 2020-01-17\\n\\n**Added**\\n\\n- Make typing optional (#179 by [@techalchemy]).\\n- Print a warning on malformed line (#211 by [@bbc2]).\\n- Support keys without a value (#220 by [@ulyssessouza]).\\n\\n## 0.10.3\\n\\n- Improve interactive mode detection ([@andrewsmith])([#183]).\\n- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).\\n - Interpret escapes as control characters only in double-quoted strings.\\n - Interpret `#` as start of comment only if preceded by whitespace.\\n\\n## 0.10.2\\n\\n- Add type hints and expose them to users ([@qnighy])([#172])\\n- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`\\n ([@theskumar])([@earlbread])([#161])\\n- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])\\n- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])\\n\\n## 0.10.1\\n- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])\\n\\n## 0.10.0\\n\\n- Add support for UTF-8 in unquoted values ([@bbc2])([#148])\\n- Add support for trailing comments ([@bbc2])([#148])\\n- Add backslashes support in values ([@bbc2])([#148])\\n- Add support for newlines in values ([@bbc2])([#148])\\n- Force environment variables to str with Python2 on Windows ([@greyli])\\n- Drop Python 3.3 support ([@greyli])\\n- Fix stderr/-out/-in redirection ([@venthur])\\n\\n\\n## 0.9.0\\n\\n- Add `--version` parameter to cli ([@venthur])\\n- Enable loading from current directory ([@cjauvin])\\n- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])\\n\\n## 0.8.1\\n\\n- Add tests for docs ([@Flimm])\\n- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])\\n\\n## 0.8.0\\n\\n- `set_key` and `unset_key` only modified the affected file instead of\\n parsing and re-writing file, this causes comments and other file\\n entact as it is.\\n- Add support for `export` prefix in the line.\\n- Internal refractoring ([@theskumar])\\n- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])\\n\\n## 0.7.1\\n\\n- Remove hard dependency on iPython ([@theskumar])\\n\\n## 0.7.0\\n\\n- Add support to override system environment variable via .env.\\n ([@milonimrod](https://github.com/milonimrod))\\n ([\\\\#63](https://github.com/theskumar/python-dotenv/issues/63))\\n- Disable \\\".env not found\\\" warning by default\\n ([@maxkoryukov](https://github.com/maxkoryukov))\\n ([\\\\#57](https://github.com/theskumar/python-dotenv/issues/57))\\n\\n## 0.6.5\\n\\n- Add support for special characters `\\\\`.\\n ([@pjona](https://github.com/pjona))\\n ([\\\\#60](https://github.com/theskumar/python-dotenv/issues/60))\\n\\n## 0.6.4\\n\\n- Fix issue with single quotes ([@Flimm])\\n ([\\\\#52](https://github.com/theskumar/python-dotenv/issues/52))\\n\\n## 0.6.3\\n\\n- Handle unicode exception in setup.py\\n ([\\\\#46](https://github.com/theskumar/python-dotenv/issues/46))\\n\\n## 0.6.2\\n\\n- Fix dotenv list command ([@ticosax](https://github.com/ticosax))\\n- Add iPython Support\\n ([@tillahoffmann](https://github.com/tillahoffmann))\\n\\n## 0.6.0\\n\\n- Drop support for Python 2.6\\n- Handle escaped characters and newlines in quoted values. (Thanks\\n [@iameugenejo](https://github.com/iameugenejo))\\n- Remove any spaces around unquoted key/value. (Thanks\\n [@paulochf](https://github.com/paulochf))\\n- Added POSIX variable expansion. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla))\\n\\n## 0.5.1\\n\\n- Fix `find_dotenv` - it now start search from the file where this\\n function is called from.\\n\\n## 0.5.0\\n\\n- Add `find_dotenv` method that will try to find a `.env` file.\\n (Thanks [@isms](https://github.com/isms))\\n\\n## 0.4.0\\n\\n- cli: Added `-q/--quote` option to control the behaviour of quotes\\n around values in `.env`. (Thanks\\n [@hugochinchilla](https://github.com/hugochinchilla)).\\n- Improved test coverage.\\n\\n[#78]: https://github.com/theskumar/python-dotenv/issues/78\\n[#121]: https://github.com/theskumar/python-dotenv/issues/121\\n[#148]: https://github.com/theskumar/python-dotenv/issues/148\\n[#158]: https://github.com/theskumar/python-dotenv/issues/158\\n[#170]: https://github.com/theskumar/python-dotenv/issues/170\\n[#172]: https://github.com/theskumar/python-dotenv/issues/172\\n[#176]: https://github.com/theskumar/python-dotenv/issues/176\\n[#183]: https://github.com/theskumar/python-dotenv/issues/183\\n[#359]: https://github.com/theskumar/python-dotenv/issues/359\\n[#469]: https://github.com/theskumar/python-dotenv/issues/469\\n[#456]: https://github.com/theskumar/python-dotenv/issues/456\\n[#466]: https://github.com/theskumar/python-dotenv/issues/466\\n[#454]: https://github.com/theskumar/python-dotenv/issues/454\\n[#474]: https://github.com/theskumar/python-dotenv/issues/474\\n[#523]: https://github.com/theskumar/python-dotenv/issues/523\\n\\n[@alanjds]: https://github.com/alanjds\\n[@altendky]: https://github.com/altendky\\n[@andrewsmith]: https://github.com/andrewsmith\\n[@asyncee]: https://github.com/asyncee\\n[@bbc2]: https://github.com/bbc2\\n[@befeleme]: https://github.com/befeleme\\n[@cjauvin]: https://github.com/cjauvin\\n[@eaf]: https://github.com/eaf\\n[@earlbread]: https://github.com/earlbread\\n[@eekstunt]: https://github.com/eekstunt\\n[@eggplants]: https://github.com/@eggplants\\n[@ekohl]: https://github.com/ekohl\\n[@elbehery95]: https://github.com/elbehery95\\n[@eumiro]: https://github.com/eumiro\\n[@Flimm]: https://github.com/Flimm\\n[@freddyaboulton]: https://github.com/freddyaboulton\\n[@gergelyk]: https://github.com/gergelyk\\n[@gongqingkui]: https://github.com/gongqingkui\\n[@greyli]: https://github.com/greyli\\n[@harveer07]: https://github.com/@harveer07\\n[@jadutter]: https://github.com/jadutter\\n[@jankislinger]: https://github.com/jankislinger\\n[@jctanner]: https://github.com/jctanner\\n[@larsks]: https://github.com/@larsks\\n[@lsmith77]: https://github.com/lsmith77\\n[@mgorny]: https://github.com/mgorny\\n[@naorlivne]: https://github.com/@naorlivne\\n[@Nicals]: https://github.com/Nicals\\n[@Nougat-Waffle]: https://github.com/Nougat-Waffle\\n[@qnighy]: https://github.com/qnighy\\n[@Qwerty-133]: https://github.com/Qwerty-133\\n[@rabinadk1]: https://github.com/@rabinadk1\\n[@sammck]: https://github.com/@sammck\\n[@samwyma]: https://github.com/samwyma\\n[@snobu]: https://github.com/snobu\\n[@techalchemy]: https://github.com/techalchemy\\n[@theGOTOguy]: https://github.com/theGOTOguy\\n[@theskumar]: https://github.com/theskumar\\n[@ulyssessouza]: https://github.com/ulyssessouza\\n[@venthur]: https://github.com/venthur\\n[@x-yuri]: https://github.com/x-yuri\\n[@yannham]: https://github.com/yannham\\n[@zueve]: https://github.com/zueve\\n\\n\\n[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD\\n[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1\\n[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0\\n[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1\\n[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0\\n[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0\\n[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2\\n[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1\\n[0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0\\n[0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0\\n[0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1\\n[0.17.0]: https://github.com/theskumar/python-dotenv/compare/v0.16.0...v0.17.0\\n[0.16.0]: https://github.com/theskumar/python-dotenv/compare/v0.15.0...v0.16.0\\n[0.15.0]: https://github.com/theskumar/python-dotenv/compare/v0.14.0...v0.15.0\\n[0.14.0]: https://github.com/theskumar/python-dotenv/compare/v0.13.0...v0.14.0\\n[0.13.0]: https://github.com/theskumar/python-dotenv/compare/v0.12.0...v0.13.0\\n[0.12.0]: https://github.com/theskumar/python-dotenv/compare/v0.11.0...v0.12.0\\n[0.11.0]: https://github.com/theskumar/python-dotenv/compare/v0.10.5...v0.11.0\\n[0.10.5]: https://github.com/theskumar/python-dotenv/compare/v0.10.4...v0.10.5\\n[0.10.4]: https://github.com/theskumar/python-dotenv/compare/v0.10.3...v0.10.4\\n\\n[end of docs/changelog.md]\",\n \"filename\": \"docs/changelog.md\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# python-dotenv\\n\\n[![Build Status][build_status_badge]][build_status_link]\\n[![PyPI version][pypi_badge]][pypi_link]\\n\\npython-dotenv reads key-value pairs from a `.env` file and can set them as environment\\nvariables. It helps in the development of applications following the\\n[12-factor](https://12factor.net/) principles.\\n\\n- [Getting Started](#getting-started)\\n- [Other Use Cases](#other-use-cases)\\n * [Load configuration without altering the environment](#load-configuration-without-altering-the-environment)\\n * [Parse configuration as a stream](#parse-configuration-as-a-stream)\\n * [Load .env files in IPython](#load-env-files-in-ipython)\\n- [Command-line Interface](#command-line-interface)\\n- [File format](#file-format)\\n * [Multiline values](#multiline-values)\\n * [Variable expansion](#variable-expansion)\\n- [Related Projects](#related-projects)\\n- [Acknowledgements](#acknowledgements)\\n\\n## Getting Started\\n\\n```shell\\npip install python-dotenv\\n```\\n\\nIf your application takes its configuration from environment variables, like a 12-factor\\napplication, launching it in development is not very practical because you have to set\\nthose environment variables yourself.\\n\\nTo help you with that, you can add python-dotenv to your application to make it load the\\nconfiguration from a `.env` file when it is present (e.g. in development) while remaining\\nconfigurable via the environment:\\n\\n```python\\nfrom dotenv import load_dotenv\\n\\nload_dotenv() # take environment variables\\n\\n# Code of your application, which uses environment variables (e.g. from `os.environ` or\\n# `os.getenv`) as if they came from the actual environment.\\n```\\n\\nBy default, `load_dotenv` doesn't override existing environment variables and looks for a `.env` file in same directory as python script or searches for it incrementally higher up.\\n\\nTo configure the development environment, add a `.env` in the root directory of your\\nproject:\\n\\n```\\n.\\n├── .env\\n└── foo.py\\n```\\n\\nThe syntax of `.env` files supported by python-dotenv is similar to that of Bash:\\n\\n```bash\\n# Development settings\\nDOMAIN=example.org\\nADMIN_EMAIL=admin@${DOMAIN}\\nROOT_URL=${DOMAIN}/app\\n```\\n\\nIf you use variables in values, ensure they are surrounded with `{` and `}`, like\\n`${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.\\n\\nYou will probably want to add `.env` to your `.gitignore`, especially if it contains\\nsecrets like a password.\\n\\nSee the section \\\"File format\\\" below for more information about what you can write in a\\n`.env` file.\\n\\n## Other Use Cases\\n\\n### Load configuration without altering the environment\\n\\nThe function `dotenv_values` works more or less the same way as `load_dotenv`, except it\\ndoesn't touch the environment, it just returns a `dict` with the values parsed from the\\n`.env` file.\\n\\n```python\\nfrom dotenv import dotenv_values\\n\\nconfig = dotenv_values(\\\".env\\\") # config = {\\\"USER\\\": \\\"foo\\\", \\\"EMAIL\\\": \\\"foo@example.org\\\"}\\n```\\n\\nThis notably enables advanced configuration management:\\n\\n```python\\nimport os\\nfrom dotenv import dotenv_values\\n\\nconfig = {\\n **dotenv_values(\\\".env.shared\\\"), # load shared development variables\\n **dotenv_values(\\\".env.secret\\\"), # load sensitive variables\\n **os.environ, # override loaded values with environment variables\\n}\\n```\\n\\n### Parse configuration as a stream\\n\\n`load_dotenv` and `dotenv_values` accept [streams][python_streams] via their `stream`\\nargument. It is thus possible to load the variables from sources other than the\\nfilesystem (e.g. the network).\\n\\n```python\\nfrom io import StringIO\\n\\nfrom dotenv import load_dotenv\\n\\nconfig = StringIO(\\\"USER=foo\\\\nEMAIL=foo@example.org\\\")\\nload_dotenv(stream=config)\\n```\\n\\n### Load .env files in IPython\\n\\nYou can use dotenv in IPython. By default, it will use `find_dotenv` to search for a\\n`.env` file:\\n\\n```python\\n%load_ext dotenv\\n%dotenv\\n```\\n\\nYou can also specify a path:\\n\\n```python\\n%dotenv relative/or/absolute/path/to/.env\\n```\\n\\nOptional flags:\\n\\n- `-o` to override existing variables.\\n- `-v` for increased verbosity.\\n\\n## Command-line Interface\\n\\nA CLI interface `dotenv` is also included, which helps you manipulate the `.env` file\\nwithout manually opening it.\\n\\n```shell\\n$ pip install \\\"python-dotenv[cli]\\\"\\n$ dotenv set USER foo\\n$ dotenv set EMAIL foo@example.org\\n$ dotenv list\\nUSER=foo\\nEMAIL=foo@example.org\\n$ dotenv list --format=json\\n{\\n \\\"USER\\\": \\\"foo\\\",\\n \\\"EMAIL\\\": \\\"foo@example.org\\\"\\n}\\n$ dotenv run -- python foo.py\\n```\\n\\nRun `dotenv --help` for more information about the options and subcommands.\\n\\n## File format\\n\\nThe format is not formally specified and still improves over time. That being said,\\n`.env` files should mostly look like Bash files.\\n\\nKeys can be unquoted or single-quoted. Values can be unquoted, single- or double-quoted.\\nSpaces before and after keys, equal signs, and values are ignored. Values can be followed\\nby a comment. Lines can start with the `export` directive, which does not affect their\\ninterpretation.\\n\\nAllowed escape sequences:\\n\\n- in single-quoted values: `\\\\\\\\`, `\\\\'`\\n- in double-quoted values: `\\\\\\\\`, `\\\\'`, `\\\\\\\"`, `\\\\a`, `\\\\b`, `\\\\f`, `\\\\n`, `\\\\r`, `\\\\t`, `\\\\v`\\n\\n### Multiline values\\n\\nIt is possible for single- or double-quoted values to span multiple lines. The following\\nexamples are equivalent:\\n\\n```bash\\nFOO=\\\"first line\\nsecond line\\\"\\n```\\n\\n```bash\\nFOO=\\\"first line\\\\nsecond line\\\"\\n```\\n\\n### Variable without a value\\n\\nA variable can have no value:\\n\\n```bash\\nFOO\\n```\\n\\nIt results in `dotenv_values` associating that variable name with the value `None` (e.g.\\n`{\\\"FOO\\\": None}`. `load_dotenv`, on the other hand, simply ignores such variables.\\n\\nThis shouldn't be confused with `FOO=`, in which case the variable is associated with the\\nempty string.\\n\\n### Variable expansion\\n\\npython-dotenv can interpolate variables using POSIX variable expansion.\\n\\nWith `load_dotenv(override=True)` or `dotenv_values()`, the value of a variable is the\\nfirst of the values defined in the following list:\\n\\n- Value of that variable in the `.env` file.\\n- Value of that variable in the environment.\\n- Default value, if provided.\\n- Empty string.\\n\\nWith `load_dotenv(override=False)`, the value of a variable is the first of the values\\ndefined in the following list:\\n\\n- Value of that variable in the environment.\\n- Value of that variable in the `.env` file.\\n- Default value, if provided.\\n- Empty string.\\n\\n## Related Projects\\n\\n- [Honcho](https://github.com/nickstenning/honcho) - For managing\\n Procfile-based applications.\\n- [django-dotenv](https://github.com/jpadilla/django-dotenv)\\n- [django-environ](https://github.com/joke2k/django-environ)\\n- [django-environ-2](https://github.com/sergeyklay/django-environ-2)\\n- [django-configuration](https://github.com/jezdez/django-configurations)\\n- [dump-env](https://github.com/sobolevn/dump-env)\\n- [environs](https://github.com/sloria/environs)\\n- [dynaconf](https://github.com/rochacbruno/dynaconf)\\n- [parse_it](https://github.com/naorlivne/parse_it)\\n- [python-decouple](https://github.com/HBNetwork/python-decouple)\\n\\n## Acknowledgements\\n\\nThis project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and\\n[Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not have been possible\\nwithout the support of these [awesome\\npeople](https://github.com/theskumar/python-dotenv/graphs/contributors).\\n\\n[build_status_badge]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml/badge.svg\\n[build_status_link]: https://github.com/theskumar/python-dotenv/actions/workflows/test.yml\\n[pypi_badge]: https://badge.fury.io/py/python-dotenv.svg\\n[pypi_link]: https://badge.fury.io/py/python-dotenv\\n[python_streams]: https://docs.python.org/3/library/io.html\\n\\n[end of docs/index.md]\",\n \"filename\": \"docs/index.md\",\n \"id\": \"16\"\n },\n {\n \"content\": \"Contributing\\n============\\n\\nAll the contributions are welcome! Please open [an\\nissue](https://github.com/theskumar/python-dotenv/issues/new) or send us\\na pull request.\\n\\nExecuting the tests:\\n\\n $ pip install -r requirements.txt\\n $ pip install -e .\\n $ flake8\\n $ pytest\\n\\nor with [tox](https://pypi.org/project/tox/) installed:\\n\\n $ tox\\n\\n\\nDocumentation is published with [mkdocs]():\\n\\n```shell\\n$ pip install -r requirements-docs.txt\\n$ pip install -e .\\n$ mkdocs serve\\n```\\n\\nOpen http://127.0.0.1:8000/ to view the documentation locally.\\n\\n\\n[end of docs/contributing.md]\",\n \"filename\": \"docs/contributing.md\",\n \"id\": \"17\"\n },\n {\n \"content\": \"__version__ = \\\"1.0.1\\\"\\n\\n[end of src/dotenv/version.py]\",\n \"filename\": \"src/dotenv/version.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"import re\\nfrom abc import ABCMeta, abstractmethod\\nfrom typing import Iterator, Mapping, Optional, Pattern\\n\\n_posix_variable: Pattern[str] = re.compile(\\n r\\\"\\\"\\\"\\n \\\\$\\\\{\\n (?P<name>[^\\\\}:]*)\\n (?::-\\n (?P<default>[^\\\\}]*)\\n )?\\n \\\\}\\n \\\"\\\"\\\",\\n re.VERBOSE,\\n)\\n\\n\\nclass Atom(metaclass=ABCMeta):\\n def __ne__(self, other: object) -> bool:\\n result = self.__eq__(other)\\n if result is NotImplemented:\\n return NotImplemented\\n return not result\\n\\n @abstractmethod\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str: ...\\n\\n\\nclass Literal(Atom):\\n def __init__(self, value: str) -> None:\\n self.value = value\\n\\n def __repr__(self) -> str:\\n return f\\\"Literal(value={self.value})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return self.value == other.value\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.value))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n return self.value\\n\\n\\nclass Variable(Atom):\\n def __init__(self, name: str, default: Optional[str]) -> None:\\n self.name = name\\n self.default = default\\n\\n def __repr__(self) -> str:\\n return f\\\"Variable(name={self.name}, default={self.default})\\\"\\n\\n def __eq__(self, other: object) -> bool:\\n if not isinstance(other, self.__class__):\\n return NotImplemented\\n return (self.name, self.default) == (other.name, other.default)\\n\\n def __hash__(self) -> int:\\n return hash((self.__class__, self.name, self.default))\\n\\n def resolve(self, env: Mapping[str, Optional[str]]) -> str:\\n default = self.default if self.default is not None else \\\"\\\"\\n result = env.get(self.name, default)\\n return result if result is not None else \\\"\\\"\\n\\n\\ndef parse_variables(value: str) -> Iterator[Atom]:\\n cursor = 0\\n\\n for match in _posix_variable.finditer(value):\\n (start, end) = match.span()\\n name = match[\\\"name\\\"]\\n default = match[\\\"default\\\"]\\n\\n if start > cursor:\\n yield Literal(value=value[cursor:start])\\n\\n yield Variable(name=name, default=default)\\n cursor = end\\n\\n length = len(value)\\n if cursor < length:\\n yield Literal(value=value[cursor:length])\\n\\n[end of src/dotenv/variables.py]\",\n \"filename\": \"src/dotenv/variables.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from typing import Any, Optional\\n\\nfrom .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,\\n unset_key)\\n\\n\\ndef load_ipython_extension(ipython: Any) -> None:\\n from .ipython import load_ipython_extension\\n load_ipython_extension(ipython)\\n\\n\\ndef get_cli_string(\\n path: Optional[str] = None,\\n action: Optional[str] = None,\\n key: Optional[str] = None,\\n value: Optional[str] = None,\\n quote: Optional[str] = None,\\n):\\n \\\"\\\"\\\"Returns a string suitable for running as a shell script.\\n\\n Useful for converting a arguments passed to a fabric task\\n to be passed to a `local` or `run` command.\\n \\\"\\\"\\\"\\n command = ['dotenv']\\n if quote:\\n command.append(f'-q {quote}')\\n if path:\\n command.append(f'-f {path}')\\n if action:\\n command.append(action)\\n if key:\\n command.append(key)\\n if value:\\n if ' ' in value:\\n command.append(f'\\\"{value}\\\"')\\n else:\\n command.append(value)\\n\\n return ' '.join(command).strip()\\n\\n\\n__all__ = ['get_cli_string',\\n 'load_dotenv',\\n 'dotenv_values',\\n 'get_key',\\n 'set_key',\\n 'unset_key',\\n 'find_dotenv',\\n 'load_ipython_extension']\\n\\n[end of src/dotenv/__init__.py]\",\n \"filename\": \"src/dotenv/__init__.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"import codecs\\nimport re\\nfrom typing import (IO, Iterator, Match, NamedTuple, Optional, # noqa:F401\\n Pattern, Sequence, Tuple)\\n\\n\\ndef make_regex(string: str, extra_flags: int = 0) -> Pattern[str]:\\n return re.compile(string, re.UNICODE | extra_flags)\\n\\n\\n_newline = make_regex(r\\\"(\\\\r\\\\n|\\\\n|\\\\r)\\\")\\n_multiline_whitespace = make_regex(r\\\"\\\\s*\\\", extra_flags=re.MULTILINE)\\n_whitespace = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*\\\")\\n_export = make_regex(r\\\"(?:export[^\\\\S\\\\r\\\\n]+)?\\\")\\n_single_quoted_key = make_regex(r\\\"'([^']+)'\\\")\\n_unquoted_key = make_regex(r\\\"([^=\\\\#\\\\s]+)\\\")\\n_equal_sign = make_regex(r\\\"(=[^\\\\S\\\\r\\\\n]*)\\\")\\n_single_quoted_value = make_regex(r\\\"'((?:\\\\\\\\'|[^'])*)'\\\")\\n_double_quoted_value = make_regex(r'\\\"((?:\\\\\\\\\\\"|[^\\\"])*)\\\"')\\n_unquoted_value = make_regex(r\\\"([^\\\\r\\\\n]*)\\\")\\n_comment = make_regex(r\\\"(?:[^\\\\S\\\\r\\\\n]*#[^\\\\r\\\\n]*)?\\\")\\n_end_of_line = make_regex(r\\\"[^\\\\S\\\\r\\\\n]*(?:\\\\r\\\\n|\\\\n|\\\\r|$)\\\")\\n_rest_of_line = make_regex(r\\\"[^\\\\r\\\\n]*(?:\\\\r|\\\\n|\\\\r\\\\n)?\\\")\\n_double_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\'\\\\\\\"abfnrtv]\\\")\\n_single_quote_escapes = make_regex(r\\\"\\\\\\\\[\\\\\\\\']\\\")\\n\\n\\nclass Original(NamedTuple):\\n string: str\\n line: int\\n\\n\\nclass Binding(NamedTuple):\\n key: Optional[str]\\n value: Optional[str]\\n original: Original\\n error: bool\\n\\n\\nclass Position:\\n def __init__(self, chars: int, line: int) -> None:\\n self.chars = chars\\n self.line = line\\n\\n @classmethod\\n def start(cls) -> \\\"Position\\\":\\n return cls(chars=0, line=1)\\n\\n def set(self, other: \\\"Position\\\") -> None:\\n self.chars = other.chars\\n self.line = other.line\\n\\n def advance(self, string: str) -> None:\\n self.chars += len(string)\\n self.line += len(re.findall(_newline, string))\\n\\n\\nclass Error(Exception):\\n pass\\n\\n\\nclass Reader:\\n def __init__(self, stream: IO[str]) -> None:\\n self.string = stream.read()\\n self.position = Position.start()\\n self.mark = Position.start()\\n\\n def has_next(self) -> bool:\\n return self.position.chars < len(self.string)\\n\\n def set_mark(self) -> None:\\n self.mark.set(self.position)\\n\\n def get_marked(self) -> Original:\\n return Original(\\n string=self.string[self.mark.chars:self.position.chars],\\n line=self.mark.line,\\n )\\n\\n def peek(self, count: int) -> str:\\n return self.string[self.position.chars:self.position.chars + count]\\n\\n def read(self, count: int) -> str:\\n result = self.string[self.position.chars:self.position.chars + count]\\n if len(result) < count:\\n raise Error(\\\"read: End of string\\\")\\n self.position.advance(result)\\n return result\\n\\n def read_regex(self, regex: Pattern[str]) -> Sequence[str]:\\n match = regex.match(self.string, self.position.chars)\\n if match is None:\\n raise Error(\\\"read_regex: Pattern not found\\\")\\n self.position.advance(self.string[match.start():match.end()])\\n return match.groups()\\n\\n\\ndef decode_escapes(regex: Pattern[str], string: str) -> str:\\n def decode_match(match: Match[str]) -> str:\\n return codecs.decode(match.group(0), 'unicode-escape') # type: ignore\\n\\n return regex.sub(decode_match, string)\\n\\n\\ndef parse_key(reader: Reader) -> Optional[str]:\\n char = reader.peek(1)\\n if char == \\\"#\\\":\\n return None\\n elif char == \\\"'\\\":\\n (key,) = reader.read_regex(_single_quoted_key)\\n else:\\n (key,) = reader.read_regex(_unquoted_key)\\n return key\\n\\n\\ndef parse_unquoted_value(reader: Reader) -> str:\\n (part,) = reader.read_regex(_unquoted_value)\\n return re.sub(r\\\"\\\\s+#.*\\\", \\\"\\\", part).rstrip()\\n\\n\\ndef parse_value(reader: Reader) -> str:\\n char = reader.peek(1)\\n if char == u\\\"'\\\":\\n (value,) = reader.read_regex(_single_quoted_value)\\n return decode_escapes(_single_quote_escapes, value)\\n elif char == u'\\\"':\\n (value,) = reader.read_regex(_double_quoted_value)\\n return decode_escapes(_double_quote_escapes, value)\\n elif char in (u\\\"\\\", u\\\"\\\\n\\\", u\\\"\\\\r\\\"):\\n return u\\\"\\\"\\n else:\\n return parse_unquoted_value(reader)\\n\\n\\ndef parse_binding(reader: Reader) -> Binding:\\n reader.set_mark()\\n try:\\n reader.read_regex(_multiline_whitespace)\\n if not reader.has_next():\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=False,\\n )\\n reader.read_regex(_export)\\n key = parse_key(reader)\\n reader.read_regex(_whitespace)\\n if reader.peek(1) == \\\"=\\\":\\n reader.read_regex(_equal_sign)\\n value: Optional[str] = parse_value(reader)\\n else:\\n value = None\\n reader.read_regex(_comment)\\n reader.read_regex(_end_of_line)\\n return Binding(\\n key=key,\\n value=value,\\n original=reader.get_marked(),\\n error=False,\\n )\\n except Error:\\n reader.read_regex(_rest_of_line)\\n return Binding(\\n key=None,\\n value=None,\\n original=reader.get_marked(),\\n error=True,\\n )\\n\\n\\ndef parse_stream(stream: IO[str]) -> Iterator[Binding]:\\n reader = Reader(stream)\\n while reader.has_next():\\n yield parse_binding(reader)\\n\\n[end of src/dotenv/parser.py]\",\n \"filename\": \"src/dotenv/parser.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \"import json\\nimport os\\nimport shlex\\nimport sys\\nfrom contextlib import contextmanager\\nfrom typing import Any, Dict, IO, Iterator, List, Optional\\n\\ntry:\\n import click\\nexcept ImportError:\\n sys.stderr.write('It seems python-dotenv is not installed with cli option. \\\\n'\\n 'Run pip install \\\"python-dotenv[cli]\\\" to fix this.')\\n sys.exit(1)\\n\\nfrom .main import dotenv_values, set_key, unset_key\\nfrom .version import __version__\\n\\n\\ndef enumerate_env() -> Optional[str]:\\n \\\"\\\"\\\"\\n Return a path for the ${pwd}/.env file.\\n\\n If pwd does not exist, return None.\\n \\\"\\\"\\\"\\n try:\\n cwd = os.getcwd()\\n except FileNotFoundError:\\n return None\\n path = os.path.join(cwd, '.env')\\n return path\\n\\n\\n@click.group()\\n@click.option('-f', '--file', default=enumerate_env(),\\n type=click.Path(file_okay=True),\\n help=\\\"Location of the .env file, defaults to .env file in current working directory.\\\")\\n@click.option('-q', '--quote', default='always',\\n type=click.Choice(['always', 'never', 'auto']),\\n help=\\\"Whether to quote or not the variable values. Default mode is always. This does not affect parsing.\\\")\\n@click.option('-e', '--export', default=False,\\n type=click.BOOL,\\n help=\\\"Whether to write the dot file as an executable bash script.\\\")\\n@click.version_option(version=__version__)\\n@click.pass_context\\ndef cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:\\n \\\"\\\"\\\"This script is used to set, get or unset values from a .env file.\\\"\\\"\\\"\\n ctx.obj = {'QUOTE': quote, 'EXPORT': export, 'FILE': file}\\n\\n\\n@contextmanager\\ndef stream_file(path: os.PathLike) -> Iterator[IO[str]]:\\n \\\"\\\"\\\"\\n Open a file and yield the corresponding (decoded) stream.\\n\\n Exits with error code 2 if the file cannot be opened.\\n \\\"\\\"\\\"\\n\\n try:\\n with open(path) as stream:\\n yield stream\\n except OSError as exc:\\n print(f\\\"Error opening env file: {exc}\\\", file=sys.stderr)\\n exit(2)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.option('--format', default='simple',\\n type=click.Choice(['simple', 'json', 'shell', 'export']),\\n help=\\\"The format in which to display the list. Default format is simple, \\\"\\n \\\"which displays name=value without quotes.\\\")\\ndef list(ctx: click.Context, format: bool) -> None:\\n \\\"\\\"\\\"Display all the stored key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n if format == 'json':\\n click.echo(json.dumps(values, indent=2, sort_keys=True))\\n else:\\n prefix = 'export ' if format == 'export' else ''\\n for k in sorted(values):\\n v = values[k]\\n if v is not None:\\n if format in ('export', 'shell'):\\n v = shlex.quote(v)\\n click.echo(f'{prefix}{k}={v}')\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\n@click.argument('value', required=True)\\ndef set(ctx: click.Context, key: Any, value: Any) -> None:\\n \\\"\\\"\\\"Store the given key/value.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n export = ctx.obj['EXPORT']\\n success, key, value = set_key(file, key, value, quote, export)\\n if success:\\n click.echo(f'{key}={value}')\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef get(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Retrieve the value for the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n\\n with stream_file(file) as stream:\\n values = dotenv_values(stream=stream)\\n\\n stored_value = values.get(key)\\n if stored_value:\\n click.echo(stored_value)\\n else:\\n exit(1)\\n\\n\\n@cli.command()\\n@click.pass_context\\n@click.argument('key', required=True)\\ndef unset(ctx: click.Context, key: Any) -> None:\\n \\\"\\\"\\\"Removes the given key.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n quote = ctx.obj['QUOTE']\\n success, key = unset_key(file, key, quote)\\n if success:\\n click.echo(f\\\"Successfully removed {key}\\\")\\n else:\\n exit(1)\\n\\n\\n@cli.command(context_settings={'ignore_unknown_options': True})\\n@click.pass_context\\n@click.option(\\n \\\"--override/--no-override\\\",\\n default=True,\\n help=\\\"Override variables from the environment file with those from the .env file.\\\",\\n)\\n@click.argument('commandline', nargs=-1, type=click.UNPROCESSED)\\ndef run(ctx: click.Context, override: bool, commandline: List[str]) -> None:\\n \\\"\\\"\\\"Run command with environment variables present.\\\"\\\"\\\"\\n file = ctx.obj['FILE']\\n if not os.path.isfile(file):\\n raise click.BadParameter(\\n f'Invalid value for \\\\'-f\\\\' \\\"{file}\\\" does not exist.',\\n ctx=ctx\\n )\\n dotenv_as_dict = {\\n k: v\\n for (k, v) in dotenv_values(file).items()\\n if v is not None and (override or k not in os.environ)\\n }\\n\\n if not commandline:\\n click.echo('No command given.')\\n exit(1)\\n run_command(commandline, dotenv_as_dict)\\n\\n\\ndef run_command(command: List[str], env: Dict[str, str]) -> None:\\n \\\"\\\"\\\"Replace the current process with the specified command.\\n\\n Replaces the current process with the specified command and the variables from `env`\\n added in the current environment variables.\\n\\n Parameters\\n ----------\\n command: List[str]\\n The command and it's parameters\\n env: Dict\\n The additional environment variables\\n\\n Returns\\n -------\\n None\\n This function does not return any value. It replaces the current process with the new one.\\n\\n \\\"\\\"\\\"\\n # copy the current environment variables and add the vales from\\n # `env`\\n cmd_env = os.environ.copy()\\n cmd_env.update(env)\\n\\n os.execvpe(command[0], args=command, env=cmd_env)\\n\\n[end of src/dotenv/cli.py]\",\n \"filename\": \"src/dotenv/cli.py\",\n \"id\": \"22\"\n },\n {\n \"content\": \"from IPython.core.magic import Magics, line_magic, magics_class # type: ignore\\nfrom IPython.core.magic_arguments import (argument, magic_arguments, # type: ignore\\n parse_argstring) # type: ignore\\n\\nfrom .main import find_dotenv, load_dotenv\\n\\n\\n@magics_class\\nclass IPythonDotEnv(Magics):\\n\\n @magic_arguments()\\n @argument(\\n '-o', '--override', action='store_true',\\n help=\\\"Indicate to override existing variables\\\"\\n )\\n @argument(\\n '-v', '--verbose', action='store_true',\\n help=\\\"Indicate function calls to be verbose\\\"\\n )\\n @argument('dotenv_path', nargs='?', type=str, default='.env',\\n help='Search in increasingly higher folders for the `dotenv_path`')\\n @line_magic\\n def dotenv(self, line):\\n args = parse_argstring(self.dotenv, line)\\n # Locate the .env file\\n dotenv_path = args.dotenv_path\\n try:\\n dotenv_path = find_dotenv(dotenv_path, True, True)\\n except IOError:\\n print(\\\"cannot find .env file\\\")\\n return\\n\\n # Load the .env file\\n load_dotenv(dotenv_path, verbose=args.verbose, override=args.override)\\n\\n\\ndef load_ipython_extension(ipython):\\n \\\"\\\"\\\"Register the %dotenv magic.\\\"\\\"\\\"\\n ipython.register_magics(IPythonDotEnv)\\n\\n[end of src/dotenv/ipython.py]\",\n \"filename\": \"src/dotenv/ipython.py\",\n \"id\": \"23\"\n },\n {\n \"content\": \"# Marker file for PEP 561\\n\\n[end of src/dotenv/py.typed]\",\n \"filename\": \"src/dotenv/py.typed\",\n \"id\": \"24\"\n },\n {\n \"content\": \"import io\\nimport logging\\nimport os\\nimport pathlib\\nimport shutil\\nimport sys\\nimport tempfile\\nfrom collections import OrderedDict\\nfrom contextlib import contextmanager\\nfrom typing import IO, Dict, Iterable, Iterator, Mapping, Optional, Tuple, Union\\n\\nfrom .parser import Binding, parse_stream\\nfrom .variables import parse_variables\\n\\n# A type alias for a string path to be used for the paths in this file.\\n# These paths may flow to `open()` and `shutil.move()`; `shutil.move()`\\n# only accepts string paths, not byte paths or file descriptors. See\\n# https://github.com/python/typeshed/pull/6832.\\nStrPath = Union[str, \\\"os.PathLike[str]\\\"]\\n\\nlogger = logging.getLogger(__name__)\\n\\n\\ndef with_warn_for_invalid_lines(mappings: Iterator[Binding]) -> Iterator[Binding]:\\n for mapping in mappings:\\n if mapping.error:\\n logger.warning(\\n \\\"python-dotenv could not parse statement starting at line %s\\\",\\n mapping.original.line,\\n )\\n yield mapping\\n\\n\\nclass DotEnv:\\n def __init__(\\n self,\\n dotenv_path: Optional[StrPath],\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n encoding: Optional[str] = None,\\n interpolate: bool = True,\\n override: bool = True,\\n ) -> None:\\n self.dotenv_path: Optional[StrPath] = dotenv_path\\n self.stream: Optional[IO[str]] = stream\\n self._dict: Optional[Dict[str, Optional[str]]] = None\\n self.verbose: bool = verbose\\n self.encoding: Optional[str] = encoding\\n self.interpolate: bool = interpolate\\n self.override: bool = override\\n\\n @contextmanager\\n def _get_stream(self) -> Iterator[IO[str]]:\\n if self.dotenv_path and os.path.isfile(self.dotenv_path):\\n with open(self.dotenv_path, encoding=self.encoding) as stream:\\n yield stream\\n elif self.stream is not None:\\n yield self.stream\\n else:\\n if self.verbose:\\n logger.info(\\n \\\"python-dotenv could not find configuration file %s.\\\",\\n self.dotenv_path or \\\".env\\\",\\n )\\n yield io.StringIO(\\\"\\\")\\n\\n def dict(self) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"Return dotenv as dict\\\"\\\"\\\"\\n if self._dict:\\n return self._dict\\n\\n raw_values = self.parse()\\n\\n if self.interpolate:\\n self._dict = OrderedDict(\\n resolve_variables(raw_values, override=self.override)\\n )\\n else:\\n self._dict = OrderedDict(raw_values)\\n\\n return self._dict\\n\\n def parse(self) -> Iterator[Tuple[str, Optional[str]]]:\\n with self._get_stream() as stream:\\n for mapping in with_warn_for_invalid_lines(parse_stream(stream)):\\n if mapping.key is not None:\\n yield mapping.key, mapping.value\\n\\n def set_as_environment_variables(self) -> bool:\\n \\\"\\\"\\\"\\n Load the current dotenv as system environment variable.\\n \\\"\\\"\\\"\\n if not self.dict():\\n return False\\n\\n for k, v in self.dict().items():\\n if k in os.environ and not self.override:\\n continue\\n if v is not None:\\n os.environ[k] = v\\n\\n return True\\n\\n def get(self, key: str) -> Optional[str]:\\n \\\"\\\"\\\" \\\"\\\"\\\"\\n data = self.dict()\\n\\n if key in data:\\n return data[key]\\n\\n if self.verbose:\\n logger.warning(\\\"Key %s not found in %s.\\\", key, self.dotenv_path)\\n\\n return None\\n\\n\\ndef get_key(\\n dotenv_path: StrPath,\\n key_to_get: str,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Optional[str]:\\n \\\"\\\"\\\"\\n Get the value of a given key from the given .env.\\n\\n Returns `None` if the key isn't found or doesn't have a value.\\n \\\"\\\"\\\"\\n return DotEnv(dotenv_path, verbose=True, encoding=encoding).get(key_to_get)\\n\\n\\n@contextmanager\\ndef rewrite(\\n path: StrPath,\\n encoding: Optional[str],\\n) -> Iterator[Tuple[IO[str], IO[str]]]:\\n pathlib.Path(path).touch()\\n\\n with tempfile.NamedTemporaryFile(mode=\\\"w\\\", encoding=encoding, delete=False) as dest:\\n error = None\\n try:\\n with open(path, encoding=encoding) as source:\\n yield (source, dest)\\n except BaseException as err:\\n error = err\\n\\n if error is None:\\n shutil.move(dest.name, path)\\n else:\\n os.unlink(dest.name)\\n raise error from None\\n\\n\\ndef set_key(\\n dotenv_path: StrPath,\\n key_to_set: str,\\n value_to_set: str,\\n quote_mode: str = \\\"always\\\",\\n export: bool = False,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str, str]:\\n \\\"\\\"\\\"\\n Adds or Updates a key/value to the given .env\\n\\n If the .env path given doesn't exist, fails instead of risking creating\\n an orphan .env somewhere in the filesystem\\n \\\"\\\"\\\"\\n if quote_mode not in (\\\"always\\\", \\\"auto\\\", \\\"never\\\"):\\n raise ValueError(f\\\"Unknown quote_mode: {quote_mode}\\\")\\n\\n quote = quote_mode == \\\"always\\\" or (\\n quote_mode == \\\"auto\\\" and not value_to_set.isalnum()\\n )\\n\\n if quote:\\n value_out = \\\"'{}'\\\".format(value_to_set.replace(\\\"'\\\", \\\"\\\\\\\\'\\\"))\\n else:\\n value_out = value_to_set\\n if export:\\n line_out = f\\\"export {key_to_set}={value_out}\\\\n\\\"\\n else:\\n line_out = f\\\"{key_to_set}={value_out}\\\\n\\\"\\n\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n replaced = False\\n missing_newline = False\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_set:\\n dest.write(line_out)\\n replaced = True\\n else:\\n dest.write(mapping.original.string)\\n missing_newline = not mapping.original.string.endswith(\\\"\\\\n\\\")\\n if not replaced:\\n if missing_newline:\\n dest.write(\\\"\\\\n\\\")\\n dest.write(line_out)\\n\\n return True, key_to_set, value_to_set\\n\\n\\ndef unset_key(\\n dotenv_path: StrPath,\\n key_to_unset: str,\\n quote_mode: str = \\\"always\\\",\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Tuple[Optional[bool], str]:\\n \\\"\\\"\\\"\\n Removes a given key from the given `.env` file.\\n\\n If the .env path given doesn't exist, fails.\\n If the given key doesn't exist in the .env, fails.\\n \\\"\\\"\\\"\\n if not os.path.exists(dotenv_path):\\n logger.warning(\\\"Can't delete from %s - it doesn't exist.\\\", dotenv_path)\\n return None, key_to_unset\\n\\n removed = False\\n with rewrite(dotenv_path, encoding=encoding) as (source, dest):\\n for mapping in with_warn_for_invalid_lines(parse_stream(source)):\\n if mapping.key == key_to_unset:\\n removed = True\\n else:\\n dest.write(mapping.original.string)\\n\\n if not removed:\\n logger.warning(\\n \\\"Key %s not removed from %s - key doesn't exist.\\\", key_to_unset, dotenv_path\\n )\\n return None, key_to_unset\\n\\n return removed, key_to_unset\\n\\n\\ndef resolve_variables(\\n values: Iterable[Tuple[str, Optional[str]]],\\n override: bool,\\n) -> Mapping[str, Optional[str]]:\\n new_values: Dict[str, Optional[str]] = {}\\n\\n for name, value in values:\\n if value is None:\\n result = None\\n else:\\n atoms = parse_variables(value)\\n env: Dict[str, Optional[str]] = {}\\n if override:\\n env.update(os.environ) # type: ignore\\n env.update(new_values)\\n else:\\n env.update(new_values)\\n env.update(os.environ) # type: ignore\\n result = \\\"\\\".join(atom.resolve(env) for atom in atoms)\\n\\n new_values[name] = result\\n\\n return new_values\\n\\n\\ndef _walk_to_root(path: str) -> Iterator[str]:\\n \\\"\\\"\\\"\\n Yield directories starting from the given directory up to the root\\n \\\"\\\"\\\"\\n if not os.path.exists(path):\\n raise IOError(\\\"Starting path not found\\\")\\n\\n if os.path.isfile(path):\\n path = os.path.dirname(path)\\n\\n last_dir = None\\n current_dir = os.path.abspath(path)\\n while last_dir != current_dir:\\n yield current_dir\\n parent_dir = os.path.abspath(os.path.join(current_dir, os.path.pardir))\\n last_dir, current_dir = current_dir, parent_dir\\n\\n\\ndef find_dotenv(\\n filename: str = \\\".env\\\",\\n raise_error_if_not_found: bool = False,\\n usecwd: bool = False,\\n) -> str:\\n \\\"\\\"\\\"\\n Search in increasingly higher folders for the given file\\n\\n Returns path to the file if found, or an empty string otherwise\\n \\\"\\\"\\\"\\n\\n def _is_interactive():\\n \\\"\\\"\\\"Decide whether this is running in a REPL or IPython notebook\\\"\\\"\\\"\\n try:\\n main = __import__(\\\"__main__\\\", None, None, fromlist=[\\\"__file__\\\"])\\n except ModuleNotFoundError:\\n return False\\n return not hasattr(main, \\\"__file__\\\")\\n\\n if usecwd or _is_interactive() or getattr(sys, \\\"frozen\\\", False):\\n # Should work without __file__, e.g. in REPL or IPython notebook.\\n path = os.getcwd()\\n else:\\n # will work for .py files\\n frame = sys._getframe()\\n current_file = __file__\\n\\n while frame.f_code.co_filename == current_file or not os.path.exists(\\n frame.f_code.co_filename\\n ):\\n assert frame.f_back is not None\\n frame = frame.f_back\\n frame_filename = frame.f_code.co_filename\\n path = os.path.dirname(os.path.abspath(frame_filename))\\n\\n for dirname in _walk_to_root(path):\\n check_path = os.path.join(dirname, filename)\\n if os.path.isfile(check_path):\\n return check_path\\n\\n if raise_error_if_not_found:\\n raise IOError(\\\"File not found\\\")\\n\\n return \\\"\\\"\\n\\n\\ndef load_dotenv(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n override: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> bool:\\n \\\"\\\"\\\"Parse a .env file and then load all the variables found as environment variables.\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to .env file.\\n stream: Text stream (such as `io.StringIO`) with .env content, used if\\n `dotenv_path` is `None`.\\n verbose: Whether to output a warning the .env file is missing.\\n override: Whether to override the system environment variables with the variables\\n from the `.env` file.\\n encoding: Encoding to be used to read the file.\\n Returns:\\n Bool: True if at least one environment variable is set else False\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file with it's default parameters. If you need to change the default parameters\\n of `find_dotenv()`, you can explicitly call `find_dotenv()` and pass the result\\n to this function as `dotenv_path`.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n dotenv = DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=override,\\n encoding=encoding,\\n )\\n return dotenv.set_as_environment_variables()\\n\\n\\ndef dotenv_values(\\n dotenv_path: Optional[StrPath] = None,\\n stream: Optional[IO[str]] = None,\\n verbose: bool = False,\\n interpolate: bool = True,\\n encoding: Optional[str] = \\\"utf-8\\\",\\n) -> Dict[str, Optional[str]]:\\n \\\"\\\"\\\"\\n Parse a .env file and return its content as a dict.\\n\\n The returned dict will have `None` values for keys without values in the .env file.\\n For example, `foo=bar` results in `{\\\"foo\\\": \\\"bar\\\"}` whereas `foo` alone results in\\n `{\\\"foo\\\": None}`\\n\\n Parameters:\\n dotenv_path: Absolute or relative path to the .env file.\\n stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.\\n verbose: Whether to output a warning if the .env file is missing.\\n encoding: Encoding to be used to read the file.\\n\\n If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the\\n .env file.\\n \\\"\\\"\\\"\\n if dotenv_path is None and stream is None:\\n dotenv_path = find_dotenv()\\n\\n return DotEnv(\\n dotenv_path=dotenv_path,\\n stream=stream,\\n verbose=verbose,\\n interpolate=interpolate,\\n override=True,\\n encoding=encoding,\\n ).dict()\\n\\n[end of src/dotenv/main.py]\",\n \"filename\": \"src/dotenv/main.py\",\n \"id\": \"25\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Entry point for cli, enables execution with `python -m dotenv`\\\"\\\"\\\"\\n\\nfrom .cli import cli\\n\\nif __name__ == \\\"__main__\\\":\\n cli()\\n\\n[end of src/dotenv/__main__.py]\",\n \"filename\": \"src/dotenv/__main__.py\",\n \"id\": \"26\"\n }\n]","isConversational":false}}},{"rowIdx":65,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 65,\n \"num_files\": 7,\n \"repo_id\": \"repo_0065\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"Mypy extensions are licensed under the terms of the MIT license, reproduced below.\n\n= = = = =\n\nThe MIT License\n\nCopyright (c) 2016-2017 Jukka Lehtosalo and contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the \"Software\"),\nto deal in the Software without restriction, including without limitation\nthe rights to use, copy, modify, merge, publish, distribute, sublicense,\nand/or sell copies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\nDEALINGS IN THE SOFTWARE.\n\n= = = = =\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"repos:\n- repo: https://github.com/PyCQA/flake8\n rev: 7.1.1\n hooks:\n - id: flake8\n\n[end of .pre-commit-config.yaml]","filename":".pre-commit-config.yaml","id":"1"},{"content":"[build-system]\nrequires = [\"setuptools>=75.0\"]\nbuild-backend = \"setuptools.build_meta\"\n\n[project]\nname = \"mypy_extensions\"\nversion = \"1.1.0-dev\"\ndescription = \"Type system extensions for programs checked with the mypy type checker.\"\nreadme = \"README.md\"\nauthors = [\n {name = \"The mypy developers\", email = \"jukka.lehtosalo@iki.fi\"}\n]\nlicense = {text = \"MIT\"}\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: MIT License\",\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 \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Topic :: Software Development\",\n]\nrequires-python = \">=3.8\"\n\n[project.urls]\nHomepage = \"https://github.com/python/mypy_extensions\"\n\n[tool.setuptools]\npy-modules = [\"mypy_extensions\"]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"# files necessary for testing sdist\ngraft tests\ninclude tox.ini\n\nglobal-exclude *.py[cod]\nglobal-exclude .DS_Store\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"3"},{"content":"Mypy Extensions\n===============\n\nThe `mypy_extensions` module defines extensions to the Python standard\nlibrary `typing` module that are supported by the mypy type checker and\nthe mypyc compiler.\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"\"\"\"Defines experimental extensions to the standard \"typing\" module that are\nsupported by the mypy typechecker.\n\nExample usage:\n from mypy_extensions import TypedDict\n\"\"\"\n\nfrom typing import Any, Dict\n\nimport sys\n# _type_check is NOT a part of public typing API, it is used here only to mimic\n# the (convenient) behavior of types provided by typing module.\nfrom typing import _type_check # type: ignore\n\n\ndef _check_fails(cls, other):\n try:\n if sys._getframe(1).f_globals['__name__'] not in ['abc', 'functools', 'typing']:\n # Typed dicts are only for static structural subtyping.\n raise TypeError('TypedDict does not support instance and class checks')\n except (AttributeError, ValueError):\n pass\n return False\n\n\ndef _dict_new(cls, *args, **kwargs):\n return dict(*args, **kwargs)\n\n\ndef _typeddict_new(cls, _typename, _fields=None, **kwargs):\n total = kwargs.pop('total', True)\n if _fields is None:\n _fields = kwargs\n elif kwargs:\n raise TypeError(\"TypedDict takes either a dict or keyword arguments,\"\n \" but not both\")\n\n ns = {'__annotations__': dict(_fields), '__total__': total}\n try:\n # Setting correct module is necessary to make typed dict classes pickleable.\n ns['__module__'] = sys._getframe(1).f_globals.get('__name__', '__main__')\n except (AttributeError, ValueError):\n pass\n\n return _TypedDictMeta(_typename, (), ns, _from_functional_call=True)\n\n\nclass _TypedDictMeta(type):\n def __new__(cls, name, bases, ns, total=True, _from_functional_call=False):\n # Create new typed dict class object.\n # This method is called directly when TypedDict is subclassed,\n # or via _typeddict_new when TypedDict is instantiated. This way\n # TypedDict supports all three syntaxes described in its docstring.\n # Subclasses and instances of TypedDict return actual dictionaries\n # via _dict_new.\n\n # We need the `if TypedDict in globals()` check,\n # or we emit a DeprecationWarning when creating mypy_extensions.TypedDict itself\n if 'TypedDict' in globals():\n import warnings\n warnings.warn(\n (\n \"mypy_extensions.TypedDict is deprecated, \"\n \"and will be removed in a future version. \"\n \"Use typing.TypedDict or typing_extensions.TypedDict instead.\"\n ),\n DeprecationWarning,\n stacklevel=(3 if _from_functional_call else 2)\n )\n\n ns['__new__'] = _typeddict_new if name == 'TypedDict' else _dict_new\n tp_dict = super(_TypedDictMeta, cls).__new__(cls, name, (dict,), ns)\n\n anns = ns.get('__annotations__', {})\n msg = \"TypedDict('Name', {f0: t0, f1: t1, ...}); each t must be a type\"\n anns = {n: _type_check(tp, msg) for n, tp in anns.items()}\n for base in bases:\n anns.update(base.__dict__.get('__annotations__', {}))\n tp_dict.__annotations__ = anns\n if not hasattr(tp_dict, '__total__'):\n tp_dict.__total__ = total\n return tp_dict\n\n __instancecheck__ = __subclasscheck__ = _check_fails\n\n\nTypedDict = _TypedDictMeta('TypedDict', (dict,), {})\nTypedDict.__module__ = __name__\nTypedDict.__doc__ = \\\n \"\"\"A simple typed name space. At runtime it is equivalent to a plain dict.\n\n TypedDict creates a dictionary type that expects all of its\n instances to have a certain set of keys, with each key\n associated with a value of a consistent type. This expectation\n is not checked at runtime but is only enforced by typecheckers.\n Usage::\n\n Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})\n a: Point2D = {'x': 1, 'y': 2, 'label': 'good'} # OK\n b: Point2D = {'z': 3, 'label': 'bad'} # Fails type check\n assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')\n\n The type info could be accessed via Point2D.__annotations__. TypedDict\n supports two additional equivalent forms::\n\n Point2D = TypedDict('Point2D', x=int, y=int, label=str)\n\n class Point2D(TypedDict):\n x: int\n y: int\n label: str\n\n The latter syntax is only supported in Python 3.6+, while two other\n syntax forms work for 3.2+\n \"\"\"\n\n# Argument constructors for making more-detailed Callables. These all just\n# return their type argument, to make them complete noops in terms of the\n# `typing` module.\n\n\ndef Arg(type=Any, name=None):\n \"\"\"A normal positional argument\"\"\"\n return type\n\n\ndef DefaultArg(type=Any, name=None):\n \"\"\"A positional argument with a default value\"\"\"\n return type\n\n\ndef NamedArg(type=Any, name=None):\n \"\"\"A keyword-only argument\"\"\"\n return type\n\n\ndef DefaultNamedArg(type=Any, name=None):\n \"\"\"A keyword-only argument with a default value\"\"\"\n return type\n\n\ndef VarArg(type=Any):\n \"\"\"A *args-style variadic positional argument\"\"\"\n return type\n\n\ndef KwArg(type=Any):\n \"\"\"A **kwargs-style variadic keyword argument\"\"\"\n return type\n\n\n# Return type that indicates a function does not return\n# Deprecated, use typing or typing_extensions variants instead\nclass _DEPRECATED_NoReturn: pass\n\n\ndef trait(cls):\n return cls\n\n\ndef mypyc_attr(*attrs, **kwattrs):\n return lambda x: x\n\n\n# TODO: We may want to try to properly apply this to any type\n# variables left over...\nclass _FlexibleAliasClsApplied:\n def __init__(self, val):\n self.val = val\n\n def __getitem__(self, args):\n return self.val\n\n\nclass _FlexibleAliasCls:\n def __getitem__(self, args):\n return _FlexibleAliasClsApplied(args[-1])\n\n\nFlexibleAlias = _FlexibleAliasCls()\n\n\nclass _NativeIntMeta(type):\n def __instancecheck__(cls, inst):\n return isinstance(inst, int)\n\n\n_sentinel = object()\n\n\nclass i64(metaclass=_NativeIntMeta):\n def __new__(cls, x=0, base=_sentinel):\n if base is not _sentinel:\n return int(x, base)\n return int(x)\n\n\nclass i32(metaclass=_NativeIntMeta):\n def __new__(cls, x=0, base=_sentinel):\n if base is not _sentinel:\n return int(x, base)\n return int(x)\n\n\nclass i16(metaclass=_NativeIntMeta):\n def __new__(cls, x=0, base=_sentinel):\n if base is not _sentinel:\n return int(x, base)\n return int(x)\n\n\nclass u8(metaclass=_NativeIntMeta):\n def __new__(cls, x=0, base=_sentinel):\n if base is not _sentinel:\n return int(x, base)\n return int(x)\n\n\nfor _int_type in i64, i32, i16, u8:\n _int_type.__doc__ = \\\n \"\"\"A native fixed-width integer type when used with mypyc.\n\n In code not compiled with mypyc, behaves like the 'int' type in these\n runtime contexts:\n\n * {name}(x[, base=n]) converts a number or string to 'int'\n * isinstance(x, {name}) is the same as isinstance(x, int)\n \"\"\".format(name=_int_type.__name__)\ndel _int_type\n\n\ndef _warn_deprecation(name: str, module_globals: Dict[str, Any]) -> Any:\n if (val := module_globals.get(f\"_DEPRECATED_{name}\")) is None:\n msg = f\"module '{__name__}' has no attribute '{name}'\"\n raise AttributeError(msg)\n module_globals[name] = val\n if name in {\"NoReturn\"}:\n msg = (\n f\"'mypy_extensions.{name}' is deprecated, \"\n \"and will be removed in a future version. \"\n f\"Use 'typing.{name}' or 'typing_extensions.{name}' instead\"\n )\n else:\n assert False, f\"Add deprecation message for 'mypy_extensions.{name}'\"\n import warnings\n warnings.warn(msg, DeprecationWarning, stacklevel=3)\n return val\n\n\ndef __getattr__(name: str) -> Any:\n return _warn_deprecation(name, module_globals=globals())\n\n[end of mypy_extensions.py]","filename":"mypy_extensions.py","id":"5"},{"content":"[tox]\nminversion = 4.4.4\nskip_missing_interpreters = true\nenvlist = py38, py39, py310, py311, py312, py313\n\n[testenv]\ndescription = run the test driver with {basepython}\ncommands = python -We -m unittest discover tests\n\n[testenv:lint]\ndescription = check the code style\nbasepython = python3\ndeps = flake8\ncommands = flake8 -j0 {posargs}\n\n[flake8]\nmax-line-length = 99\nignore =\n # multiple statements on one line (colon) (we use this for classes with empty body)\n E701\n\n[end of tox.ini]","filename":"tox.ini","id":"6"}],"string":"[\n {\n \"content\": \"Mypy extensions are licensed under the terms of the MIT license, reproduced below.\\n\\n= = = = =\\n\\nThe MIT License\\n\\nCopyright (c) 2016-2017 Jukka Lehtosalo and contributors\\n\\nPermission is hereby granted, free of charge, to any person obtaining a\\ncopy of this software and associated documentation files (the \\\"Software\\\"),\\nto deal in the Software without restriction, including without limitation\\nthe rights to use, copy, modify, merge, publish, distribute, sublicense,\\nand/or sell copies of the Software, and to permit persons to whom the\\nSoftware is furnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\\nDEALINGS IN THE SOFTWARE.\\n\\n= = = = =\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"repos:\\n- repo: https://github.com/PyCQA/flake8\\n rev: 7.1.1\\n hooks:\\n - id: flake8\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"setuptools>=75.0\\\"]\\nbuild-backend = \\\"setuptools.build_meta\\\"\\n\\n[project]\\nname = \\\"mypy_extensions\\\"\\nversion = \\\"1.1.0-dev\\\"\\ndescription = \\\"Type system extensions for programs checked with the mypy type checker.\\\"\\nreadme = \\\"README.md\\\"\\nauthors = [\\n {name = \\\"The mypy developers\\\", email = \\\"jukka.lehtosalo@iki.fi\\\"}\\n]\\nlicense = {text = \\\"MIT\\\"}\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: MIT License\\\",\\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 \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Topic :: Software Development\\\",\\n]\\nrequires-python = \\\">=3.8\\\"\\n\\n[project.urls]\\nHomepage = \\\"https://github.com/python/mypy_extensions\\\"\\n\\n[tool.setuptools]\\npy-modules = [\\\"mypy_extensions\\\"]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"# files necessary for testing sdist\\ngraft tests\\ninclude tox.ini\\n\\nglobal-exclude *.py[cod]\\nglobal-exclude .DS_Store\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"3\"\n },\n {\n \"content\": \"Mypy Extensions\\n===============\\n\\nThe `mypy_extensions` module defines extensions to the Python standard\\nlibrary `typing` module that are supported by the mypy type checker and\\nthe mypyc compiler.\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Defines experimental extensions to the standard \\\"typing\\\" module that are\\nsupported by the mypy typechecker.\\n\\nExample usage:\\n from mypy_extensions import TypedDict\\n\\\"\\\"\\\"\\n\\nfrom typing import Any, Dict\\n\\nimport sys\\n# _type_check is NOT a part of public typing API, it is used here only to mimic\\n# the (convenient) behavior of types provided by typing module.\\nfrom typing import _type_check # type: ignore\\n\\n\\ndef _check_fails(cls, other):\\n try:\\n if sys._getframe(1).f_globals['__name__'] not in ['abc', 'functools', 'typing']:\\n # Typed dicts are only for static structural subtyping.\\n raise TypeError('TypedDict does not support instance and class checks')\\n except (AttributeError, ValueError):\\n pass\\n return False\\n\\n\\ndef _dict_new(cls, *args, **kwargs):\\n return dict(*args, **kwargs)\\n\\n\\ndef _typeddict_new(cls, _typename, _fields=None, **kwargs):\\n total = kwargs.pop('total', True)\\n if _fields is None:\\n _fields = kwargs\\n elif kwargs:\\n raise TypeError(\\\"TypedDict takes either a dict or keyword arguments,\\\"\\n \\\" but not both\\\")\\n\\n ns = {'__annotations__': dict(_fields), '__total__': total}\\n try:\\n # Setting correct module is necessary to make typed dict classes pickleable.\\n ns['__module__'] = sys._getframe(1).f_globals.get('__name__', '__main__')\\n except (AttributeError, ValueError):\\n pass\\n\\n return _TypedDictMeta(_typename, (), ns, _from_functional_call=True)\\n\\n\\nclass _TypedDictMeta(type):\\n def __new__(cls, name, bases, ns, total=True, _from_functional_call=False):\\n # Create new typed dict class object.\\n # This method is called directly when TypedDict is subclassed,\\n # or via _typeddict_new when TypedDict is instantiated. This way\\n # TypedDict supports all three syntaxes described in its docstring.\\n # Subclasses and instances of TypedDict return actual dictionaries\\n # via _dict_new.\\n\\n # We need the `if TypedDict in globals()` check,\\n # or we emit a DeprecationWarning when creating mypy_extensions.TypedDict itself\\n if 'TypedDict' in globals():\\n import warnings\\n warnings.warn(\\n (\\n \\\"mypy_extensions.TypedDict is deprecated, \\\"\\n \\\"and will be removed in a future version. \\\"\\n \\\"Use typing.TypedDict or typing_extensions.TypedDict instead.\\\"\\n ),\\n DeprecationWarning,\\n stacklevel=(3 if _from_functional_call else 2)\\n )\\n\\n ns['__new__'] = _typeddict_new if name == 'TypedDict' else _dict_new\\n tp_dict = super(_TypedDictMeta, cls).__new__(cls, name, (dict,), ns)\\n\\n anns = ns.get('__annotations__', {})\\n msg = \\\"TypedDict('Name', {f0: t0, f1: t1, ...}); each t must be a type\\\"\\n anns = {n: _type_check(tp, msg) for n, tp in anns.items()}\\n for base in bases:\\n anns.update(base.__dict__.get('__annotations__', {}))\\n tp_dict.__annotations__ = anns\\n if not hasattr(tp_dict, '__total__'):\\n tp_dict.__total__ = total\\n return tp_dict\\n\\n __instancecheck__ = __subclasscheck__ = _check_fails\\n\\n\\nTypedDict = _TypedDictMeta('TypedDict', (dict,), {})\\nTypedDict.__module__ = __name__\\nTypedDict.__doc__ = \\\\\\n \\\"\\\"\\\"A simple typed name space. At runtime it is equivalent to a plain dict.\\n\\n TypedDict creates a dictionary type that expects all of its\\n instances to have a certain set of keys, with each key\\n associated with a value of a consistent type. This expectation\\n is not checked at runtime but is only enforced by typecheckers.\\n Usage::\\n\\n Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})\\n a: Point2D = {'x': 1, 'y': 2, 'label': 'good'} # OK\\n b: Point2D = {'z': 3, 'label': 'bad'} # Fails type check\\n assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')\\n\\n The type info could be accessed via Point2D.__annotations__. TypedDict\\n supports two additional equivalent forms::\\n\\n Point2D = TypedDict('Point2D', x=int, y=int, label=str)\\n\\n class Point2D(TypedDict):\\n x: int\\n y: int\\n label: str\\n\\n The latter syntax is only supported in Python 3.6+, while two other\\n syntax forms work for 3.2+\\n \\\"\\\"\\\"\\n\\n# Argument constructors for making more-detailed Callables. These all just\\n# return their type argument, to make them complete noops in terms of the\\n# `typing` module.\\n\\n\\ndef Arg(type=Any, name=None):\\n \\\"\\\"\\\"A normal positional argument\\\"\\\"\\\"\\n return type\\n\\n\\ndef DefaultArg(type=Any, name=None):\\n \\\"\\\"\\\"A positional argument with a default value\\\"\\\"\\\"\\n return type\\n\\n\\ndef NamedArg(type=Any, name=None):\\n \\\"\\\"\\\"A keyword-only argument\\\"\\\"\\\"\\n return type\\n\\n\\ndef DefaultNamedArg(type=Any, name=None):\\n \\\"\\\"\\\"A keyword-only argument with a default value\\\"\\\"\\\"\\n return type\\n\\n\\ndef VarArg(type=Any):\\n \\\"\\\"\\\"A *args-style variadic positional argument\\\"\\\"\\\"\\n return type\\n\\n\\ndef KwArg(type=Any):\\n \\\"\\\"\\\"A **kwargs-style variadic keyword argument\\\"\\\"\\\"\\n return type\\n\\n\\n# Return type that indicates a function does not return\\n# Deprecated, use typing or typing_extensions variants instead\\nclass _DEPRECATED_NoReturn: pass\\n\\n\\ndef trait(cls):\\n return cls\\n\\n\\ndef mypyc_attr(*attrs, **kwattrs):\\n return lambda x: x\\n\\n\\n# TODO: We may want to try to properly apply this to any type\\n# variables left over...\\nclass _FlexibleAliasClsApplied:\\n def __init__(self, val):\\n self.val = val\\n\\n def __getitem__(self, args):\\n return self.val\\n\\n\\nclass _FlexibleAliasCls:\\n def __getitem__(self, args):\\n return _FlexibleAliasClsApplied(args[-1])\\n\\n\\nFlexibleAlias = _FlexibleAliasCls()\\n\\n\\nclass _NativeIntMeta(type):\\n def __instancecheck__(cls, inst):\\n return isinstance(inst, int)\\n\\n\\n_sentinel = object()\\n\\n\\nclass i64(metaclass=_NativeIntMeta):\\n def __new__(cls, x=0, base=_sentinel):\\n if base is not _sentinel:\\n return int(x, base)\\n return int(x)\\n\\n\\nclass i32(metaclass=_NativeIntMeta):\\n def __new__(cls, x=0, base=_sentinel):\\n if base is not _sentinel:\\n return int(x, base)\\n return int(x)\\n\\n\\nclass i16(metaclass=_NativeIntMeta):\\n def __new__(cls, x=0, base=_sentinel):\\n if base is not _sentinel:\\n return int(x, base)\\n return int(x)\\n\\n\\nclass u8(metaclass=_NativeIntMeta):\\n def __new__(cls, x=0, base=_sentinel):\\n if base is not _sentinel:\\n return int(x, base)\\n return int(x)\\n\\n\\nfor _int_type in i64, i32, i16, u8:\\n _int_type.__doc__ = \\\\\\n \\\"\\\"\\\"A native fixed-width integer type when used with mypyc.\\n\\n In code not compiled with mypyc, behaves like the 'int' type in these\\n runtime contexts:\\n\\n * {name}(x[, base=n]) converts a number or string to 'int'\\n * isinstance(x, {name}) is the same as isinstance(x, int)\\n \\\"\\\"\\\".format(name=_int_type.__name__)\\ndel _int_type\\n\\n\\ndef _warn_deprecation(name: str, module_globals: Dict[str, Any]) -> Any:\\n if (val := module_globals.get(f\\\"_DEPRECATED_{name}\\\")) is None:\\n msg = f\\\"module '{__name__}' has no attribute '{name}'\\\"\\n raise AttributeError(msg)\\n module_globals[name] = val\\n if name in {\\\"NoReturn\\\"}:\\n msg = (\\n f\\\"'mypy_extensions.{name}' is deprecated, \\\"\\n \\\"and will be removed in a future version. \\\"\\n f\\\"Use 'typing.{name}' or 'typing_extensions.{name}' instead\\\"\\n )\\n else:\\n assert False, f\\\"Add deprecation message for 'mypy_extensions.{name}'\\\"\\n import warnings\\n warnings.warn(msg, DeprecationWarning, stacklevel=3)\\n return val\\n\\n\\ndef __getattr__(name: str) -> Any:\\n return _warn_deprecation(name, module_globals=globals())\\n\\n[end of mypy_extensions.py]\",\n \"filename\": \"mypy_extensions.py\",\n \"id\": \"5\"\n },\n {\n \"content\": \"[tox]\\nminversion = 4.4.4\\nskip_missing_interpreters = true\\nenvlist = py38, py39, py310, py311, py312, py313\\n\\n[testenv]\\ndescription = run the test driver with {basepython}\\ncommands = python -We -m unittest discover tests\\n\\n[testenv:lint]\\ndescription = check the code style\\nbasepython = python3\\ndeps = flake8\\ncommands = flake8 -j0 {posargs}\\n\\n[flake8]\\nmax-line-length = 99\\nignore =\\n # multiple statements on one line (colon) (we use this for classes with empty body)\\n E701\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"6\"\n }\n]","isConversational":false}}},{"rowIdx":66,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 66,\n \"num_files\": 64,\n \"repo_id\": \"repo_0066\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"queue_rules:\n - name: default\n merge_method: squash\n queue_conditions:\n - or:\n - author = jd\n - \"#approved-reviews-by >= 1\"\n - author = dependabot[bot]\n - or:\n - files ~= ^releasenotes/notes/\n - label = no-changelog\n - author = dependabot[bot]\n - \"check-success=test (3.9, py39)\"\n - \"check-success=test (3.10, py310)\"\n - \"check-success=test (3.11, py311)\"\n - \"check-success=test (3.12, py312)\"\n - \"check-success=test (3.13, py313,py313-trio)\"\n - \"check-success=test (3.12, pep8)\"\n\npull_request_rules:\n - name: warn on no changelog\n conditions:\n - -files~=^releasenotes/notes/\n - label!=no-changelog\n - -closed\n actions:\n comment:\n message: >\n ⚠️ No release notes detected. Please make sure to use\n [reno](https://docs.openstack.org/reno/latest/user/usage.html) to add\n a changelog entry.\n\n - name: automatic queue\n conditions: []\n actions:\n queue:\n\n - name: dismiss reviews\n conditions: []\n actions:\n dismiss_reviews: {}\n\n[end of .mergify.yml]","filename":".mergify.yml","id":"0"},{"content":"---\nunreleased_version_title: Unreleased\n\n[end of reno.yaml]","filename":"reno.yaml","id":"1"},{"content":"Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\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[end of LICENSE]","filename":"LICENSE","id":"2"},{"content":"[build-system]\n# Minimum requirements for the build system to execute.\n# PEP 508 specifications for PEP 518.\n# Banned setuptools versions have well-known issues\nrequires = [\n \"setuptools >= 21.0.0,!=24.0.0,!=34.0.0,!=34.0.1,!=34.0.2,!=34.0.3,!=34.1.0,!=34.1.1,!=34.2.0,!=34.3.0,!=34.3.1,!=34.3.2,!=36.2.0\", # PSF/ZPL\n \"setuptools_scm[toml]>=3.4\",\n]\nbuild-backend=\"setuptools.build_meta\"\n\n[tool.ruff]\nline-length = 88\nindent-width = 4\ntarget-version = \"py39\"\n\n[tool.mypy]\nstrict = true\nfiles = [\"tenacity\", \"tests\"]\nshow_error_codes = true\n\n[[tool.mypy.overrides]]\nmodule = \"tornado.*\"\nignore_missing_imports = true\n\n[tool.setuptools_scm]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"version: 2\npython:\n install:\n - method: pip\n path: .\n extra_requirements:\n - doc\n\n[end of .readthedocs.yml]","filename":".readthedocs.yml","id":"4"},{"content":"root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\nindent_size = 2\nindent_style = space\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.{py,pyx,pxd,pyi}]\nindent_size = 4\nmax_line_length = 120\n\n[*.ini]\nindent_size = 4\n\n[*.rst]\nmax_line_length = 150\n\n[Makefile]\nindent_style = tab\n\n[end of .editorconfig]","filename":".editorconfig","id":"5"},{"content":"#!/usr/bin/env python\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\n# implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport setuptools\n\nsetuptools.setup(\n setup_requires=[\"setuptools_scm\"],\n use_scm_version=True,\n)\n\n[end of setup.py]","filename":"setup.py","id":"6"},{"content":"[tox]\n# we only test trio on latest python version\nenvlist = py3{9,10,11,12,13,13-trio}, pep8, pypy3\nskip_missing_interpreters = True\n\n[testenv]\nusedevelop = True\nsitepackages = False\ndeps =\n .[test]\n .[doc]\n trio: trio\ncommands =\n py3{8,9,10,11,12,13},pypy3: pytest {posargs}\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b doctest doc/source doc/build\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b html doc/source doc/build\n\n[testenv:pep8]\nbasepython = python3\ndeps = ruff\ncommands =\n ruff check . {posargs}\n ruff format --check . {posargs}\n\n[testenv:mypy]\ndeps =\n mypy>=1.0.0\n pytest # for stubs\n trio\ncommands =\n mypy {posargs}\n\n[testenv:reno]\nbasepython = python3\ndeps = reno\ncommands = reno {posargs}\n\n[end of tox.ini]","filename":"tox.ini","id":"7"},{"content":"[metadata]\nname = tenacity\nlicense = Apache 2.0\nurl = https://github.com/jd/tenacity\nsummary = Retry code until it succeeds\nlong_description = Tenacity is a general-purpose retrying library to simplify the task of adding retry behavior to just about anything.\nauthor = Julien Danjou\nauthor_email = julien@danjou.info\nhome_page = https://github.com/jd/tenacity\nclassifier =\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 :: Only\n Programming Language :: Python :: 3.9\n Programming Language :: Python :: 3.10\n Programming Language :: Python :: 3.11\n Programming Language :: Python :: 3.12\n Programming Language :: Python :: 3.13\n Topic :: Utilities\n\n[options]\ninstall_requires =\npython_requires = >=3.9\npackages = find:\n\n[options.packages.find]\ninclude = tenacity*\nexclude = tests\n\n[options.package_data]\ntenacity = py.typed\n\n[options.extras_require]\ndoc =\n reno\n sphinx\ntest =\n pytest\n tornado>=4.5\n typeguard\n\n[tool:pytest]\nfilterwarnings =\n # Show any DeprecationWarnings once\n once::DeprecationWarning\n\n[end of setup.cfg]","filename":"setup.cfg","id":"8"},{"content":"Tenacity\n========\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\n :target: https://pypi.python.org/pypi/tenacity\n\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\n :target: https://circleci.com/gh/jd/tenacity\n\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\n :target: https://mergify.io\n :alt: Mergify Status\n\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\n\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\nPython, to simplify the task of adding retry behavior to just about anything.\nIt originates from `a fork of retrying\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\napi compatible with retrying but adds significant new functionality and\nfixes a number of longstanding bugs.\n\nThe simplest use case is retrying a flaky function whenever an `Exception`\noccurs until a value is returned.\n\n.. testcode::\n\n import random\n from tenacity import retry\n\n @retry\n def do_something_unreliable():\n if random.randint(0, 10) > 1:\n raise IOError(\"Broken sauce, everything is hosed!!!111one\")\n else:\n return \"Awesome sauce!\"\n\n print(do_something_unreliable())\n\n.. testoutput::\n :hide:\n\n Awesome sauce!\n\n\n.. toctree::\n :hidden:\n :maxdepth: 2\n\n changelog\n api\n\n\nFeatures\n--------\n\n- Generic Decorator API\n- Specify stop condition (i.e. limit by number of attempts)\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\n- Customize retrying on Exceptions\n- Customize retrying on expected returned result\n- Retry on coroutines\n- Retry code block with context manager\n\n\nInstallation\n------------\n\nTo install *tenacity*, simply:\n\n.. code-block:: bash\n\n $ pip install tenacity\n\n\nExamples\n----------\n\nBasic Retry\n~~~~~~~~~~~\n\n.. testsetup::\n\n import logging\n #\n # Note the following import is used for demonstration convenience only.\n # Production code should always explicitly import the names it needs.\n #\n from tenacity import *\n\n class MyException(Exception):\n pass\n\nAs you saw above, the default behavior is to retry forever without waiting when\nan exception is raised.\n\n.. testcode::\n\n @retry\n def never_gonna_give_you_up():\n print(\"Retry forever ignoring Exceptions, don't wait between retries\")\n raise Exception\n\nStopping\n~~~~~~~~\n\nLet's be a little less persistent and set some boundaries, such as the number\nof attempts before giving up.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(7))\n def stop_after_7_attempts():\n print(\"Stopping after 7 attempts\")\n raise Exception\n\nWe don't have all day, so let's set a boundary for how long we should be\nretrying stuff.\n\n.. testcode::\n\n @retry(stop=stop_after_delay(10))\n def stop_after_10_s():\n print(\"Stopping after 10 seconds\")\n raise Exception\n\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\nthen you can give up on retries one attempt before you would exceed the delay.\n\n.. testcode::\n\n @retry(stop=stop_before_delay(10))\n def stop_before_10_s():\n print(\"Stopping 1 attempt before 10 seconds\")\n raise Exception\n\nYou can combine several stop conditions by using the `|` operator:\n\n.. testcode::\n\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\n def stop_after_10_s_or_5_retries():\n print(\"Stopping after 10 seconds or 5 retries\")\n raise Exception\n\nWaiting before retrying\n~~~~~~~~~~~~~~~~~~~~~~~\n\nMost things don't like to be polled as fast as possible, so let's just wait 2\nseconds between retries.\n\n.. testcode::\n\n @retry(wait=wait_fixed(2))\n def wait_2_s():\n print(\"Wait 2 second between retries\")\n raise Exception\n\nSome things perform best with a bit of randomness injected.\n\n.. testcode::\n\n @retry(wait=wait_random(min=1, max=2))\n def wait_random_1_to_2_s():\n print(\"Randomly wait 1 to 2 seconds between retries\")\n raise Exception\n\nThen again, it's hard to beat exponential backoff when retrying distributed\nservices and other remote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\n def wait_exponential_1():\n print(\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\")\n raise Exception\n\n\nThen again, it's also hard to beat combining fixed waits and jitter (to\nhelp avoid thundering herds) when retrying distributed services and other\nremote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\n def wait_fixed_jitter():\n print(\"Wait at least 3 seconds, and add up to 2 seconds of random delay\")\n raise Exception\n\nWhen multiple processes are in contention for a shared resource, exponentially\nincreasing jitter helps minimise collisions.\n\n.. testcode::\n\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\n def wait_exponential_jitter():\n print(\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\")\n raise Exception\n\n\nSometimes it's necessary to build a chain of backoffs.\n\n.. testcode::\n\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\n [wait_fixed(7) for i in range(2)] +\n [wait_fixed(9)]))\n def wait_fixed_chained():\n print(\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\")\n raise Exception\n\nWhether to retry\n~~~~~~~~~~~~~~~~\n\nWe have a few options for dealing with retries that raise specific or general\nexceptions, as in the cases here.\n\n.. testcode::\n\n class ClientError(Exception):\n \"\"\"Some type of client error.\"\"\"\n\n @retry(retry=retry_if_exception_type(IOError))\n def might_io_error():\n print(\"Retry forever with no wait if an IOError occurs, raise any other errors\")\n raise Exception\n\n @retry(retry=retry_if_not_exception_type(ClientError))\n def might_client_error():\n print(\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\")\n raise Exception\n\nWe can also use the result of the function to alter the behavior of retrying.\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=retry_if_result(is_none_p))\n def might_return_none():\n print(\"Retry with no wait if return value is None\")\n\nSee also these methods:\n\n.. testcode::\n\n retry_if_exception\n retry_if_exception_type\n retry_if_not_exception_type\n retry_unless_exception_type\n retry_if_result\n retry_if_not_result\n retry_if_exception_message\n retry_if_not_exception_message\n retry_any\n retry_all\n\nWe can also combine several conditions:\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\n def might_return_none():\n print(\"Retry forever ignoring Exceptions with no wait if return value is None\")\n\nAny combination of stop, wait, etc. is also supported to give you the freedom\nto mix and match.\n\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\nexception:\n\n.. testcode::\n\n @retry\n def do_something():\n result = something_else()\n if result == 23:\n raise TryAgain\n\nError Handling\n~~~~~~~~~~~~~~\n\nNormally when your function fails its final time (and will not be retried again based on your settings),\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\nof the stack trace.\n\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\nis most visible), you can set `reraise=True`.\n\n.. testcode::\n\n @retry(reraise=True, stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except MyException:\n # timed out retrying\n pass\n\nBefore and After Retry, and Logging\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIt's possible to execute an action before any attempt of calling the function\nby using the before callback function:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIn the same spirit, It's possible to execute after a call that failed:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIt's also possible to only log failures that are going to be retried. Normally\nretries happen after a wait interval, so the keyword argument is called\n``before_sleep``:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3),\n before_sleep=before_sleep_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n\nStatistics\n~~~~~~~~~~\n\nYou can access the statistics about the retry made over a function by using the\n`statistics` attribute attached to the function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nCustom Callbacks\n~~~~~~~~~~~~~~~~\n\nYou can also define your own callbacks. The callback should accept one\nparameter called ``retry_state`` that contains all information about current\nretry invocation.\n\nFor example, you can call a custom callback function after all retries failed,\nwithout raising an exception (or you can re-raise or do anything really)\n\n.. testcode::\n\n def return_last_value(retry_state):\n \"\"\"return the result of the last call attempt\"\"\"\n return retry_state.outcome.result()\n\n def is_false(value):\n \"\"\"Return True if value is False\"\"\"\n return value is False\n\n # will return False after trying 3 times to get a different result\n @retry(stop=stop_after_attempt(3),\n retry_error_callback=return_last_value,\n retry=retry_if_result(is_false))\n def eventually_return_false():\n return False\n\nRetryCallState\n~~~~~~~~~~~~~~\n\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\n\nOther Custom Callbacks\n~~~~~~~~~~~~~~~~~~~~~~\n\nIt's also possible to define custom callbacks for other keyword arguments.\n\n.. function:: my_stop(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should stop\n :rtype: bool\n\n.. function:: my_wait(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: number of seconds to wait before next retry\n :rtype: float\n\n.. function:: my_retry(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should continue\n :rtype: bool\n\n.. function:: my_before(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_after(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_before_sleep(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\nHere's an example with a custom ``before_sleep`` function:\n\n.. testcode::\n\n import logging\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n def my_before_sleep(retry_state):\n if retry_state.attempt_number < 1:\n loglevel = logging.INFO\n else:\n loglevel = logging.WARNING\n logger.log(\n loglevel, 'Retrying %s: attempt %s ended with: %s',\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\n\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except RetryError:\n pass\n\n\nChanging Arguments at Run Time\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can change the arguments of a retry decorator as needed when calling it by\nusing the `retry_with` function attached to the wrapped function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nIf you want to use variables to set up the retry parameters, you don't have\nto use the `retry` decorator - you can instead use `Retrying` directly:\n\n.. testcode::\n\n def never_good_enough(arg1):\n raise Exception('Invalid argument: {}'.format(arg1))\n\n def try_never_good_enough(max_attempts=3):\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\n retryer(never_good_enough, 'I really do try')\n\nYou may also want to change the behaviour of a decorated function temporarily,\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\nattribute attached to the function. Bear in mind this is a write-only attribute,\nstatistics should be read from the function `statistics` attribute.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n from unittest import mock\n\n with mock.patch.object(raise_my_exception.retry, \"wait\", wait_fixed(0)):\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nRetrying code block\n~~~~~~~~~~~~~~~~~~~\n\nTenacity allows you to retry a code block without the need to wraps it in an\nisolated function. This makes it easy to isolate failing block while sharing\ncontext. The trick is to combine a for loop and a context manager.\n\n.. testcode::\n\n from tenacity import Retrying, RetryError, stop_after_attempt\n\n try:\n for attempt in Retrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nYou can configure every details of retry policy by configuring the Retrying\nobject.\n\nWith async code you can use AsyncRetrying.\n\n.. testcode::\n\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\n\n async def function():\n try:\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nIn both cases, you may want to set the result to the attempt so it's available\nin retry strategies like ``retry_if_result``. This can be done accessing the\n``retry_state`` property:\n\n.. testcode::\n\n from tenacity import AsyncRetrying, retry_if_result\n\n async def function():\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\n with attempt:\n result = 1 # Some complex calculation, function call, etc.\n if not attempt.retry_state.outcome.failed:\n attempt.retry_state.set_result(result)\n return result\n\nAsync and retry\n~~~~~~~~~~~~~~~\n\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\nSleeps are done asynchronously too.\n\n.. code-block:: python\n\n @retry\n async def my_asyncio_function(loop):\n await loop.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n async def my_async_trio_function():\n await trio.socket.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n @tornado.gen.coroutine\n def my_async_tornado_function(http_client, url):\n yield http_client.fetch(url)\n\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\n\n.. code-block:: python\n\n @retry(sleep=curio.sleep)\n async def my_async_curio_function():\n await asks.get('https://example.org')\n\nContribute\n----------\n\n#. Check for open issues or open a fresh issue to start a discussion around a\n feature idea or a bug.\n#. Fork `the repository`_ on GitHub to start making your changes to the\n **main** branch (or branch off of it).\n#. Write a test which shows that the bug was fixed or that the feature works as\n expected.\n#. Add a `changelog <#Changelogs>`_\n#. Make the docs better (or more detailed, or more easier to read, or ...)\n\n.. _`the repository`: https://github.com/jd/tenacity\n\nChangelogs\n~~~~~~~~~~\n\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\n\nThe doc generation will automatically compile the changelogs. You just need to add them.\n\n.. code-block:: sh\n\n # Opens a template file in an editor\n tox -e reno -- new some-slug-for-my-change --edit\n\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\n\n[end of README.rst]","filename":"README.rst","id":"9"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef before_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"Before call strategy that does nothing.\"\"\"\n\n\ndef before_log(\n logger: \"logging.Logger\", log_level: int\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"Before call strategy that logs to some logger the attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n logger.log(\n log_level,\n f\"Starting call to '{fn_name}', \"\n f\"this is the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\",\n )\n\n return log_it\n\n[end of tenacity/before.py]","filename":"tenacity/before.py","id":"10"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef before_sleep_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"Before sleep strategy that does nothing.\"\"\"\n\n\ndef before_sleep_log(\n logger: \"logging.Logger\",\n log_level: int,\n exc_info: bool = False,\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"Before sleep strategy that logs to some logger the attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n local_exc_info: BaseException | bool | None\n\n if retry_state.outcome is None:\n raise RuntimeError(\"log_it() called before outcome was set\")\n\n if retry_state.next_action is None:\n raise RuntimeError(\"log_it() called before next_action was set\")\n\n if retry_state.outcome.failed:\n ex = retry_state.outcome.exception()\n verb, value = \"raised\", f\"{ex.__class__.__name__}: {ex}\"\n\n if exc_info:\n local_exc_info = retry_state.outcome.exception()\n else:\n local_exc_info = False\n else:\n verb, value = \"returned\", retry_state.outcome.result()\n local_exc_info = False # exc_info does not apply when no exception\n\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n\n logger.log(\n log_level,\n f\"Retrying {fn_name} \"\n f\"in {retry_state.next_action.sleep} seconds as it {verb} {value}.\",\n exc_info=local_exc_info,\n )\n\n return log_it\n\n[end of tenacity/before_sleep.py]","filename":"tenacity/before_sleep.py","id":"11"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport abc\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import threading\n\n from tenacity import RetryCallState\n\n\nclass stop_base(abc.ABC):\n \"\"\"Abstract base class for stop strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n pass\n\n def __and__(self, other: \"stop_base\") -> \"stop_all\":\n return stop_all(self, other)\n\n def __or__(self, other: \"stop_base\") -> \"stop_any\":\n return stop_any(self, other)\n\n\nStopBaseT = typing.Union[stop_base, typing.Callable[[\"RetryCallState\"], bool]]\n\n\nclass stop_any(stop_base):\n \"\"\"Stop if any of the stop condition is valid.\"\"\"\n\n def __init__(self, *stops: stop_base) -> None:\n self.stops = stops\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return any(x(retry_state) for x in self.stops)\n\n\nclass stop_all(stop_base):\n \"\"\"Stop if all the stop conditions are valid.\"\"\"\n\n def __init__(self, *stops: stop_base) -> None:\n self.stops = stops\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return all(x(retry_state) for x in self.stops)\n\n\nclass _stop_never(stop_base):\n \"\"\"Never stop.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return False\n\n\nstop_never = _stop_never()\n\n\nclass stop_when_event_set(stop_base):\n \"\"\"Stop when the given event is set.\"\"\"\n\n def __init__(self, event: \"threading.Event\") -> None:\n self.event = event\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return self.event.is_set()\n\n\nclass stop_after_attempt(stop_base):\n \"\"\"Stop when the previous attempt >= max_attempt.\"\"\"\n\n def __init__(self, max_attempt_number: int) -> None:\n self.max_attempt_number = max_attempt_number\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return retry_state.attempt_number >= self.max_attempt_number\n\n\nclass stop_after_delay(stop_base):\n \"\"\"\n Stop when the time from the first attempt >= limit.\n\n Note: `max_delay` will be exceeded, so when used with a `wait`, the actual total delay will be greater\n than `max_delay` by some of the final sleep period before `max_delay` is exceeded.\n\n If you need stricter timing with waits, consider `stop_before_delay` instead.\n \"\"\"\n\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\n self.max_delay = _utils.to_seconds(max_delay)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.seconds_since_start is None:\n raise RuntimeError(\"__call__() called but seconds_since_start is not set\")\n return retry_state.seconds_since_start >= self.max_delay\n\n\nclass stop_before_delay(stop_base):\n \"\"\"\n Stop right before the next attempt would take place after the time from the first attempt >= limit.\n\n Most useful when you are using with a `wait` function like wait_random_exponential, but need to make\n sure that the max_delay is not exceeded.\n \"\"\"\n\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\n self.max_delay = _utils.to_seconds(max_delay)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.seconds_since_start is None:\n raise RuntimeError(\"__call__() called but seconds_since_start is not set\")\n return (\n retry_state.seconds_since_start + retry_state.upcoming_sleep\n >= self.max_delay\n )\n\n[end of tenacity/stop.py]","filename":"tenacity/stop.py","id":"12"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport abc\nimport random\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass wait_base(abc.ABC):\n \"\"\"Abstract base class for wait strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n pass\n\n def __add__(self, other: \"wait_base\") -> \"wait_combine\":\n return wait_combine(self, other)\n\n def __radd__(self, other: \"wait_base\") -> typing.Union[\"wait_combine\", \"wait_base\"]:\n # make it possible to use multiple waits with the built-in sum function\n if other == 0: # type: ignore[comparison-overlap]\n return self\n return self.__add__(other)\n\n\nWaitBaseT = typing.Union[\n wait_base, typing.Callable[[\"RetryCallState\"], typing.Union[float, int]]\n]\n\n\nclass wait_fixed(wait_base):\n \"\"\"Wait strategy that waits a fixed amount of time between each retry.\"\"\"\n\n def __init__(self, wait: _utils.time_unit_type) -> None:\n self.wait_fixed = _utils.to_seconds(wait)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return self.wait_fixed\n\n\nclass wait_none(wait_fixed):\n \"\"\"Wait strategy that doesn't wait at all before retrying.\"\"\"\n\n def __init__(self) -> None:\n super().__init__(0)\n\n\nclass wait_random(wait_base):\n \"\"\"Wait strategy that waits a random amount of time between min/max.\"\"\"\n\n def __init__(\n self, min: _utils.time_unit_type = 0, max: _utils.time_unit_type = 1\n ) -> None: # noqa\n self.wait_random_min = _utils.to_seconds(min)\n self.wait_random_max = _utils.to_seconds(max)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return self.wait_random_min + (\n random.random() * (self.wait_random_max - self.wait_random_min)\n )\n\n\nclass wait_combine(wait_base):\n \"\"\"Combine several waiting strategies.\"\"\"\n\n def __init__(self, *strategies: wait_base) -> None:\n self.wait_funcs = strategies\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return sum(x(retry_state=retry_state) for x in self.wait_funcs)\n\n\nclass wait_chain(wait_base):\n \"\"\"Chain two or more waiting strategies.\n\n If all strategies are exhausted, the very last strategy is used\n thereafter.\n\n For example::\n\n @retry(wait=wait_chain(*[wait_fixed(1) for i in range(3)] +\n [wait_fixed(2) for j in range(5)] +\n [wait_fixed(5) for k in range(4)))\n def wait_chained():\n print(\"Wait 1s for 3 attempts, 2s for 5 attempts and 5s\n thereafter.\")\n \"\"\"\n\n def __init__(self, *strategies: wait_base) -> None:\n self.strategies = strategies\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n wait_func_no = min(max(retry_state.attempt_number, 1), len(self.strategies))\n wait_func = self.strategies[wait_func_no - 1]\n return wait_func(retry_state=retry_state)\n\n\nclass wait_incrementing(wait_base):\n \"\"\"Wait an incremental amount of time after each attempt.\n\n Starting at a starting value and incrementing by a value for each attempt\n (and restricting the upper limit to some maximum value).\n \"\"\"\n\n def __init__(\n self,\n start: _utils.time_unit_type = 0,\n increment: _utils.time_unit_type = 100,\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\n ) -> None:\n self.start = _utils.to_seconds(start)\n self.increment = _utils.to_seconds(increment)\n self.max = _utils.to_seconds(max)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n result = self.start + (self.increment * (retry_state.attempt_number - 1))\n return max(0, min(result, self.max))\n\n\nclass wait_exponential(wait_base):\n \"\"\"Wait strategy that applies exponential backoff.\n\n It allows for a customized multiplier and an ability to restrict the\n upper and lower limits to some maximum and minimum value.\n\n The intervals are fixed (i.e. there is no jitter), so this strategy is\n suitable for balancing retries against latency when a required resource is\n unavailable for an unknown duration, but *not* suitable for resolving\n contention between multiple processes for a shared resource. Use\n wait_random_exponential for the latter case.\n \"\"\"\n\n def __init__(\n self,\n multiplier: typing.Union[int, float] = 1,\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\n exp_base: typing.Union[int, float] = 2,\n min: _utils.time_unit_type = 0, # noqa\n ) -> None:\n self.multiplier = multiplier\n self.min = _utils.to_seconds(min)\n self.max = _utils.to_seconds(max)\n self.exp_base = exp_base\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n try:\n exp = self.exp_base ** (retry_state.attempt_number - 1)\n result = self.multiplier * exp\n except OverflowError:\n return self.max\n return max(max(0, self.min), min(result, self.max))\n\n\nclass wait_random_exponential(wait_exponential):\n \"\"\"Random wait with exponentially widening window.\n\n An exponential backoff strategy used to mediate contention between multiple\n uncoordinated processes for a shared resource in distributed systems. This\n is the sense in which \"exponential backoff\" is meant in e.g. Ethernet\n networking, and corresponds to the \"Full Jitter\" algorithm described in\n this blog post:\n\n https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/\n\n Each retry occurs at a random time in a geometrically expanding interval.\n It allows for a custom multiplier and an ability to restrict the upper\n limit of the random interval to some maximum value.\n\n Example::\n\n wait_random_exponential(multiplier=0.5, # initial window 0.5s\n max=60) # max 60s timeout\n\n When waiting for an unavailable resource to become available again, as\n opposed to trying to resolve contention for a shared resource, the\n wait_exponential strategy (which uses a fixed interval) may be preferable.\n\n \"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n high = super().__call__(retry_state=retry_state)\n return random.uniform(self.min, high)\n\n\nclass wait_exponential_jitter(wait_base):\n \"\"\"Wait strategy that applies exponential backoff and jitter.\n\n It allows for a customized initial wait, maximum wait and jitter.\n\n This implements the strategy described here:\n https://cloud.google.com/storage/docs/retry-strategy\n\n The wait time is min(initial * 2**n + random.uniform(0, jitter), maximum)\n where n is the retry count.\n \"\"\"\n\n def __init__(\n self,\n initial: float = 1,\n max: float = _utils.MAX_WAIT, # noqa\n exp_base: float = 2,\n jitter: float = 1,\n ) -> None:\n self.initial = initial\n self.max = max\n self.exp_base = exp_base\n self.jitter = jitter\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n jitter = random.uniform(0, self.jitter)\n try:\n exp = self.exp_base ** (retry_state.attempt_number - 1)\n result = self.initial * exp + jitter\n except OverflowError:\n result = self.max\n return max(0, min(result, self.max))\n\n[end of tenacity/wait.py]","filename":"tenacity/wait.py","id":"13"},{"content":"# Copyright 2016-2018 Julien Danjou\n# Copyright 2017 Elisey Zanko\n# Copyright 2016 Étienne Bersac\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport dataclasses\nimport functools\nimport sys\nimport threading\nimport time\nimport typing as t\nimport warnings\nfrom abc import ABC, abstractmethod\nfrom concurrent import futures\n\nfrom . import _utils\n\n# Import all built-in retry strategies for easier usage.\nfrom .retry import retry_base # noqa\nfrom .retry import retry_all # noqa\nfrom .retry import retry_always # noqa\nfrom .retry import retry_any # noqa\nfrom .retry import retry_if_exception # noqa\nfrom .retry import retry_if_exception_type # noqa\nfrom .retry import retry_if_exception_cause_type # noqa\nfrom .retry import retry_if_not_exception_type # noqa\nfrom .retry import retry_if_not_result # noqa\nfrom .retry import retry_if_result # noqa\nfrom .retry import retry_never # noqa\nfrom .retry import retry_unless_exception_type # noqa\nfrom .retry import retry_if_exception_message # noqa\nfrom .retry import retry_if_not_exception_message # noqa\n\n# Import all nap strategies for easier usage.\nfrom .nap import sleep # noqa\nfrom .nap import sleep_using_event # noqa\n\n# Import all built-in stop strategies for easier usage.\nfrom .stop import stop_after_attempt # noqa\nfrom .stop import stop_after_delay # noqa\nfrom .stop import stop_before_delay # noqa\nfrom .stop import stop_all # noqa\nfrom .stop import stop_any # noqa\nfrom .stop import stop_never # noqa\nfrom .stop import stop_when_event_set # noqa\n\n# Import all built-in wait strategies for easier usage.\nfrom .wait import wait_chain # noqa\nfrom .wait import wait_combine # noqa\nfrom .wait import wait_exponential # noqa\nfrom .wait import wait_fixed # noqa\nfrom .wait import wait_incrementing # noqa\nfrom .wait import wait_none # noqa\nfrom .wait import wait_random # noqa\nfrom .wait import wait_random_exponential # noqa\nfrom .wait import wait_random_exponential as wait_full_jitter # noqa\nfrom .wait import wait_exponential_jitter # noqa\n\n# Import all built-in before strategies for easier usage.\nfrom .before import before_log # noqa\nfrom .before import before_nothing # noqa\n\n# Import all built-in after strategies for easier usage.\nfrom .after import after_log # noqa\nfrom .after import after_nothing # noqa\n\n# Import all built-in before sleep strategies for easier usage.\nfrom .before_sleep import before_sleep_log # noqa\nfrom .before_sleep import before_sleep_nothing # noqa\n\ntry:\n import tornado\nexcept ImportError:\n tornado = None\n\nif t.TYPE_CHECKING:\n import types\n\n from typing_extensions import Self\n\n from . import asyncio as tasyncio\n from .retry import RetryBaseT\n from .stop import StopBaseT\n from .wait import WaitBaseT\n\n\nWrappedFnReturnT = t.TypeVar(\"WrappedFnReturnT\")\nWrappedFn = t.TypeVar(\"WrappedFn\", bound=t.Callable[..., t.Any])\n\n\ndataclass_kwargs = {}\nif sys.version_info >= (3, 10):\n dataclass_kwargs.update({\"slots\": True})\n\n\n@dataclasses.dataclass(**dataclass_kwargs)\nclass IterState:\n actions: t.List[t.Callable[[\"RetryCallState\"], t.Any]] = dataclasses.field(\n default_factory=list\n )\n retry_run_result: bool = False\n delay_since_first_attempt: int = 0\n stop_run_result: bool = False\n is_explicit_retry: bool = False\n\n def reset(self) -> None:\n self.actions = []\n self.retry_run_result = False\n self.delay_since_first_attempt = 0\n self.stop_run_result = False\n self.is_explicit_retry = False\n\n\nclass TryAgain(Exception):\n \"\"\"Always retry the executed function when raised.\"\"\"\n\n\nNO_RESULT = object()\n\n\nclass DoAttempt:\n pass\n\n\nclass DoSleep(float):\n pass\n\n\nclass BaseAction:\n \"\"\"Base class for representing actions to take by retry object.\n\n Concrete implementations must define:\n - __init__: to initialize all necessary fields\n - REPR_FIELDS: class variable specifying attributes to include in repr(self)\n - NAME: for identification in retry object methods and callbacks\n \"\"\"\n\n REPR_FIELDS: t.Sequence[str] = ()\n NAME: t.Optional[str] = None\n\n def __repr__(self) -> str:\n state_str = \", \".join(\n f\"{field}={getattr(self, field)!r}\" for field in self.REPR_FIELDS\n )\n return f\"{self.__class__.__name__}({state_str})\"\n\n def __str__(self) -> str:\n return repr(self)\n\n\nclass RetryAction(BaseAction):\n REPR_FIELDS = (\"sleep\",)\n NAME = \"retry\"\n\n def __init__(self, sleep: t.SupportsFloat) -> None:\n self.sleep = float(sleep)\n\n\n_unset = object()\n\n\ndef _first_set(first: t.Union[t.Any, object], second: t.Any) -> t.Any:\n return second if first is _unset else first\n\n\nclass RetryError(Exception):\n \"\"\"Encapsulates the last attempt instance right before giving up.\"\"\"\n\n def __init__(self, last_attempt: \"Future\") -> None:\n self.last_attempt = last_attempt\n super().__init__(last_attempt)\n\n def reraise(self) -> t.NoReturn:\n if self.last_attempt.failed:\n raise self.last_attempt.result()\n raise self\n\n def __str__(self) -> str:\n return f\"{self.__class__.__name__}[{self.last_attempt}]\"\n\n\nclass AttemptManager:\n \"\"\"Manage attempt context.\"\"\"\n\n def __init__(self, retry_state: \"RetryCallState\"):\n self.retry_state = retry_state\n\n def __enter__(self) -> None:\n pass\n\n def __exit__(\n self,\n exc_type: t.Optional[t.Type[BaseException]],\n exc_value: t.Optional[BaseException],\n traceback: t.Optional[\"types.TracebackType\"],\n ) -> t.Optional[bool]:\n if exc_type is not None and exc_value is not None:\n self.retry_state.set_exception((exc_type, exc_value, traceback))\n return True # Swallow exception.\n else:\n # We don't have the result, actually.\n self.retry_state.set_result(None)\n return None\n\n\nclass BaseRetrying(ABC):\n def __init__(\n self,\n sleep: t.Callable[[t.Union[int, float]], None] = sleep,\n stop: \"StopBaseT\" = stop_never,\n wait: \"WaitBaseT\" = wait_none(),\n retry: \"RetryBaseT\" = retry_if_exception_type(),\n before: t.Callable[[\"RetryCallState\"], None] = before_nothing,\n after: t.Callable[[\"RetryCallState\"], None] = after_nothing,\n before_sleep: t.Optional[t.Callable[[\"RetryCallState\"], None]] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[RetryError] = RetryError,\n retry_error_callback: t.Optional[t.Callable[[\"RetryCallState\"], t.Any]] = None,\n ):\n self.sleep = sleep\n self.stop = stop\n self.wait = wait\n self.retry = retry\n self.before = before\n self.after = after\n self.before_sleep = before_sleep\n self.reraise = reraise\n self._local = threading.local()\n self.retry_error_cls = retry_error_cls\n self.retry_error_callback = retry_error_callback\n\n def copy(\n self,\n sleep: t.Union[t.Callable[[t.Union[int, float]], None], object] = _unset,\n stop: t.Union[\"StopBaseT\", object] = _unset,\n wait: t.Union[\"WaitBaseT\", object] = _unset,\n retry: t.Union[retry_base, object] = _unset,\n before: t.Union[t.Callable[[\"RetryCallState\"], None], object] = _unset,\n after: t.Union[t.Callable[[\"RetryCallState\"], None], object] = _unset,\n before_sleep: t.Union[\n t.Optional[t.Callable[[\"RetryCallState\"], None]], object\n ] = _unset,\n reraise: t.Union[bool, object] = _unset,\n retry_error_cls: t.Union[t.Type[RetryError], object] = _unset,\n retry_error_callback: t.Union[\n t.Optional[t.Callable[[\"RetryCallState\"], t.Any]], object\n ] = _unset,\n ) -> \"Self\":\n \"\"\"Copy this object with some parameters changed if needed.\"\"\"\n return self.__class__(\n sleep=_first_set(sleep, self.sleep),\n stop=_first_set(stop, self.stop),\n wait=_first_set(wait, self.wait),\n retry=_first_set(retry, self.retry),\n before=_first_set(before, self.before),\n after=_first_set(after, self.after),\n before_sleep=_first_set(before_sleep, self.before_sleep),\n reraise=_first_set(reraise, self.reraise),\n retry_error_cls=_first_set(retry_error_cls, self.retry_error_cls),\n retry_error_callback=_first_set(\n retry_error_callback, self.retry_error_callback\n ),\n )\n\n def __repr__(self) -> str:\n return (\n f\"<{self.__class__.__name__} object at 0x{id(self):x} (\"\n f\"stop={self.stop}, \"\n f\"wait={self.wait}, \"\n f\"sleep={self.sleep}, \"\n f\"retry={self.retry}, \"\n f\"before={self.before}, \"\n f\"after={self.after})>\"\n )\n\n @property\n def statistics(self) -> t.Dict[str, t.Any]:\n \"\"\"Return a dictionary of runtime statistics.\n\n This dictionary will be empty when the controller has never been\n ran. When it is running or has ran previously it should have (but\n may not) have useful and/or informational keys and values when\n running is underway and/or completed.\n\n .. warning:: The keys in this dictionary **should** be some what\n stable (not changing), but there existence **may**\n change between major releases as new statistics are\n gathered or removed so before accessing keys ensure that\n they actually exist and handle when they do not.\n\n .. note:: The values in this dictionary are local to the thread\n running call (so if multiple threads share the same retrying\n object - either directly or indirectly) they will each have\n there own view of statistics they have collected (in the\n future we may provide a way to aggregate the various\n statistics from each thread).\n \"\"\"\n try:\n return self._local.statistics # type: ignore[no-any-return]\n except AttributeError:\n self._local.statistics = t.cast(t.Dict[str, t.Any], {})\n return self._local.statistics\n\n @property\n def iter_state(self) -> IterState:\n try:\n return self._local.iter_state # type: ignore[no-any-return]\n except AttributeError:\n self._local.iter_state = IterState()\n return self._local.iter_state\n\n def wraps(self, f: WrappedFn) -> WrappedFn:\n \"\"\"Wrap a function for retrying.\n\n :param f: A function to wraps for retrying.\n \"\"\"\n\n @functools.wraps(\n f, functools.WRAPPER_ASSIGNMENTS + (\"__defaults__\", \"__kwdefaults__\")\n )\n def wrapped_f(*args: t.Any, **kw: t.Any) -> t.Any:\n # Always create a copy to prevent overwriting the local contexts when\n # calling the same wrapped functions multiple times in the same stack\n copy = self.copy()\n wrapped_f.statistics = copy.statistics # type: ignore[attr-defined]\n return copy(f, *args, **kw)\n\n def retry_with(*args: t.Any, **kwargs: t.Any) -> WrappedFn:\n return self.copy(*args, **kwargs).wraps(f)\n\n # Preserve attributes\n wrapped_f.retry = self # type: ignore[attr-defined]\n wrapped_f.retry_with = retry_with # type: ignore[attr-defined]\n wrapped_f.statistics = {} # type: ignore[attr-defined]\n\n return wrapped_f # type: ignore[return-value]\n\n def begin(self) -> None:\n self.statistics.clear()\n self.statistics[\"start_time\"] = time.monotonic()\n self.statistics[\"attempt_number\"] = 1\n self.statistics[\"idle_for\"] = 0\n\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\n self.iter_state.actions.append(fn)\n\n def _run_retry(self, retry_state: \"RetryCallState\") -> None:\n self.iter_state.retry_run_result = self.retry(retry_state)\n\n def _run_wait(self, retry_state: \"RetryCallState\") -> None:\n if self.wait:\n sleep = self.wait(retry_state)\n else:\n sleep = 0.0\n\n retry_state.upcoming_sleep = sleep\n\n def _run_stop(self, retry_state: \"RetryCallState\") -> None:\n self.statistics[\"delay_since_first_attempt\"] = retry_state.seconds_since_start\n self.iter_state.stop_run_result = self.stop(retry_state)\n\n def iter(self, retry_state: \"RetryCallState\") -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa\n self._begin_iter(retry_state)\n result = None\n for action in self.iter_state.actions:\n result = action(retry_state)\n return result\n\n def _begin_iter(self, retry_state: \"RetryCallState\") -> None: # noqa\n self.iter_state.reset()\n\n fut = retry_state.outcome\n if fut is None:\n if self.before is not None:\n self._add_action_func(self.before)\n self._add_action_func(lambda rs: DoAttempt())\n return\n\n self.iter_state.is_explicit_retry = fut.failed and isinstance(\n fut.exception(), TryAgain\n )\n if not self.iter_state.is_explicit_retry:\n self._add_action_func(self._run_retry)\n self._add_action_func(self._post_retry_check_actions)\n\n def _post_retry_check_actions(self, retry_state: \"RetryCallState\") -> None:\n if not (self.iter_state.is_explicit_retry or self.iter_state.retry_run_result):\n self._add_action_func(lambda rs: rs.outcome.result())\n return\n\n if self.after is not None:\n self._add_action_func(self.after)\n\n self._add_action_func(self._run_wait)\n self._add_action_func(self._run_stop)\n self._add_action_func(self._post_stop_check_actions)\n\n def _post_stop_check_actions(self, retry_state: \"RetryCallState\") -> None:\n if self.iter_state.stop_run_result:\n if self.retry_error_callback:\n self._add_action_func(self.retry_error_callback)\n return\n\n def exc_check(rs: \"RetryCallState\") -> None:\n fut = t.cast(Future, rs.outcome)\n retry_exc = self.retry_error_cls(fut)\n if self.reraise:\n raise retry_exc.reraise()\n raise retry_exc from fut.exception()\n\n self._add_action_func(exc_check)\n return\n\n def next_action(rs: \"RetryCallState\") -> None:\n sleep = rs.upcoming_sleep\n rs.next_action = RetryAction(sleep)\n rs.idle_for += sleep\n self.statistics[\"idle_for\"] += sleep\n self.statistics[\"attempt_number\"] += 1\n\n self._add_action_func(next_action)\n\n if self.before_sleep is not None:\n self._add_action_func(self.before_sleep)\n\n self._add_action_func(lambda rs: DoSleep(rs.upcoming_sleep))\n\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\n self.begin()\n\n retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n yield AttemptManager(retry_state=retry_state)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n self.sleep(do)\n else:\n break\n\n @abstractmethod\n def __call__(\n self,\n fn: t.Callable[..., WrappedFnReturnT],\n *args: t.Any,\n **kwargs: t.Any,\n ) -> WrappedFnReturnT:\n pass\n\n\nclass Retrying(BaseRetrying):\n \"\"\"Retrying controller.\"\"\"\n\n def __call__(\n self,\n fn: t.Callable[..., WrappedFnReturnT],\n *args: t.Any,\n **kwargs: t.Any,\n ) -> WrappedFnReturnT:\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n self.sleep(do)\n else:\n return do # type: ignore[no-any-return]\n\n\nif sys.version_info >= (3, 9):\n FutureGenericT = futures.Future[t.Any]\nelse:\n FutureGenericT = futures.Future\n\n\nclass Future(FutureGenericT):\n \"\"\"Encapsulates a (future or past) attempted call to a target function.\"\"\"\n\n def __init__(self, attempt_number: int) -> None:\n super().__init__()\n self.attempt_number = attempt_number\n\n @property\n def failed(self) -> bool:\n \"\"\"Return whether a exception is being held in this future.\"\"\"\n return self.exception() is not None\n\n @classmethod\n def construct(\n cls, attempt_number: int, value: t.Any, has_exception: bool\n ) -> \"Future\":\n \"\"\"Construct a new Future object.\"\"\"\n fut = cls(attempt_number)\n if has_exception:\n fut.set_exception(value)\n else:\n fut.set_result(value)\n return fut\n\n\nclass RetryCallState:\n \"\"\"State related to a single call wrapped with Retrying.\"\"\"\n\n def __init__(\n self,\n retry_object: BaseRetrying,\n fn: t.Optional[WrappedFn],\n args: t.Any,\n kwargs: t.Any,\n ) -> None:\n #: Retry call start timestamp\n self.start_time = time.monotonic()\n #: Retry manager object\n self.retry_object = retry_object\n #: Function wrapped by this retry call\n self.fn = fn\n #: Arguments of the function wrapped by this retry call\n self.args = args\n #: Keyword arguments of the function wrapped by this retry call\n self.kwargs = kwargs\n\n #: The number of the current attempt\n self.attempt_number: int = 1\n #: Last outcome (result or exception) produced by the function\n self.outcome: t.Optional[Future] = None\n #: Timestamp of the last outcome\n self.outcome_timestamp: t.Optional[float] = None\n #: Time spent sleeping in retries\n self.idle_for: float = 0.0\n #: Next action as decided by the retry manager\n self.next_action: t.Optional[RetryAction] = None\n #: Next sleep time as decided by the retry manager.\n self.upcoming_sleep: float = 0.0\n\n @property\n def seconds_since_start(self) -> t.Optional[float]:\n if self.outcome_timestamp is None:\n return None\n return self.outcome_timestamp - self.start_time\n\n def prepare_for_next_attempt(self) -> None:\n self.outcome = None\n self.outcome_timestamp = None\n self.attempt_number += 1\n self.next_action = None\n\n def set_result(self, val: t.Any) -> None:\n ts = time.monotonic()\n fut = Future(self.attempt_number)\n fut.set_result(val)\n self.outcome, self.outcome_timestamp = fut, ts\n\n def set_exception(\n self,\n exc_info: t.Tuple[\n t.Type[BaseException], BaseException, \"types.TracebackType| None\"\n ],\n ) -> None:\n ts = time.monotonic()\n fut = Future(self.attempt_number)\n fut.set_exception(exc_info[1])\n self.outcome, self.outcome_timestamp = fut, ts\n\n def __repr__(self) -> str:\n if self.outcome is None:\n result = \"none yet\"\n elif self.outcome.failed:\n exception = self.outcome.exception()\n result = f\"failed ({exception.__class__.__name__} {exception})\"\n else:\n result = f\"returned {self.outcome.result()}\"\n\n slept = float(round(self.idle_for, 2))\n clsname = self.__class__.__name__\n return f\"<{clsname} {id(self)}: attempt #{self.attempt_number}; slept for {slept}; last result: {result}>\"\n\n\n@t.overload\ndef retry(func: WrappedFn) -> WrappedFn: ...\n\n\n@t.overload\ndef retry(\n sleep: t.Callable[[t.Union[int, float]], t.Union[None, t.Awaitable[None]]] = sleep,\n stop: \"StopBaseT\" = stop_never,\n wait: \"WaitBaseT\" = wait_none(),\n retry: \"t.Union[RetryBaseT, tasyncio.retry.RetryBaseT]\" = retry_if_exception_type(),\n before: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = before_nothing,\n after: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = after_nothing,\n before_sleep: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[None, t.Awaitable[None]]]\n ] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[\"RetryError\"] = RetryError,\n retry_error_callback: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[t.Any, t.Awaitable[t.Any]]]\n ] = None,\n) -> t.Callable[[WrappedFn], WrappedFn]: ...\n\n\ndef retry(*dargs: t.Any, **dkw: t.Any) -> t.Any:\n \"\"\"Wrap a function with a new `Retrying` object.\n\n :param dargs: positional arguments passed to Retrying object\n :param dkw: keyword arguments passed to the Retrying object\n \"\"\"\n # support both @retry and @retry() as valid syntax\n if len(dargs) == 1 and callable(dargs[0]):\n return retry()(dargs[0])\n else:\n\n def wrap(f: WrappedFn) -> WrappedFn:\n if isinstance(f, retry_base):\n warnings.warn(\n f\"Got retry_base instance ({f.__class__.__name__}) as callable argument, \"\n f\"this will probably hang indefinitely (did you mean retry={f.__class__.__name__}(...)?)\"\n )\n r: \"BaseRetrying\"\n if _utils.is_coroutine_callable(f):\n r = AsyncRetrying(*dargs, **dkw)\n elif (\n tornado\n and hasattr(tornado.gen, \"is_coroutine_function\")\n and tornado.gen.is_coroutine_function(f)\n ):\n r = TornadoRetrying(*dargs, **dkw)\n else:\n r = Retrying(*dargs, **dkw)\n\n return r.wraps(f)\n\n return wrap\n\n\nfrom tenacity.asyncio import AsyncRetrying # noqa:E402,I100\n\nif tornado:\n from tenacity.tornadoweb import TornadoRetrying\n\n\n__all__ = [\n \"retry_base\",\n \"retry_all\",\n \"retry_always\",\n \"retry_any\",\n \"retry_if_exception\",\n \"retry_if_exception_type\",\n \"retry_if_exception_cause_type\",\n \"retry_if_not_exception_type\",\n \"retry_if_not_result\",\n \"retry_if_result\",\n \"retry_never\",\n \"retry_unless_exception_type\",\n \"retry_if_exception_message\",\n \"retry_if_not_exception_message\",\n \"sleep\",\n \"sleep_using_event\",\n \"stop_after_attempt\",\n \"stop_after_delay\",\n \"stop_before_delay\",\n \"stop_all\",\n \"stop_any\",\n \"stop_never\",\n \"stop_when_event_set\",\n \"wait_chain\",\n \"wait_combine\",\n \"wait_exponential\",\n \"wait_fixed\",\n \"wait_incrementing\",\n \"wait_none\",\n \"wait_random\",\n \"wait_random_exponential\",\n \"wait_full_jitter\",\n \"wait_exponential_jitter\",\n \"before_log\",\n \"before_nothing\",\n \"after_log\",\n \"after_nothing\",\n \"before_sleep_log\",\n \"before_sleep_nothing\",\n \"retry\",\n \"WrappedFn\",\n \"TryAgain\",\n \"NO_RESULT\",\n \"DoAttempt\",\n \"DoSleep\",\n \"BaseAction\",\n \"RetryAction\",\n \"RetryError\",\n \"AttemptManager\",\n \"BaseRetrying\",\n \"Retrying\",\n \"Future\",\n \"RetryCallState\",\n \"AsyncRetrying\",\n]\n\n[end of tenacity/__init__.py]","filename":"tenacity/__init__.py","id":"14"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport time\nimport typing\n\nif typing.TYPE_CHECKING:\n import threading\n\n\ndef sleep(seconds: float) -> None:\n \"\"\"\n Sleep strategy that delays execution for a given number of seconds.\n\n This is the default strategy, and may be mocked out for unit testing.\n \"\"\"\n time.sleep(seconds)\n\n\nclass sleep_using_event:\n \"\"\"Sleep strategy that waits on an event to be set.\"\"\"\n\n def __init__(self, event: \"threading.Event\") -> None:\n self.event = event\n\n def __call__(self, timeout: typing.Optional[float]) -> None:\n # NOTE(harlowja): this may *not* actually wait for timeout\n # seconds if the event is set (ie this may eject out early).\n self.event.wait(timeout=timeout)\n\n[end of tenacity/nap.py]","filename":"tenacity/nap.py","id":"15"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef after_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"After call strategy that does nothing.\"\"\"\n\n\ndef after_log(\n logger: \"logging.Logger\",\n log_level: int,\n sec_format: str = \"%0.3f\",\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"After call strategy that logs to some logger the finished attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n logger.log(\n log_level,\n f\"Finished call to '{fn_name}' \"\n f\"after {sec_format % retry_state.seconds_since_start}(s), \"\n f\"this was the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\",\n )\n\n return log_it\n\n[end of tenacity/after.py]","filename":"tenacity/after.py","id":"16"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport abc\nimport re\nimport typing\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass retry_base(abc.ABC):\n \"\"\"Abstract base class for retry strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n pass\n\n def __and__(self, other: \"retry_base\") -> \"retry_all\":\n return other.__rand__(self)\n\n def __rand__(self, other: \"retry_base\") -> \"retry_all\":\n return retry_all(other, self)\n\n def __or__(self, other: \"retry_base\") -> \"retry_any\":\n return other.__ror__(self)\n\n def __ror__(self, other: \"retry_base\") -> \"retry_any\":\n return retry_any(other, self)\n\n\nRetryBaseT = typing.Union[retry_base, typing.Callable[[\"RetryCallState\"], bool]]\n\n\nclass _retry_never(retry_base):\n \"\"\"Retry strategy that never rejects any result.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return False\n\n\nretry_never = _retry_never()\n\n\nclass _retry_always(retry_base):\n \"\"\"Retry strategy that always rejects any result.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return True\n\n\nretry_always = _retry_always()\n\n\nclass retry_if_exception(retry_base):\n \"\"\"Retry strategy that retries if an exception verifies a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[BaseException], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if retry_state.outcome.failed:\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n else:\n return False\n\n\nclass retry_if_exception_type(retry_if_exception):\n \"\"\"Retries if an exception has been raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: isinstance(e, exception_types))\n\n\nclass retry_if_not_exception_type(retry_if_exception):\n \"\"\"Retries except an exception has been raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: not isinstance(e, exception_types))\n\n\nclass retry_unless_exception_type(retry_if_exception):\n \"\"\"Retries until an exception is raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: not isinstance(e, exception_types))\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n # always retry if no exception was raised\n if not retry_state.outcome.failed:\n return True\n\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n\n\nclass retry_if_exception_cause_type(retry_base):\n \"\"\"Retries if any of the causes of the raised exception is of one or more types.\n\n The check on the type of the cause of the exception is done recursively (until finding\n an exception in the chain that has no `__cause__`)\n \"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_cause_types = exception_types\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__ called before outcome was set\")\n\n if retry_state.outcome.failed:\n exc = retry_state.outcome.exception()\n while exc is not None:\n if isinstance(exc.__cause__, self.exception_cause_types):\n return True\n exc = exc.__cause__\n\n return False\n\n\nclass retry_if_result(retry_base):\n \"\"\"Retries if the result verifies a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_if_not_result(retry_base):\n \"\"\"Retries if the result refutes a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return not self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_if_exception_message(retry_if_exception):\n \"\"\"Retries if an exception message equals or matches.\"\"\"\n\n def __init__(\n self,\n message: typing.Optional[str] = None,\n match: typing.Optional[str] = None,\n ) -> None:\n if message and match:\n raise TypeError(\n f\"{self.__class__.__name__}() takes either 'message' or 'match', not both\"\n )\n\n # set predicate\n if message:\n\n def message_fnc(exception: BaseException) -> bool:\n return message == str(exception)\n\n predicate = message_fnc\n elif match:\n prog = re.compile(match)\n\n def match_fnc(exception: BaseException) -> bool:\n return bool(prog.match(str(exception)))\n\n predicate = match_fnc\n else:\n raise TypeError(\n f\"{self.__class__.__name__}() missing 1 required argument 'message' or 'match'\"\n )\n\n super().__init__(predicate)\n\n\nclass retry_if_not_exception_message(retry_if_exception_message):\n \"\"\"Retries until an exception message equals or matches.\"\"\"\n\n def __init__(\n self,\n message: typing.Optional[str] = None,\n match: typing.Optional[str] = None,\n ) -> None:\n super().__init__(message, match)\n # invert predicate\n if_predicate = self.predicate\n self.predicate = lambda *args_, **kwargs_: not if_predicate(*args_, **kwargs_)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return True\n\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n\n\nclass retry_any(retry_base):\n \"\"\"Retries if any of the retries condition is valid.\"\"\"\n\n def __init__(self, *retries: retry_base) -> None:\n self.retries = retries\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return any(r(retry_state) for r in self.retries)\n\n\nclass retry_all(retry_base):\n \"\"\"Retries if all the retries condition are valid.\"\"\"\n\n def __init__(self, *retries: retry_base) -> None:\n self.retries = retries\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return all(r(retry_state) for r in self.retries)\n\n[end of tenacity/retry.py]","filename":"tenacity/retry.py","id":"17"},{"content":"[end of tenacity/py.typed]","filename":"tenacity/py.typed","id":"18"},{"content":"# Copyright 2017 Elisey Zanko\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport sys\nimport typing\n\nfrom tenacity import BaseRetrying\nfrom tenacity import DoAttempt\nfrom tenacity import DoSleep\nfrom tenacity import RetryCallState\n\nfrom tornado import gen\n\nif typing.TYPE_CHECKING:\n from tornado.concurrent import Future\n\n_RetValT = typing.TypeVar(\"_RetValT\")\n\n\nclass TornadoRetrying(BaseRetrying):\n def __init__(\n self,\n sleep: \"typing.Callable[[float], Future[None]]\" = gen.sleep,\n **kwargs: typing.Any,\n ) -> None:\n super().__init__(**kwargs)\n self.sleep = sleep\n\n @gen.coroutine # type: ignore[misc]\n def __call__(\n self,\n fn: \"typing.Callable[..., typing.Union[typing.Generator[typing.Any, typing.Any, _RetValT], Future[_RetValT]]]\",\n *args: typing.Any,\n **kwargs: typing.Any,\n ) -> \"typing.Generator[typing.Any, typing.Any, _RetValT]\":\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = yield fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n yield self.sleep(do)\n else:\n raise gen.Return(do)\n\n[end of tenacity/tornadoweb.py]","filename":"tenacity/tornadoweb.py","id":"19"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport functools\nimport inspect\nimport sys\nimport typing\nfrom datetime import timedelta\n\n\n# sys.maxsize:\n# An integer giving the maximum value a variable of type Py_ssize_t can take.\nMAX_WAIT = sys.maxsize / 2\n\n\ndef find_ordinal(pos_num: int) -> str:\n # See: https://en.wikipedia.org/wiki/English_numerals#Ordinal_numbers\n if pos_num == 0:\n return \"th\"\n elif pos_num == 1:\n return \"st\"\n elif pos_num == 2:\n return \"nd\"\n elif pos_num == 3:\n return \"rd\"\n elif 4 <= pos_num <= 20:\n return \"th\"\n else:\n return find_ordinal(pos_num % 10)\n\n\ndef to_ordinal(pos_num: int) -> str:\n return f\"{pos_num}{find_ordinal(pos_num)}\"\n\n\ndef get_callback_name(cb: typing.Callable[..., typing.Any]) -> str:\n \"\"\"Get a callback fully-qualified name.\n\n If no name can be produced ``repr(cb)`` is called and returned.\n \"\"\"\n segments = []\n try:\n segments.append(cb.__qualname__)\n except AttributeError:\n try:\n segments.append(cb.__name__)\n except AttributeError:\n pass\n if not segments:\n return repr(cb)\n else:\n try:\n # When running under sphinx it appears this can be none?\n if cb.__module__:\n segments.insert(0, cb.__module__)\n except AttributeError:\n pass\n return \".\".join(segments)\n\n\ntime_unit_type = typing.Union[int, float, timedelta]\n\n\ndef to_seconds(time_unit: time_unit_type) -> float:\n return float(\n time_unit.total_seconds() if isinstance(time_unit, timedelta) else time_unit\n )\n\n\ndef is_coroutine_callable(call: typing.Callable[..., typing.Any]) -> bool:\n if inspect.isclass(call):\n return False\n if inspect.iscoroutinefunction(call):\n return True\n partial_call = isinstance(call, functools.partial) and call.func\n dunder_call = partial_call or getattr(call, \"__call__\", None)\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef wrap_to_async_func(\n call: typing.Callable[..., typing.Any],\n) -> typing.Callable[..., typing.Awaitable[typing.Any]]:\n if is_coroutine_callable(call):\n return call\n\n async def inner(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:\n return call(*args, **kwargs)\n\n return inner\n\n[end of tenacity/_utils.py]","filename":"tenacity/_utils.py","id":"20"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport functools\nimport sys\nimport typing as t\n\nimport tenacity\nfrom tenacity import AttemptManager\nfrom tenacity import BaseRetrying\nfrom tenacity import DoAttempt\nfrom tenacity import DoSleep\nfrom tenacity import RetryCallState\nfrom tenacity import RetryError\nfrom tenacity import after_nothing\nfrom tenacity import before_nothing\nfrom tenacity import _utils\n\n# Import all built-in retry strategies for easier usage.\nfrom .retry import RetryBaseT\nfrom .retry import retry_all # noqa\nfrom .retry import retry_any # noqa\nfrom .retry import retry_if_exception # noqa\nfrom .retry import retry_if_result # noqa\nfrom ..retry import RetryBaseT as SyncRetryBaseT\n\nif t.TYPE_CHECKING:\n from tenacity.stop import StopBaseT\n from tenacity.wait import WaitBaseT\n\nWrappedFnReturnT = t.TypeVar(\"WrappedFnReturnT\")\nWrappedFn = t.TypeVar(\"WrappedFn\", bound=t.Callable[..., t.Awaitable[t.Any]])\n\n\ndef _portable_async_sleep(seconds: float) -> t.Awaitable[None]:\n # If trio is already imported, then importing it is cheap.\n # If trio isn't already imported, then it's definitely not running, so we\n # can skip further checks.\n if \"trio\" in sys.modules:\n # If trio is available, then sniffio is too\n import trio\n import sniffio\n\n if sniffio.current_async_library() == \"trio\":\n return trio.sleep(seconds)\n # Otherwise, assume asyncio\n # Lazy import asyncio as it's expensive (responsible for 25-50% of total import overhead).\n import asyncio\n\n return asyncio.sleep(seconds)\n\n\nclass AsyncRetrying(BaseRetrying):\n def __init__(\n self,\n sleep: t.Callable[\n [t.Union[int, float]], t.Union[None, t.Awaitable[None]]\n ] = _portable_async_sleep,\n stop: \"StopBaseT\" = tenacity.stop.stop_never,\n wait: \"WaitBaseT\" = tenacity.wait.wait_none(),\n retry: \"t.Union[SyncRetryBaseT, RetryBaseT]\" = tenacity.retry_if_exception_type(),\n before: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = before_nothing,\n after: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = after_nothing,\n before_sleep: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[None, t.Awaitable[None]]]\n ] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[\"RetryError\"] = RetryError,\n retry_error_callback: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[t.Any, t.Awaitable[t.Any]]]\n ] = None,\n ) -> None:\n super().__init__(\n sleep=sleep, # type: ignore[arg-type]\n stop=stop,\n wait=wait,\n retry=retry, # type: ignore[arg-type]\n before=before, # type: ignore[arg-type]\n after=after, # type: ignore[arg-type]\n before_sleep=before_sleep, # type: ignore[arg-type]\n reraise=reraise,\n retry_error_cls=retry_error_cls,\n retry_error_callback=retry_error_callback,\n )\n\n async def __call__( # type: ignore[override]\n self, fn: WrappedFn, *args: t.Any, **kwargs: t.Any\n ) -> WrappedFnReturnT:\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = await self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = await fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n await self.sleep(do) # type: ignore[misc]\n else:\n return do # type: ignore[no-any-return]\n\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\n self.iter_state.actions.append(_utils.wrap_to_async_func(fn))\n\n async def _run_retry(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n self.iter_state.retry_run_result = await _utils.wrap_to_async_func(self.retry)(\n retry_state\n )\n\n async def _run_wait(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n if self.wait:\n sleep = await _utils.wrap_to_async_func(self.wait)(retry_state)\n else:\n sleep = 0.0\n\n retry_state.upcoming_sleep = sleep\n\n async def _run_stop(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n self.statistics[\"delay_since_first_attempt\"] = retry_state.seconds_since_start\n self.iter_state.stop_run_result = await _utils.wrap_to_async_func(self.stop)(\n retry_state\n )\n\n async def iter(\n self, retry_state: \"RetryCallState\"\n ) -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa: A003\n self._begin_iter(retry_state)\n result = None\n for action in self.iter_state.actions:\n result = await action(retry_state)\n return result\n\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\n raise TypeError(\"AsyncRetrying object is not iterable\")\n\n def __aiter__(self) -> \"AsyncRetrying\":\n self.begin()\n self._retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\n return self\n\n async def __anext__(self) -> AttemptManager:\n while True:\n do = await self.iter(retry_state=self._retry_state)\n if do is None:\n raise StopAsyncIteration\n elif isinstance(do, DoAttempt):\n return AttemptManager(retry_state=self._retry_state)\n elif isinstance(do, DoSleep):\n self._retry_state.prepare_for_next_attempt()\n await self.sleep(do) # type: ignore[misc]\n else:\n raise StopAsyncIteration\n\n def wraps(self, fn: WrappedFn) -> WrappedFn:\n wrapped = super().wraps(fn)\n # Ensure wrapper is recognized as a coroutine function.\n\n @functools.wraps(\n fn, functools.WRAPPER_ASSIGNMENTS + (\"__defaults__\", \"__kwdefaults__\")\n )\n async def async_wrapped(*args: t.Any, **kwargs: t.Any) -> t.Any:\n # Always create a copy to prevent overwriting the local contexts when\n # calling the same wrapped functions multiple times in the same stack\n copy = self.copy()\n async_wrapped.statistics = copy.statistics # type: ignore[attr-defined]\n return await copy(fn, *args, **kwargs)\n\n # Preserve attributes\n async_wrapped.retry = self # type: ignore[attr-defined]\n async_wrapped.retry_with = wrapped.retry_with # type: ignore[attr-defined]\n async_wrapped.statistics = {} # type: ignore[attr-defined]\n\n return async_wrapped # type: ignore[return-value]\n\n\n__all__ = [\n \"retry_all\",\n \"retry_any\",\n \"retry_if_exception\",\n \"retry_if_result\",\n \"WrappedFn\",\n \"AsyncRetrying\",\n]\n\n[end of tenacity/asyncio/__init__.py]","filename":"tenacity/asyncio/__init__.py","id":"21"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport abc\nimport typing\n\nfrom tenacity import _utils\nfrom tenacity import retry_base\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass async_retry_base(retry_base):\n \"\"\"Abstract base class for async retry strategies.\"\"\"\n\n @abc.abstractmethod\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n pass\n\n def __and__( # type: ignore[override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_all\":\n return retry_all(self, other)\n\n def __rand__( # type: ignore[misc,override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_all\":\n return retry_all(other, self)\n\n def __or__( # type: ignore[override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_any\":\n return retry_any(self, other)\n\n def __ror__( # type: ignore[misc,override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_any\":\n return retry_any(other, self)\n\n\nRetryBaseT = typing.Union[\n async_retry_base, typing.Callable[[\"RetryCallState\"], typing.Awaitable[bool]]\n]\n\n\nclass retry_if_exception(async_retry_base):\n \"\"\"Retry strategy that retries if an exception verifies a predicate.\"\"\"\n\n def __init__(\n self, predicate: typing.Callable[[BaseException], typing.Awaitable[bool]]\n ) -> None:\n self.predicate = predicate\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if retry_state.outcome.failed:\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return await self.predicate(exception)\n else:\n return False\n\n\nclass retry_if_result(async_retry_base):\n \"\"\"Retries if the result verifies a predicate.\"\"\"\n\n def __init__(\n self, predicate: typing.Callable[[typing.Any], typing.Awaitable[bool]]\n ) -> None:\n self.predicate = predicate\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return await self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_any(async_retry_base):\n \"\"\"Retries if any of the retries condition is valid.\"\"\"\n\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\n self.retries = retries\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n result = False\n for r in self.retries:\n result = result or await _utils.wrap_to_async_func(r)(retry_state)\n if result:\n break\n return result\n\n\nclass retry_all(async_retry_base):\n \"\"\"Retries if all the retries condition are valid.\"\"\"\n\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\n self.retries = retries\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n result = True\n for r in self.retries:\n result = result and await _utils.wrap_to_async_func(r)(retry_state)\n if not result:\n break\n return result\n\n[end of tenacity/asyncio/retry.py]","filename":"tenacity/asyncio/retry.py","id":"22"},{"content":"Tenacity\n========\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\n :target: https://pypi.python.org/pypi/tenacity\n\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\n :target: https://circleci.com/gh/jd/tenacity\n\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\n :target: https://mergify.io\n :alt: Mergify Status\n\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\n\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\nPython, to simplify the task of adding retry behavior to just about anything.\nIt originates from `a fork of retrying\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\napi compatible with retrying but adds significant new functionality and\nfixes a number of longstanding bugs.\n\nThe simplest use case is retrying a flaky function whenever an `Exception`\noccurs until a value is returned.\n\n.. testcode::\n\n import random\n from tenacity import retry\n\n @retry\n def do_something_unreliable():\n if random.randint(0, 10) > 1:\n raise IOError(\"Broken sauce, everything is hosed!!!111one\")\n else:\n return \"Awesome sauce!\"\n\n print(do_something_unreliable())\n\n.. testoutput::\n :hide:\n\n Awesome sauce!\n\n\n.. toctree::\n :hidden:\n :maxdepth: 2\n\n changelog\n api\n\n\nFeatures\n--------\n\n- Generic Decorator API\n- Specify stop condition (i.e. limit by number of attempts)\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\n- Customize retrying on Exceptions\n- Customize retrying on expected returned result\n- Retry on coroutines\n- Retry code block with context manager\n\n\nInstallation\n------------\n\nTo install *tenacity*, simply:\n\n.. code-block:: bash\n\n $ pip install tenacity\n\n\nExamples\n----------\n\nBasic Retry\n~~~~~~~~~~~\n\n.. testsetup::\n\n import logging\n #\n # Note the following import is used for demonstration convenience only.\n # Production code should always explicitly import the names it needs.\n #\n from tenacity import *\n\n class MyException(Exception):\n pass\n\nAs you saw above, the default behavior is to retry forever without waiting when\nan exception is raised.\n\n.. testcode::\n\n @retry\n def never_gonna_give_you_up():\n print(\"Retry forever ignoring Exceptions, don't wait between retries\")\n raise Exception\n\nStopping\n~~~~~~~~\n\nLet's be a little less persistent and set some boundaries, such as the number\nof attempts before giving up.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(7))\n def stop_after_7_attempts():\n print(\"Stopping after 7 attempts\")\n raise Exception\n\nWe don't have all day, so let's set a boundary for how long we should be\nretrying stuff.\n\n.. testcode::\n\n @retry(stop=stop_after_delay(10))\n def stop_after_10_s():\n print(\"Stopping after 10 seconds\")\n raise Exception\n\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\nthen you can give up on retries one attempt before you would exceed the delay.\n\n.. testcode::\n\n @retry(stop=stop_before_delay(10))\n def stop_before_10_s():\n print(\"Stopping 1 attempt before 10 seconds\")\n raise Exception\n\nYou can combine several stop conditions by using the `|` operator:\n\n.. testcode::\n\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\n def stop_after_10_s_or_5_retries():\n print(\"Stopping after 10 seconds or 5 retries\")\n raise Exception\n\nWaiting before retrying\n~~~~~~~~~~~~~~~~~~~~~~~\n\nMost things don't like to be polled as fast as possible, so let's just wait 2\nseconds between retries.\n\n.. testcode::\n\n @retry(wait=wait_fixed(2))\n def wait_2_s():\n print(\"Wait 2 second between retries\")\n raise Exception\n\nSome things perform best with a bit of randomness injected.\n\n.. testcode::\n\n @retry(wait=wait_random(min=1, max=2))\n def wait_random_1_to_2_s():\n print(\"Randomly wait 1 to 2 seconds between retries\")\n raise Exception\n\nThen again, it's hard to beat exponential backoff when retrying distributed\nservices and other remote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\n def wait_exponential_1():\n print(\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\")\n raise Exception\n\n\nThen again, it's also hard to beat combining fixed waits and jitter (to\nhelp avoid thundering herds) when retrying distributed services and other\nremote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\n def wait_fixed_jitter():\n print(\"Wait at least 3 seconds, and add up to 2 seconds of random delay\")\n raise Exception\n\nWhen multiple processes are in contention for a shared resource, exponentially\nincreasing jitter helps minimise collisions.\n\n.. testcode::\n\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\n def wait_exponential_jitter():\n print(\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\")\n raise Exception\n\n\nSometimes it's necessary to build a chain of backoffs.\n\n.. testcode::\n\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\n [wait_fixed(7) for i in range(2)] +\n [wait_fixed(9)]))\n def wait_fixed_chained():\n print(\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\")\n raise Exception\n\nWhether to retry\n~~~~~~~~~~~~~~~~\n\nWe have a few options for dealing with retries that raise specific or general\nexceptions, as in the cases here.\n\n.. testcode::\n\n class ClientError(Exception):\n \"\"\"Some type of client error.\"\"\"\n\n @retry(retry=retry_if_exception_type(IOError))\n def might_io_error():\n print(\"Retry forever with no wait if an IOError occurs, raise any other errors\")\n raise Exception\n\n @retry(retry=retry_if_not_exception_type(ClientError))\n def might_client_error():\n print(\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\")\n raise Exception\n\nWe can also use the result of the function to alter the behavior of retrying.\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=retry_if_result(is_none_p))\n def might_return_none():\n print(\"Retry with no wait if return value is None\")\n\nSee also these methods:\n\n.. testcode::\n\n retry_if_exception\n retry_if_exception_type\n retry_if_not_exception_type\n retry_unless_exception_type\n retry_if_result\n retry_if_not_result\n retry_if_exception_message\n retry_if_not_exception_message\n retry_any\n retry_all\n\nWe can also combine several conditions:\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\n def might_return_none():\n print(\"Retry forever ignoring Exceptions with no wait if return value is None\")\n\nAny combination of stop, wait, etc. is also supported to give you the freedom\nto mix and match.\n\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\nexception:\n\n.. testcode::\n\n @retry\n def do_something():\n result = something_else()\n if result == 23:\n raise TryAgain\n\nError Handling\n~~~~~~~~~~~~~~\n\nNormally when your function fails its final time (and will not be retried again based on your settings),\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\nof the stack trace.\n\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\nis most visible), you can set `reraise=True`.\n\n.. testcode::\n\n @retry(reraise=True, stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except MyException:\n # timed out retrying\n pass\n\nBefore and After Retry, and Logging\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIt's possible to execute an action before any attempt of calling the function\nby using the before callback function:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIn the same spirit, It's possible to execute after a call that failed:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIt's also possible to only log failures that are going to be retried. Normally\nretries happen after a wait interval, so the keyword argument is called\n``before_sleep``:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3),\n before_sleep=before_sleep_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n\nStatistics\n~~~~~~~~~~\n\nYou can access the statistics about the retry made over a function by using the\n`statistics` attribute attached to the function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nCustom Callbacks\n~~~~~~~~~~~~~~~~\n\nYou can also define your own callbacks. The callback should accept one\nparameter called ``retry_state`` that contains all information about current\nretry invocation.\n\nFor example, you can call a custom callback function after all retries failed,\nwithout raising an exception (or you can re-raise or do anything really)\n\n.. testcode::\n\n def return_last_value(retry_state):\n \"\"\"return the result of the last call attempt\"\"\"\n return retry_state.outcome.result()\n\n def is_false(value):\n \"\"\"Return True if value is False\"\"\"\n return value is False\n\n # will return False after trying 3 times to get a different result\n @retry(stop=stop_after_attempt(3),\n retry_error_callback=return_last_value,\n retry=retry_if_result(is_false))\n def eventually_return_false():\n return False\n\nRetryCallState\n~~~~~~~~~~~~~~\n\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\n\nOther Custom Callbacks\n~~~~~~~~~~~~~~~~~~~~~~\n\nIt's also possible to define custom callbacks for other keyword arguments.\n\n.. function:: my_stop(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should stop\n :rtype: bool\n\n.. function:: my_wait(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: number of seconds to wait before next retry\n :rtype: float\n\n.. function:: my_retry(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should continue\n :rtype: bool\n\n.. function:: my_before(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_after(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_before_sleep(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\nHere's an example with a custom ``before_sleep`` function:\n\n.. testcode::\n\n import logging\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n def my_before_sleep(retry_state):\n if retry_state.attempt_number < 1:\n loglevel = logging.INFO\n else:\n loglevel = logging.WARNING\n logger.log(\n loglevel, 'Retrying %s: attempt %s ended with: %s',\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\n\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except RetryError:\n pass\n\n\nChanging Arguments at Run Time\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can change the arguments of a retry decorator as needed when calling it by\nusing the `retry_with` function attached to the wrapped function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nIf you want to use variables to set up the retry parameters, you don't have\nto use the `retry` decorator - you can instead use `Retrying` directly:\n\n.. testcode::\n\n def never_good_enough(arg1):\n raise Exception('Invalid argument: {}'.format(arg1))\n\n def try_never_good_enough(max_attempts=3):\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\n retryer(never_good_enough, 'I really do try')\n\nYou may also want to change the behaviour of a decorated function temporarily,\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\nattribute attached to the function. Bear in mind this is a write-only attribute,\nstatistics should be read from the function `statistics` attribute.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n from unittest import mock\n\n with mock.patch.object(raise_my_exception.retry, \"wait\", wait_fixed(0)):\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nRetrying code block\n~~~~~~~~~~~~~~~~~~~\n\nTenacity allows you to retry a code block without the need to wraps it in an\nisolated function. This makes it easy to isolate failing block while sharing\ncontext. The trick is to combine a for loop and a context manager.\n\n.. testcode::\n\n from tenacity import Retrying, RetryError, stop_after_attempt\n\n try:\n for attempt in Retrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nYou can configure every details of retry policy by configuring the Retrying\nobject.\n\nWith async code you can use AsyncRetrying.\n\n.. testcode::\n\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\n\n async def function():\n try:\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nIn both cases, you may want to set the result to the attempt so it's available\nin retry strategies like ``retry_if_result``. This can be done accessing the\n``retry_state`` property:\n\n.. testcode::\n\n from tenacity import AsyncRetrying, retry_if_result\n\n async def function():\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\n with attempt:\n result = 1 # Some complex calculation, function call, etc.\n if not attempt.retry_state.outcome.failed:\n attempt.retry_state.set_result(result)\n return result\n\nAsync and retry\n~~~~~~~~~~~~~~~\n\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\nSleeps are done asynchronously too.\n\n.. code-block:: python\n\n @retry\n async def my_asyncio_function(loop):\n await loop.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n async def my_async_trio_function():\n await trio.socket.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n @tornado.gen.coroutine\n def my_async_tornado_function(http_client, url):\n yield http_client.fetch(url)\n\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\n\n.. code-block:: python\n\n @retry(sleep=curio.sleep)\n async def my_async_curio_function():\n await asks.get('https://example.org')\n\nContribute\n----------\n\n#. Check for open issues or open a fresh issue to start a discussion around a\n feature idea or a bug.\n#. Fork `the repository`_ on GitHub to start making your changes to the\n **main** branch (or branch off of it).\n#. Write a test which shows that the bug was fixed or that the feature works as\n expected.\n#. Add a `changelog <#Changelogs>`_\n#. Make the docs better (or more detailed, or more easier to read, or ...)\n\n.. _`the repository`: https://github.com/jd/tenacity\n\nChangelogs\n~~~~~~~~~~\n\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\n\nThe doc generation will automatically compile the changelogs. You just need to add them.\n\n.. code-block:: sh\n\n # Opens a template file in an editor\n tox -e reno -- new some-slug-for-my-change --edit\n\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\n\n[end of doc/source/index.rst]","filename":"doc/source/index.rst","id":"23"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport os\nimport sys\n\nmaster_doc = \"index\"\nproject = \"Tenacity\"\n\n# Add tenacity to the path, so sphinx can find the functions for autodoc.\nsys.path.insert(0, os.path.abspath(\"../..\"))\n\nextensions = [\n \"sphinx.ext.doctest\",\n \"sphinx.ext.autodoc\",\n \"reno.sphinxext\",\n]\n\n# -- Options for sphinx.ext.doctest -----------------------------------------\n\n# doctest_default_flags =\ncwd = os.path.abspath(os.path.dirname(__file__))\ntenacity_path = os.path.join(cwd, os.pardir, os.pardir)\ndoctest_path = [tenacity_path]\n# doctest_global_setup =\n# doctest_global_cleanup =\n# doctest_test_doctest_blocks =\n\n[end of doc/source/conf.py]","filename":"doc/source/conf.py","id":"24"},{"content":"Changelog\n=========\n\n.. release-notes::\n\n[end of doc/source/changelog.rst]","filename":"doc/source/changelog.rst","id":"25"},{"content":"===============\n API Reference\n===============\n\nRetry Main API\n--------------\n\n.. autofunction:: tenacity.retry\n :noindex:\n\n.. autoclass:: tenacity.Retrying\n :members:\n\n.. autoclass:: tenacity.AsyncRetrying\n :members:\n\n.. autoclass:: tenacity.tornadoweb.TornadoRetrying\n :members:\n\n.. autoclass:: tenacity.RetryCallState\n :members:\n\nAfter Functions\n---------------\n\nThose functions can be used as the `after` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.after\n :members:\n\nBefore Functions\n----------------\n\nThose functions can be used as the `before` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.before\n :members:\n\nBefore Sleep Functions\n----------------------\n\nThose functions can be used as the `before_sleep` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.before_sleep\n :members:\n\nNap Functions\n-------------\n\nThose functions can be used as the `sleep` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.nap\n :members:\n\nRetry Functions\n---------------\n\nThose functions can be used as the `retry` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.retry\n :members:\n\nStop Functions\n--------------\n\nThose functions can be used as the `stop` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.stop\n :members:\n\nWait Functions\n--------------\n\nThose functions can be used as the `wait` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.wait\n :members:\n\n[end of doc/source/api.rst]","filename":"doc/source/api.rst","id":"26"},{"content":"---\nupgrade:\n - |\n Support for Python 3.6 has been removed.\n\n[end of releasenotes/notes/remove-py36-876c0416cf279d15.yaml]","filename":"releasenotes/notes/remove-py36-876c0416cf279d15.yaml","id":"27"},{"content":"---\nfixes:\n - |\n Fix async loop with retrying code block when result is available.\n\n[end of releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml]","filename":"releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml","id":"28"},{"content":"---\nupgrade:\n - \"Removed `BaseRetrying.call`: was long time deprecated and produced `DeprecationWarning`\"\n - \"Removed `BaseRetrying.fn`: was noted as deprecated\"\n - \"API change: `BaseRetrying.begin()` do not require arguments anymore as it not setting `BaseRetrying.fn`\"\n\n[end of releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml]","filename":"releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml","id":"29"},{"content":"---\nfixes:\n - Fix setuptools config to include tenacity.asyncio package in release distributions.\n\n[end of releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml]","filename":"releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml","id":"30"},{"content":"---\nother:\n - Add a \\\"test\\\" extra\n\n[end of releasenotes/notes/add-test-extra-55e869261b03e56d.yaml]","filename":"releasenotes/notes/add-test-extra-55e869261b03e56d.yaml","id":"31"},{"content":"---\nfixes:\n - |\n Use str.format to format the logs internally to make logging compatible with other logger such as loguru.\n\n[end of releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml]","filename":"releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml","id":"32"},{"content":"---\nother:\n - Unit tests can now mock ``nap.sleep()`` for testing in all tenacity usage styles\n[end of releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml]","filename":"releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml","id":"33"},{"content":"---\nfixes:\n - \"Fix after_log logger format: function name was used with delay formatting.\"\n\n[end of releasenotes/notes/after_log-50f4d73b24ce9203.yaml]","filename":"releasenotes/notes/after_log-50f4d73b24ce9203.yaml","id":"34"},{"content":"---\nother:\n - \"Use `black` for code formatting and validate using `black --check`. Code compatibility: py26-py39.\"\n - \"Enforce maximal line length to 120 symbols\"\n\n[end of releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml]","filename":"releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml","id":"35"},{"content":"---\nfixes:\n - |\n Preserve __defaults__ and __kwdefaults__ through retry decorator\n\n[end of releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml]","filename":"releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml","id":"36"},{"content":"---\nfeatures:\n - Add ``retry_if_not_exception_type()`` that allows to retry if a raised exception doesn't match given exceptions.\n\n[end of releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml]","filename":"releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml","id":"37"},{"content":"---\nfixes:\n - |\n Argument `wait` was improperly annotated, making mypy checks fail.\n Now it's annotated as `typing.Union[wait_base, typing.Callable[[\"RetryCallState\"], typing.Union[float, int]]]`\n\n[end of releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml]","filename":"releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml","id":"38"},{"content":"---\nfeatures:\n - Explicitly export convenience symbols from tenacity root module\n\n[end of releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml]","filename":"releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml","id":"39"},{"content":"---\nfeatures:\n - Add ``datetime.timedelta`` as accepted wait unit type.\n\n[end of releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml]","filename":"releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml","id":"40"},{"content":"---\nother:\n - |\n Add a Dependabot configuration submit PRs monthly (as needed)\n to keep GitHub action versions updated.\n\n[end of releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml]","filename":"releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml","id":"41"},{"content":"---\nfeatures:\n - |\n Add a new `retry_base` class called `retry_if_exception_cause_type` that\n checks, recursively, if any of the causes of the raised exception is of a certain type.\n\n[end of releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml]","filename":"releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml","id":"42"},{"content":"---\nfeatures:\n - |\n Added the ability to use async functions for retries. This way, you can now use\n asyncio coroutines for retry strategy predicates.\n\n[end of releasenotes/notes/add-async-actions-b249c527d99723bb.yaml]","filename":"releasenotes/notes/add-async-actions-b249c527d99723bb.yaml","id":"43"},{"content":"---\nprelude: >\n Clarify usage of `reraise` keyword argument\n\n[end of releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml]","filename":"releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml","id":"44"},{"content":"---\nfixes: Sphinx build error where Sphinx complains about an undefined class.\n\n[end of releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml]","filename":"releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml","id":"45"},{"content":"---\nfeatures:\n - Add reno (changelog system)\n\n[end of releasenotes/notes/add-reno-d1ab5710f272650a.yaml]","filename":"releasenotes/notes/add-reno-d1ab5710f272650a.yaml","id":"46"},{"content":"---\nfixes:\n - |\n Avoid overwriting local contexts when applying the retry decorator.\n\n[end of releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml]","filename":"releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml","id":"47"},{"content":"---\nfeatures:\n - Most part of the code is type annotated.\n - Python 3.10 support has been added.\n\n[end of releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml]","filename":"releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml","id":"48"},{"content":"---\nother:\n - Add type annotations to cover all public API.\n\n[end of releasenotes/notes/annotate_code-197b93130df14042.yaml]","filename":"releasenotes/notes/annotate_code-197b93130df14042.yaml","id":"49"},{"content":"---\nfixes:\n - |\n `AsyncRetrying` was erroneously implementing `__iter__()`, making tenacity\n retrying mechanism working but in a synchronous fashion and not waiting as\n expected. This interface has been removed, `__aiter__()` should be used\n instead.\n\n[end of releasenotes/notes/no-async-iter-6132a42e52348a75.yaml]","filename":"releasenotes/notes/no-async-iter-6132a42e52348a75.yaml","id":"50"},{"content":"---\nfeatures:\n - |\n Added a new stop function: stop_before_delay, which will stop execution\n if the next sleep time would cause overall delay to exceed the specified delay. \n Useful for use cases where you have some upper bound on retry times that you must\n not exceed, so returning before that timeout is preferable than returning after that timeout.\n[end of releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml]","filename":"releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml","id":"51"},{"content":"---\nfeatures:\n - |\n If you're using `Trio <https://trio.readthedocs.io>`__, then\n ``@retry`` now works automatically. It's no longer necessary to\n pass ``sleep=trio.sleep``.\n\n[end of releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml]","filename":"releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml","id":"52"},{"content":"---\nother: >-\n Corrected the PyPI-published wheel tag to match the\n metadata saying that the release is Python 3 only.\n...\n\n[end of releasenotes/notes/pr320-py3-only-wheel-tag.yaml]","filename":"releasenotes/notes/pr320-py3-only-wheel-tag.yaml","id":"53"},{"content":"---\nfeatures:\n - |\n - accept ``datetime.timedelta`` instances as argument to ``tenacity.stop.stop_after_delay``\n\n[end of releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml]","filename":"releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml","id":"54"},{"content":"---\nfixes:\n - |\n Restore the value of the `retry` attribute for wrapped functions. Also,\n clarify that those attributes are write-only and statistics should be\n read from the function attribute directly.\n\n[end of releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml]","filename":"releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml","id":"55"},{"content":"---\nfixes:\n - \"Fix issue #288 : __name__ and other attributes for async functions\"\n\n[end of releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml]","filename":"releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml","id":"56"},{"content":"---\nother:\n - |\n Added a link to the documentation, as code snippets are not being rendered properly\n Changed branch name to main in index.rst\n\n[end of releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml]","filename":"releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml","id":"57"},{"content":"---\nfixes:\n - |\n Respects `min` arg for `wait_random_exponential`\n\n[end of releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml]","filename":"releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml","id":"58"},{"content":"---\nfeatures:\n - Add a ``__repr__`` method to ``RetryCallState`` objects for easier debugging.\n\n[end of releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml]","filename":"releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml","id":"59"},{"content":"---\nother:\n - |\n Drop support for deprecated Python versions (2.7 and 3.5)\n\n[end of releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml]","filename":"releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml","id":"60"},{"content":"---\nfeatures:\n - Add an ``exc_info`` option to the ``before_sleep_log()`` strategy.\n[end of releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml]","filename":"releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml","id":"61"},{"content":"---\nother:\n - Add `retry_if_exception_cause_type`and `wait_exponential_jitter` to __all__ of init.py\n[end of releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml]","filename":"releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml","id":"62"},{"content":"---\nfeatures:\n - |\n Implement a wait.wait_exponential_jitter per Google's storage retry guide.\n See https://cloud.google.com/storage/docs/retry-strategy\n\n[end of releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml]","filename":"releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml","id":"63"}],"string":"[\n {\n \"content\": \"queue_rules:\\n - name: default\\n merge_method: squash\\n queue_conditions:\\n - or:\\n - author = jd\\n - \\\"#approved-reviews-by >= 1\\\"\\n - author = dependabot[bot]\\n - or:\\n - files ~= ^releasenotes/notes/\\n - label = no-changelog\\n - author = dependabot[bot]\\n - \\\"check-success=test (3.9, py39)\\\"\\n - \\\"check-success=test (3.10, py310)\\\"\\n - \\\"check-success=test (3.11, py311)\\\"\\n - \\\"check-success=test (3.12, py312)\\\"\\n - \\\"check-success=test (3.13, py313,py313-trio)\\\"\\n - \\\"check-success=test (3.12, pep8)\\\"\\n\\npull_request_rules:\\n - name: warn on no changelog\\n conditions:\\n - -files~=^releasenotes/notes/\\n - label!=no-changelog\\n - -closed\\n actions:\\n comment:\\n message: >\\n ⚠️ No release notes detected. Please make sure to use\\n [reno](https://docs.openstack.org/reno/latest/user/usage.html) to add\\n a changelog entry.\\n\\n - name: automatic queue\\n conditions: []\\n actions:\\n queue:\\n\\n - name: dismiss reviews\\n conditions: []\\n actions:\\n dismiss_reviews: {}\\n\\n[end of .mergify.yml]\",\n \"filename\": \".mergify.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"---\\nunreleased_version_title: Unreleased\\n\\n[end of reno.yaml]\",\n \"filename\": \"reno.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"Apache License\\n Version 2.0, January 2004\\n http://www.apache.org/licenses/\\n\\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\\n\\n 1. Definitions.\\n\\n \\\"License\\\" shall mean the terms and conditions for use, reproduction,\\n and distribution as defined by Sections 1 through 9 of this document.\\n\\n \\\"Licensor\\\" shall mean the copyright owner or entity authorized by\\n the copyright owner that is granting the License.\\n\\n \\\"Legal Entity\\\" shall mean the union of the acting entity and all\\n other entities that control, are controlled by, or are under common\\n control with that entity. For the purposes of this definition,\\n \\\"control\\\" means (i) the power, direct or indirect, to cause the\\n direction or management of such entity, whether by contract or\\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\\n outstanding shares, or (iii) beneficial ownership of such entity.\\n\\n \\\"You\\\" (or \\\"Your\\\") shall mean an individual or Legal Entity\\n exercising permissions granted by this License.\\n\\n \\\"Source\\\" form shall mean the preferred form for making modifications,\\n including but not limited to software source code, documentation\\n source, and configuration files.\\n\\n \\\"Object\\\" form shall mean any form resulting from mechanical\\n transformation or translation of a Source form, including but\\n not limited to compiled object code, generated documentation,\\n and conversions to other media types.\\n\\n \\\"Work\\\" shall mean the work of authorship, whether in Source or\\n Object form, made available under the License, as indicated by a\\n copyright notice that is included in or attached to the work\\n (an example is provided in the Appendix below).\\n\\n \\\"Derivative Works\\\" shall mean any work, whether in Source or Object\\n form, that is based on (or derived from) the Work and for which the\\n editorial revisions, annotations, elaborations, or other modifications\\n represent, as a whole, an original work of authorship. For the purposes\\n of this License, Derivative Works shall not include works that remain\\n separable from, or merely link (or bind by name) to the interfaces of,\\n the Work and Derivative Works thereof.\\n\\n \\\"Contribution\\\" shall mean any work of authorship, including\\n the original version of the Work and any modifications or additions\\n to that Work or Derivative Works thereof, that is intentionally\\n submitted to Licensor for inclusion in the Work by the copyright owner\\n or by an individual or Legal Entity authorized to submit on behalf of\\n the copyright owner. For the purposes of this definition, \\\"submitted\\\"\\n means any form of electronic, verbal, or written communication sent\\n to the Licensor or its representatives, including but not limited to\\n communication on electronic mailing lists, source code control systems,\\n and issue tracking systems that are managed by, or on behalf of, the\\n Licensor for the purpose of discussing and improving the Work, but\\n excluding communication that is conspicuously marked or otherwise\\n designated in writing by the copyright owner as \\\"Not a Contribution.\\\"\\n\\n \\\"Contributor\\\" shall mean Licensor and any individual or Legal Entity\\n on behalf of whom a Contribution has been received by Licensor and\\n subsequently incorporated within the Work.\\n\\n 2. Grant of Copyright License. Subject to the terms and conditions of\\n this License, each Contributor hereby grants to You a perpetual,\\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\\n copyright license to reproduce, prepare Derivative Works of,\\n publicly display, publicly perform, sublicense, and distribute the\\n Work and such Derivative Works in Source or Object form.\\n\\n 3. Grant of Patent License. Subject to the terms and conditions of\\n this License, each Contributor hereby grants to You a perpetual,\\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\\n (except as stated in this section) patent license to make, have made,\\n use, offer to sell, sell, import, and otherwise transfer the Work,\\n where such license applies only to those patent claims licensable\\n by such Contributor that are necessarily infringed by their\\n Contribution(s) alone or by combination of their Contribution(s)\\n with the Work to which such Contribution(s) was submitted. If You\\n institute patent litigation against any entity (including a\\n cross-claim or counterclaim in a lawsuit) alleging that the Work\\n or a Contribution incorporated within the Work constitutes direct\\n or contributory patent infringement, then any patent licenses\\n granted to You under this License for that Work shall terminate\\n as of the date such litigation is filed.\\n\\n 4. Redistribution. You may reproduce and distribute copies of the\\n Work or Derivative Works thereof in any medium, with or without\\n modifications, and in Source or Object form, provided that You\\n meet the following conditions:\\n\\n (a) You must give any other recipients of the Work or\\n Derivative Works a copy of this License; and\\n\\n (b) You must cause any modified files to carry prominent notices\\n stating that You changed the files; and\\n\\n (c) You must retain, in the Source form of any Derivative Works\\n that You distribute, all copyright, patent, trademark, and\\n attribution notices from the Source form of the Work,\\n excluding those notices that do not pertain to any part of\\n the Derivative Works; and\\n\\n (d) If the Work includes a \\\"NOTICE\\\" text file as part of its\\n distribution, then any Derivative Works that You distribute must\\n include a readable copy of the attribution notices contained\\n within such NOTICE file, excluding those notices that do not\\n pertain to any part of the Derivative Works, in at least one\\n of the following places: within a NOTICE text file distributed\\n as part of the Derivative Works; within the Source form or\\n documentation, if provided along with the Derivative Works; or,\\n within a display generated by the Derivative Works, if and\\n wherever such third-party notices normally appear. The contents\\n of the NOTICE file are for informational purposes only and\\n do not modify the License. You may add Your own attribution\\n notices within Derivative Works that You distribute, alongside\\n or as an addendum to the NOTICE text from the Work, provided\\n that such additional attribution notices cannot be construed\\n as modifying the License.\\n\\n You may add Your own copyright statement to Your modifications and\\n may provide additional or different license terms and conditions\\n for use, reproduction, or distribution of Your modifications, or\\n for any such Derivative Works as a whole, provided Your use,\\n reproduction, and distribution of the Work otherwise complies with\\n the conditions stated in this License.\\n\\n 5. Submission of Contributions. Unless You explicitly state otherwise,\\n any Contribution intentionally submitted for inclusion in the Work\\n by You to the Licensor shall be under the terms and conditions of\\n this License, without any additional terms or conditions.\\n Notwithstanding the above, nothing herein shall supersede or modify\\n the terms of any separate license agreement you may have executed\\n with Licensor regarding such Contributions.\\n\\n 6. Trademarks. This License does not grant permission to use the trade\\n names, trademarks, service marks, or product names of the Licensor,\\n except as required for reasonable and customary use in describing the\\n origin of the Work and reproducing the content of the NOTICE file.\\n\\n 7. Disclaimer of Warranty. Unless required by applicable law or\\n agreed to in writing, Licensor provides the Work (and each\\n Contributor provides its Contributions) on an \\\"AS IS\\\" BASIS,\\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\\n implied, including, without limitation, any warranties or conditions\\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\\n PARTICULAR PURPOSE. You are solely responsible for determining the\\n appropriateness of using or redistributing the Work and assume any\\n risks associated with Your exercise of permissions under this License.\\n\\n 8. Limitation of Liability. In no event and under no legal theory,\\n whether in tort (including negligence), contract, or otherwise,\\n unless required by applicable law (such as deliberate and grossly\\n negligent acts) or agreed to in writing, shall any Contributor be\\n liable to You for damages, including any direct, indirect, special,\\n incidental, or consequential damages of any character arising as a\\n result of this License or out of the use or inability to use the\\n Work (including but not limited to damages for loss of goodwill,\\n work stoppage, computer failure or malfunction, or any and all\\n other commercial damages or losses), even if such Contributor\\n has been advised of the possibility of such damages.\\n\\n 9. Accepting Warranty or Additional Liability. While redistributing\\n the Work or Derivative Works thereof, You may choose to offer,\\n and charge a fee for, acceptance of support, warranty, indemnity,\\n or other liability obligations and/or rights consistent with this\\n License. However, in accepting such obligations, You may act only\\n on Your own behalf and on Your sole responsibility, not on behalf\\n of any other Contributor, and only if You agree to indemnify,\\n defend, and hold each Contributor harmless for any liability\\n incurred by, or claims asserted against, such Contributor by reason\\n of your accepting any such warranty or additional liability.\\n\\n END OF TERMS AND CONDITIONS\\n\\n APPENDIX: How to apply the Apache License to your work.\\n\\n To apply the Apache License to your work, attach the following\\n boilerplate notice, with the fields enclosed by brackets \\\"[]\\\"\\n replaced with your own identifying information. (Don't include\\n the brackets!) The text should be enclosed in the appropriate\\n comment syntax for the file format. We also recommend that a\\n file or class name and description of purpose be included on the\\n same \\\"printed page\\\" as the copyright notice for easier\\n identification within third-party archives.\\n\\n Copyright [yyyy] [name of copyright owner]\\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[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[build-system]\\n# Minimum requirements for the build system to execute.\\n# PEP 508 specifications for PEP 518.\\n# Banned setuptools versions have well-known issues\\nrequires = [\\n \\\"setuptools >= 21.0.0,!=24.0.0,!=34.0.0,!=34.0.1,!=34.0.2,!=34.0.3,!=34.1.0,!=34.1.1,!=34.2.0,!=34.3.0,!=34.3.1,!=34.3.2,!=36.2.0\\\", # PSF/ZPL\\n \\\"setuptools_scm[toml]>=3.4\\\",\\n]\\nbuild-backend=\\\"setuptools.build_meta\\\"\\n\\n[tool.ruff]\\nline-length = 88\\nindent-width = 4\\ntarget-version = \\\"py39\\\"\\n\\n[tool.mypy]\\nstrict = true\\nfiles = [\\\"tenacity\\\", \\\"tests\\\"]\\nshow_error_codes = true\\n\\n[[tool.mypy.overrides]]\\nmodule = \\\"tornado.*\\\"\\nignore_missing_imports = true\\n\\n[tool.setuptools_scm]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"version: 2\\npython:\\n install:\\n - method: pip\\n path: .\\n extra_requirements:\\n - doc\\n\\n[end of .readthedocs.yml]\",\n \"filename\": \".readthedocs.yml\",\n \"id\": \"4\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\ncharset = utf-8\\nend_of_line = lf\\nindent_size = 2\\nindent_style = space\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\n\\n[*.{py,pyx,pxd,pyi}]\\nindent_size = 4\\nmax_line_length = 120\\n\\n[*.ini]\\nindent_size = 4\\n\\n[*.rst]\\nmax_line_length = 150\\n\\n[Makefile]\\nindent_style = tab\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"5\"\n },\n {\n \"content\": \"#!/usr/bin/env python\\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\\n# implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport setuptools\\n\\nsetuptools.setup(\\n setup_requires=[\\\"setuptools_scm\\\"],\\n use_scm_version=True,\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"[tox]\\n# we only test trio on latest python version\\nenvlist = py3{9,10,11,12,13,13-trio}, pep8, pypy3\\nskip_missing_interpreters = True\\n\\n[testenv]\\nusedevelop = True\\nsitepackages = False\\ndeps =\\n .[test]\\n .[doc]\\n trio: trio\\ncommands =\\n py3{8,9,10,11,12,13},pypy3: pytest {posargs}\\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b doctest doc/source doc/build\\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b html doc/source doc/build\\n\\n[testenv:pep8]\\nbasepython = python3\\ndeps = ruff\\ncommands =\\n ruff check . {posargs}\\n ruff format --check . {posargs}\\n\\n[testenv:mypy]\\ndeps =\\n mypy>=1.0.0\\n pytest # for stubs\\n trio\\ncommands =\\n mypy {posargs}\\n\\n[testenv:reno]\\nbasepython = python3\\ndeps = reno\\ncommands = reno {posargs}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"7\"\n },\n {\n \"content\": \"[metadata]\\nname = tenacity\\nlicense = Apache 2.0\\nurl = https://github.com/jd/tenacity\\nsummary = Retry code until it succeeds\\nlong_description = Tenacity is a general-purpose retrying library to simplify the task of adding retry behavior to just about anything.\\nauthor = Julien Danjou\\nauthor_email = julien@danjou.info\\nhome_page = https://github.com/jd/tenacity\\nclassifier =\\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 :: Only\\n Programming Language :: Python :: 3.9\\n Programming Language :: Python :: 3.10\\n Programming Language :: Python :: 3.11\\n Programming Language :: Python :: 3.12\\n Programming Language :: Python :: 3.13\\n Topic :: Utilities\\n\\n[options]\\ninstall_requires =\\npython_requires = >=3.9\\npackages = find:\\n\\n[options.packages.find]\\ninclude = tenacity*\\nexclude = tests\\n\\n[options.package_data]\\ntenacity = py.typed\\n\\n[options.extras_require]\\ndoc =\\n reno\\n sphinx\\ntest =\\n pytest\\n tornado>=4.5\\n typeguard\\n\\n[tool:pytest]\\nfilterwarnings =\\n # Show any DeprecationWarnings once\\n once::DeprecationWarning\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"8\"\n },\n {\n \"content\": \"Tenacity\\n========\\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\\n :target: https://pypi.python.org/pypi/tenacity\\n\\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\\n :target: https://circleci.com/gh/jd/tenacity\\n\\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\\n :target: https://mergify.io\\n :alt: Mergify Status\\n\\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\\n\\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\\nPython, to simplify the task of adding retry behavior to just about anything.\\nIt originates from `a fork of retrying\\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\\napi compatible with retrying but adds significant new functionality and\\nfixes a number of longstanding bugs.\\n\\nThe simplest use case is retrying a flaky function whenever an `Exception`\\noccurs until a value is returned.\\n\\n.. testcode::\\n\\n import random\\n from tenacity import retry\\n\\n @retry\\n def do_something_unreliable():\\n if random.randint(0, 10) > 1:\\n raise IOError(\\\"Broken sauce, everything is hosed!!!111one\\\")\\n else:\\n return \\\"Awesome sauce!\\\"\\n\\n print(do_something_unreliable())\\n\\n.. testoutput::\\n :hide:\\n\\n Awesome sauce!\\n\\n\\n.. toctree::\\n :hidden:\\n :maxdepth: 2\\n\\n changelog\\n api\\n\\n\\nFeatures\\n--------\\n\\n- Generic Decorator API\\n- Specify stop condition (i.e. limit by number of attempts)\\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\\n- Customize retrying on Exceptions\\n- Customize retrying on expected returned result\\n- Retry on coroutines\\n- Retry code block with context manager\\n\\n\\nInstallation\\n------------\\n\\nTo install *tenacity*, simply:\\n\\n.. code-block:: bash\\n\\n $ pip install tenacity\\n\\n\\nExamples\\n----------\\n\\nBasic Retry\\n~~~~~~~~~~~\\n\\n.. testsetup::\\n\\n import logging\\n #\\n # Note the following import is used for demonstration convenience only.\\n # Production code should always explicitly import the names it needs.\\n #\\n from tenacity import *\\n\\n class MyException(Exception):\\n pass\\n\\nAs you saw above, the default behavior is to retry forever without waiting when\\nan exception is raised.\\n\\n.. testcode::\\n\\n @retry\\n def never_gonna_give_you_up():\\n print(\\\"Retry forever ignoring Exceptions, don't wait between retries\\\")\\n raise Exception\\n\\nStopping\\n~~~~~~~~\\n\\nLet's be a little less persistent and set some boundaries, such as the number\\nof attempts before giving up.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(7))\\n def stop_after_7_attempts():\\n print(\\\"Stopping after 7 attempts\\\")\\n raise Exception\\n\\nWe don't have all day, so let's set a boundary for how long we should be\\nretrying stuff.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_delay(10))\\n def stop_after_10_s():\\n print(\\\"Stopping after 10 seconds\\\")\\n raise Exception\\n\\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\\nthen you can give up on retries one attempt before you would exceed the delay.\\n\\n.. testcode::\\n\\n @retry(stop=stop_before_delay(10))\\n def stop_before_10_s():\\n print(\\\"Stopping 1 attempt before 10 seconds\\\")\\n raise Exception\\n\\nYou can combine several stop conditions by using the `|` operator:\\n\\n.. testcode::\\n\\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\\n def stop_after_10_s_or_5_retries():\\n print(\\\"Stopping after 10 seconds or 5 retries\\\")\\n raise Exception\\n\\nWaiting before retrying\\n~~~~~~~~~~~~~~~~~~~~~~~\\n\\nMost things don't like to be polled as fast as possible, so let's just wait 2\\nseconds between retries.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(2))\\n def wait_2_s():\\n print(\\\"Wait 2 second between retries\\\")\\n raise Exception\\n\\nSome things perform best with a bit of randomness injected.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random(min=1, max=2))\\n def wait_random_1_to_2_s():\\n print(\\\"Randomly wait 1 to 2 seconds between retries\\\")\\n raise Exception\\n\\nThen again, it's hard to beat exponential backoff when retrying distributed\\nservices and other remote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\\n def wait_exponential_1():\\n print(\\\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\\\")\\n raise Exception\\n\\n\\nThen again, it's also hard to beat combining fixed waits and jitter (to\\nhelp avoid thundering herds) when retrying distributed services and other\\nremote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\\n def wait_fixed_jitter():\\n print(\\\"Wait at least 3 seconds, and add up to 2 seconds of random delay\\\")\\n raise Exception\\n\\nWhen multiple processes are in contention for a shared resource, exponentially\\nincreasing jitter helps minimise collisions.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\\n def wait_exponential_jitter():\\n print(\\\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\\\")\\n raise Exception\\n\\n\\nSometimes it's necessary to build a chain of backoffs.\\n\\n.. testcode::\\n\\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\\n [wait_fixed(7) for i in range(2)] +\\n [wait_fixed(9)]))\\n def wait_fixed_chained():\\n print(\\\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\\\")\\n raise Exception\\n\\nWhether to retry\\n~~~~~~~~~~~~~~~~\\n\\nWe have a few options for dealing with retries that raise specific or general\\nexceptions, as in the cases here.\\n\\n.. testcode::\\n\\n class ClientError(Exception):\\n \\\"\\\"\\\"Some type of client error.\\\"\\\"\\\"\\n\\n @retry(retry=retry_if_exception_type(IOError))\\n def might_io_error():\\n print(\\\"Retry forever with no wait if an IOError occurs, raise any other errors\\\")\\n raise Exception\\n\\n @retry(retry=retry_if_not_exception_type(ClientError))\\n def might_client_error():\\n print(\\\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\\\")\\n raise Exception\\n\\nWe can also use the result of the function to alter the behavior of retrying.\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=retry_if_result(is_none_p))\\n def might_return_none():\\n print(\\\"Retry with no wait if return value is None\\\")\\n\\nSee also these methods:\\n\\n.. testcode::\\n\\n retry_if_exception\\n retry_if_exception_type\\n retry_if_not_exception_type\\n retry_unless_exception_type\\n retry_if_result\\n retry_if_not_result\\n retry_if_exception_message\\n retry_if_not_exception_message\\n retry_any\\n retry_all\\n\\nWe can also combine several conditions:\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\\n def might_return_none():\\n print(\\\"Retry forever ignoring Exceptions with no wait if return value is None\\\")\\n\\nAny combination of stop, wait, etc. is also supported to give you the freedom\\nto mix and match.\\n\\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\\nexception:\\n\\n.. testcode::\\n\\n @retry\\n def do_something():\\n result = something_else()\\n if result == 23:\\n raise TryAgain\\n\\nError Handling\\n~~~~~~~~~~~~~~\\n\\nNormally when your function fails its final time (and will not be retried again based on your settings),\\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\\nof the stack trace.\\n\\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\\nis most visible), you can set `reraise=True`.\\n\\n.. testcode::\\n\\n @retry(reraise=True, stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except MyException:\\n # timed out retrying\\n pass\\n\\nBefore and After Retry, and Logging\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's possible to execute an action before any attempt of calling the function\\nby using the before callback function:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIn the same spirit, It's possible to execute after a call that failed:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIt's also possible to only log failures that are going to be retried. Normally\\nretries happen after a wait interval, so the keyword argument is called\\n``before_sleep``:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3),\\n before_sleep=before_sleep_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n\\nStatistics\\n~~~~~~~~~~\\n\\nYou can access the statistics about the retry made over a function by using the\\n`statistics` attribute attached to the function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nCustom Callbacks\\n~~~~~~~~~~~~~~~~\\n\\nYou can also define your own callbacks. The callback should accept one\\nparameter called ``retry_state`` that contains all information about current\\nretry invocation.\\n\\nFor example, you can call a custom callback function after all retries failed,\\nwithout raising an exception (or you can re-raise or do anything really)\\n\\n.. testcode::\\n\\n def return_last_value(retry_state):\\n \\\"\\\"\\\"return the result of the last call attempt\\\"\\\"\\\"\\n return retry_state.outcome.result()\\n\\n def is_false(value):\\n \\\"\\\"\\\"Return True if value is False\\\"\\\"\\\"\\n return value is False\\n\\n # will return False after trying 3 times to get a different result\\n @retry(stop=stop_after_attempt(3),\\n retry_error_callback=return_last_value,\\n retry=retry_if_result(is_false))\\n def eventually_return_false():\\n return False\\n\\nRetryCallState\\n~~~~~~~~~~~~~~\\n\\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\\n\\nOther Custom Callbacks\\n~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's also possible to define custom callbacks for other keyword arguments.\\n\\n.. function:: my_stop(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should stop\\n :rtype: bool\\n\\n.. function:: my_wait(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: number of seconds to wait before next retry\\n :rtype: float\\n\\n.. function:: my_retry(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should continue\\n :rtype: bool\\n\\n.. function:: my_before(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_after(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_before_sleep(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\nHere's an example with a custom ``before_sleep`` function:\\n\\n.. testcode::\\n\\n import logging\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n def my_before_sleep(retry_state):\\n if retry_state.attempt_number < 1:\\n loglevel = logging.INFO\\n else:\\n loglevel = logging.WARNING\\n logger.log(\\n loglevel, 'Retrying %s: attempt %s ended with: %s',\\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\\n\\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except RetryError:\\n pass\\n\\n\\nChanging Arguments at Run Time\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nYou can change the arguments of a retry decorator as needed when calling it by\\nusing the `retry_with` function attached to the wrapped function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nIf you want to use variables to set up the retry parameters, you don't have\\nto use the `retry` decorator - you can instead use `Retrying` directly:\\n\\n.. testcode::\\n\\n def never_good_enough(arg1):\\n raise Exception('Invalid argument: {}'.format(arg1))\\n\\n def try_never_good_enough(max_attempts=3):\\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\\n retryer(never_good_enough, 'I really do try')\\n\\nYou may also want to change the behaviour of a decorated function temporarily,\\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\\nattribute attached to the function. Bear in mind this is a write-only attribute,\\nstatistics should be read from the function `statistics` attribute.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n from unittest import mock\\n\\n with mock.patch.object(raise_my_exception.retry, \\\"wait\\\", wait_fixed(0)):\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nRetrying code block\\n~~~~~~~~~~~~~~~~~~~\\n\\nTenacity allows you to retry a code block without the need to wraps it in an\\nisolated function. This makes it easy to isolate failing block while sharing\\ncontext. The trick is to combine a for loop and a context manager.\\n\\n.. testcode::\\n\\n from tenacity import Retrying, RetryError, stop_after_attempt\\n\\n try:\\n for attempt in Retrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nYou can configure every details of retry policy by configuring the Retrying\\nobject.\\n\\nWith async code you can use AsyncRetrying.\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\\n\\n async def function():\\n try:\\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nIn both cases, you may want to set the result to the attempt so it's available\\nin retry strategies like ``retry_if_result``. This can be done accessing the\\n``retry_state`` property:\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, retry_if_result\\n\\n async def function():\\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\\n with attempt:\\n result = 1 # Some complex calculation, function call, etc.\\n if not attempt.retry_state.outcome.failed:\\n attempt.retry_state.set_result(result)\\n return result\\n\\nAsync and retry\\n~~~~~~~~~~~~~~~\\n\\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\\nSleeps are done asynchronously too.\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_asyncio_function(loop):\\n await loop.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_async_trio_function():\\n await trio.socket.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n @tornado.gen.coroutine\\n def my_async_tornado_function(http_client, url):\\n yield http_client.fetch(url)\\n\\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\\n\\n.. code-block:: python\\n\\n @retry(sleep=curio.sleep)\\n async def my_async_curio_function():\\n await asks.get('https://example.org')\\n\\nContribute\\n----------\\n\\n#. Check for open issues or open a fresh issue to start a discussion around a\\n feature idea or a bug.\\n#. Fork `the repository`_ on GitHub to start making your changes to the\\n **main** branch (or branch off of it).\\n#. Write a test which shows that the bug was fixed or that the feature works as\\n expected.\\n#. Add a `changelog <#Changelogs>`_\\n#. Make the docs better (or more detailed, or more easier to read, or ...)\\n\\n.. _`the repository`: https://github.com/jd/tenacity\\n\\nChangelogs\\n~~~~~~~~~~\\n\\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\\n\\nThe doc generation will automatically compile the changelogs. You just need to add them.\\n\\n.. code-block:: sh\\n\\n # Opens a template file in an editor\\n tox -e reno -- new some-slug-for-my-change --edit\\n\\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef before_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"Before call strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef before_log(\\n logger: \\\"logging.Logger\\\", log_level: int\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"Before call strategy that logs to some logger the attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n logger.log(\\n log_level,\\n f\\\"Starting call to '{fn_name}', \\\"\\n f\\\"this is the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\\\",\\n )\\n\\n return log_it\\n\\n[end of tenacity/before.py]\",\n \"filename\": \"tenacity/before.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef before_sleep_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"Before sleep strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef before_sleep_log(\\n logger: \\\"logging.Logger\\\",\\n log_level: int,\\n exc_info: bool = False,\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"Before sleep strategy that logs to some logger the attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n local_exc_info: BaseException | bool | None\\n\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"log_it() called before outcome was set\\\")\\n\\n if retry_state.next_action is None:\\n raise RuntimeError(\\\"log_it() called before next_action was set\\\")\\n\\n if retry_state.outcome.failed:\\n ex = retry_state.outcome.exception()\\n verb, value = \\\"raised\\\", f\\\"{ex.__class__.__name__}: {ex}\\\"\\n\\n if exc_info:\\n local_exc_info = retry_state.outcome.exception()\\n else:\\n local_exc_info = False\\n else:\\n verb, value = \\\"returned\\\", retry_state.outcome.result()\\n local_exc_info = False # exc_info does not apply when no exception\\n\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n\\n logger.log(\\n log_level,\\n f\\\"Retrying {fn_name} \\\"\\n f\\\"in {retry_state.next_action.sleep} seconds as it {verb} {value}.\\\",\\n exc_info=local_exc_info,\\n )\\n\\n return log_it\\n\\n[end of tenacity/before_sleep.py]\",\n \"filename\": \"tenacity/before_sleep.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport abc\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import threading\\n\\n from tenacity import RetryCallState\\n\\n\\nclass stop_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for stop strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n pass\\n\\n def __and__(self, other: \\\"stop_base\\\") -> \\\"stop_all\\\":\\n return stop_all(self, other)\\n\\n def __or__(self, other: \\\"stop_base\\\") -> \\\"stop_any\\\":\\n return stop_any(self, other)\\n\\n\\nStopBaseT = typing.Union[stop_base, typing.Callable[[\\\"RetryCallState\\\"], bool]]\\n\\n\\nclass stop_any(stop_base):\\n \\\"\\\"\\\"Stop if any of the stop condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *stops: stop_base) -> None:\\n self.stops = stops\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return any(x(retry_state) for x in self.stops)\\n\\n\\nclass stop_all(stop_base):\\n \\\"\\\"\\\"Stop if all the stop conditions are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *stops: stop_base) -> None:\\n self.stops = stops\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return all(x(retry_state) for x in self.stops)\\n\\n\\nclass _stop_never(stop_base):\\n \\\"\\\"\\\"Never stop.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return False\\n\\n\\nstop_never = _stop_never()\\n\\n\\nclass stop_when_event_set(stop_base):\\n \\\"\\\"\\\"Stop when the given event is set.\\\"\\\"\\\"\\n\\n def __init__(self, event: \\\"threading.Event\\\") -> None:\\n self.event = event\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return self.event.is_set()\\n\\n\\nclass stop_after_attempt(stop_base):\\n \\\"\\\"\\\"Stop when the previous attempt >= max_attempt.\\\"\\\"\\\"\\n\\n def __init__(self, max_attempt_number: int) -> None:\\n self.max_attempt_number = max_attempt_number\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return retry_state.attempt_number >= self.max_attempt_number\\n\\n\\nclass stop_after_delay(stop_base):\\n \\\"\\\"\\\"\\n Stop when the time from the first attempt >= limit.\\n\\n Note: `max_delay` will be exceeded, so when used with a `wait`, the actual total delay will be greater\\n than `max_delay` by some of the final sleep period before `max_delay` is exceeded.\\n\\n If you need stricter timing with waits, consider `stop_before_delay` instead.\\n \\\"\\\"\\\"\\n\\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\\n self.max_delay = _utils.to_seconds(max_delay)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.seconds_since_start is None:\\n raise RuntimeError(\\\"__call__() called but seconds_since_start is not set\\\")\\n return retry_state.seconds_since_start >= self.max_delay\\n\\n\\nclass stop_before_delay(stop_base):\\n \\\"\\\"\\\"\\n Stop right before the next attempt would take place after the time from the first attempt >= limit.\\n\\n Most useful when you are using with a `wait` function like wait_random_exponential, but need to make\\n sure that the max_delay is not exceeded.\\n \\\"\\\"\\\"\\n\\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\\n self.max_delay = _utils.to_seconds(max_delay)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.seconds_since_start is None:\\n raise RuntimeError(\\\"__call__() called but seconds_since_start is not set\\\")\\n return (\\n retry_state.seconds_since_start + retry_state.upcoming_sleep\\n >= self.max_delay\\n )\\n\\n[end of tenacity/stop.py]\",\n \"filename\": \"tenacity/stop.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport abc\\nimport random\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass wait_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for wait strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n pass\\n\\n def __add__(self, other: \\\"wait_base\\\") -> \\\"wait_combine\\\":\\n return wait_combine(self, other)\\n\\n def __radd__(self, other: \\\"wait_base\\\") -> typing.Union[\\\"wait_combine\\\", \\\"wait_base\\\"]:\\n # make it possible to use multiple waits with the built-in sum function\\n if other == 0: # type: ignore[comparison-overlap]\\n return self\\n return self.__add__(other)\\n\\n\\nWaitBaseT = typing.Union[\\n wait_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Union[float, int]]\\n]\\n\\n\\nclass wait_fixed(wait_base):\\n \\\"\\\"\\\"Wait strategy that waits a fixed amount of time between each retry.\\\"\\\"\\\"\\n\\n def __init__(self, wait: _utils.time_unit_type) -> None:\\n self.wait_fixed = _utils.to_seconds(wait)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return self.wait_fixed\\n\\n\\nclass wait_none(wait_fixed):\\n \\\"\\\"\\\"Wait strategy that doesn't wait at all before retrying.\\\"\\\"\\\"\\n\\n def __init__(self) -> None:\\n super().__init__(0)\\n\\n\\nclass wait_random(wait_base):\\n \\\"\\\"\\\"Wait strategy that waits a random amount of time between min/max.\\\"\\\"\\\"\\n\\n def __init__(\\n self, min: _utils.time_unit_type = 0, max: _utils.time_unit_type = 1\\n ) -> None: # noqa\\n self.wait_random_min = _utils.to_seconds(min)\\n self.wait_random_max = _utils.to_seconds(max)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return self.wait_random_min + (\\n random.random() * (self.wait_random_max - self.wait_random_min)\\n )\\n\\n\\nclass wait_combine(wait_base):\\n \\\"\\\"\\\"Combine several waiting strategies.\\\"\\\"\\\"\\n\\n def __init__(self, *strategies: wait_base) -> None:\\n self.wait_funcs = strategies\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return sum(x(retry_state=retry_state) for x in self.wait_funcs)\\n\\n\\nclass wait_chain(wait_base):\\n \\\"\\\"\\\"Chain two or more waiting strategies.\\n\\n If all strategies are exhausted, the very last strategy is used\\n thereafter.\\n\\n For example::\\n\\n @retry(wait=wait_chain(*[wait_fixed(1) for i in range(3)] +\\n [wait_fixed(2) for j in range(5)] +\\n [wait_fixed(5) for k in range(4)))\\n def wait_chained():\\n print(\\\"Wait 1s for 3 attempts, 2s for 5 attempts and 5s\\n thereafter.\\\")\\n \\\"\\\"\\\"\\n\\n def __init__(self, *strategies: wait_base) -> None:\\n self.strategies = strategies\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n wait_func_no = min(max(retry_state.attempt_number, 1), len(self.strategies))\\n wait_func = self.strategies[wait_func_no - 1]\\n return wait_func(retry_state=retry_state)\\n\\n\\nclass wait_incrementing(wait_base):\\n \\\"\\\"\\\"Wait an incremental amount of time after each attempt.\\n\\n Starting at a starting value and incrementing by a value for each attempt\\n (and restricting the upper limit to some maximum value).\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n start: _utils.time_unit_type = 0,\\n increment: _utils.time_unit_type = 100,\\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\\n ) -> None:\\n self.start = _utils.to_seconds(start)\\n self.increment = _utils.to_seconds(increment)\\n self.max = _utils.to_seconds(max)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n result = self.start + (self.increment * (retry_state.attempt_number - 1))\\n return max(0, min(result, self.max))\\n\\n\\nclass wait_exponential(wait_base):\\n \\\"\\\"\\\"Wait strategy that applies exponential backoff.\\n\\n It allows for a customized multiplier and an ability to restrict the\\n upper and lower limits to some maximum and minimum value.\\n\\n The intervals are fixed (i.e. there is no jitter), so this strategy is\\n suitable for balancing retries against latency when a required resource is\\n unavailable for an unknown duration, but *not* suitable for resolving\\n contention between multiple processes for a shared resource. Use\\n wait_random_exponential for the latter case.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n multiplier: typing.Union[int, float] = 1,\\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\\n exp_base: typing.Union[int, float] = 2,\\n min: _utils.time_unit_type = 0, # noqa\\n ) -> None:\\n self.multiplier = multiplier\\n self.min = _utils.to_seconds(min)\\n self.max = _utils.to_seconds(max)\\n self.exp_base = exp_base\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n try:\\n exp = self.exp_base ** (retry_state.attempt_number - 1)\\n result = self.multiplier * exp\\n except OverflowError:\\n return self.max\\n return max(max(0, self.min), min(result, self.max))\\n\\n\\nclass wait_random_exponential(wait_exponential):\\n \\\"\\\"\\\"Random wait with exponentially widening window.\\n\\n An exponential backoff strategy used to mediate contention between multiple\\n uncoordinated processes for a shared resource in distributed systems. This\\n is the sense in which \\\"exponential backoff\\\" is meant in e.g. Ethernet\\n networking, and corresponds to the \\\"Full Jitter\\\" algorithm described in\\n this blog post:\\n\\n https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/\\n\\n Each retry occurs at a random time in a geometrically expanding interval.\\n It allows for a custom multiplier and an ability to restrict the upper\\n limit of the random interval to some maximum value.\\n\\n Example::\\n\\n wait_random_exponential(multiplier=0.5, # initial window 0.5s\\n max=60) # max 60s timeout\\n\\n When waiting for an unavailable resource to become available again, as\\n opposed to trying to resolve contention for a shared resource, the\\n wait_exponential strategy (which uses a fixed interval) may be preferable.\\n\\n \\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n high = super().__call__(retry_state=retry_state)\\n return random.uniform(self.min, high)\\n\\n\\nclass wait_exponential_jitter(wait_base):\\n \\\"\\\"\\\"Wait strategy that applies exponential backoff and jitter.\\n\\n It allows for a customized initial wait, maximum wait and jitter.\\n\\n This implements the strategy described here:\\n https://cloud.google.com/storage/docs/retry-strategy\\n\\n The wait time is min(initial * 2**n + random.uniform(0, jitter), maximum)\\n where n is the retry count.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n initial: float = 1,\\n max: float = _utils.MAX_WAIT, # noqa\\n exp_base: float = 2,\\n jitter: float = 1,\\n ) -> None:\\n self.initial = initial\\n self.max = max\\n self.exp_base = exp_base\\n self.jitter = jitter\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n jitter = random.uniform(0, self.jitter)\\n try:\\n exp = self.exp_base ** (retry_state.attempt_number - 1)\\n result = self.initial * exp + jitter\\n except OverflowError:\\n result = self.max\\n return max(0, min(result, self.max))\\n\\n[end of tenacity/wait.py]\",\n \"filename\": \"tenacity/wait.py\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# Copyright 2016-2018 Julien Danjou\\n# Copyright 2017 Elisey Zanko\\n# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport dataclasses\\nimport functools\\nimport sys\\nimport threading\\nimport time\\nimport typing as t\\nimport warnings\\nfrom abc import ABC, abstractmethod\\nfrom concurrent import futures\\n\\nfrom . import _utils\\n\\n# Import all built-in retry strategies for easier usage.\\nfrom .retry import retry_base # noqa\\nfrom .retry import retry_all # noqa\\nfrom .retry import retry_always # noqa\\nfrom .retry import retry_any # noqa\\nfrom .retry import retry_if_exception # noqa\\nfrom .retry import retry_if_exception_type # noqa\\nfrom .retry import retry_if_exception_cause_type # noqa\\nfrom .retry import retry_if_not_exception_type # noqa\\nfrom .retry import retry_if_not_result # noqa\\nfrom .retry import retry_if_result # noqa\\nfrom .retry import retry_never # noqa\\nfrom .retry import retry_unless_exception_type # noqa\\nfrom .retry import retry_if_exception_message # noqa\\nfrom .retry import retry_if_not_exception_message # noqa\\n\\n# Import all nap strategies for easier usage.\\nfrom .nap import sleep # noqa\\nfrom .nap import sleep_using_event # noqa\\n\\n# Import all built-in stop strategies for easier usage.\\nfrom .stop import stop_after_attempt # noqa\\nfrom .stop import stop_after_delay # noqa\\nfrom .stop import stop_before_delay # noqa\\nfrom .stop import stop_all # noqa\\nfrom .stop import stop_any # noqa\\nfrom .stop import stop_never # noqa\\nfrom .stop import stop_when_event_set # noqa\\n\\n# Import all built-in wait strategies for easier usage.\\nfrom .wait import wait_chain # noqa\\nfrom .wait import wait_combine # noqa\\nfrom .wait import wait_exponential # noqa\\nfrom .wait import wait_fixed # noqa\\nfrom .wait import wait_incrementing # noqa\\nfrom .wait import wait_none # noqa\\nfrom .wait import wait_random # noqa\\nfrom .wait import wait_random_exponential # noqa\\nfrom .wait import wait_random_exponential as wait_full_jitter # noqa\\nfrom .wait import wait_exponential_jitter # noqa\\n\\n# Import all built-in before strategies for easier usage.\\nfrom .before import before_log # noqa\\nfrom .before import before_nothing # noqa\\n\\n# Import all built-in after strategies for easier usage.\\nfrom .after import after_log # noqa\\nfrom .after import after_nothing # noqa\\n\\n# Import all built-in before sleep strategies for easier usage.\\nfrom .before_sleep import before_sleep_log # noqa\\nfrom .before_sleep import before_sleep_nothing # noqa\\n\\ntry:\\n import tornado\\nexcept ImportError:\\n tornado = None\\n\\nif t.TYPE_CHECKING:\\n import types\\n\\n from typing_extensions import Self\\n\\n from . import asyncio as tasyncio\\n from .retry import RetryBaseT\\n from .stop import StopBaseT\\n from .wait import WaitBaseT\\n\\n\\nWrappedFnReturnT = t.TypeVar(\\\"WrappedFnReturnT\\\")\\nWrappedFn = t.TypeVar(\\\"WrappedFn\\\", bound=t.Callable[..., t.Any])\\n\\n\\ndataclass_kwargs = {}\\nif sys.version_info >= (3, 10):\\n dataclass_kwargs.update({\\\"slots\\\": True})\\n\\n\\n@dataclasses.dataclass(**dataclass_kwargs)\\nclass IterState:\\n actions: t.List[t.Callable[[\\\"RetryCallState\\\"], t.Any]] = dataclasses.field(\\n default_factory=list\\n )\\n retry_run_result: bool = False\\n delay_since_first_attempt: int = 0\\n stop_run_result: bool = False\\n is_explicit_retry: bool = False\\n\\n def reset(self) -> None:\\n self.actions = []\\n self.retry_run_result = False\\n self.delay_since_first_attempt = 0\\n self.stop_run_result = False\\n self.is_explicit_retry = False\\n\\n\\nclass TryAgain(Exception):\\n \\\"\\\"\\\"Always retry the executed function when raised.\\\"\\\"\\\"\\n\\n\\nNO_RESULT = object()\\n\\n\\nclass DoAttempt:\\n pass\\n\\n\\nclass DoSleep(float):\\n pass\\n\\n\\nclass BaseAction:\\n \\\"\\\"\\\"Base class for representing actions to take by retry object.\\n\\n Concrete implementations must define:\\n - __init__: to initialize all necessary fields\\n - REPR_FIELDS: class variable specifying attributes to include in repr(self)\\n - NAME: for identification in retry object methods and callbacks\\n \\\"\\\"\\\"\\n\\n REPR_FIELDS: t.Sequence[str] = ()\\n NAME: t.Optional[str] = None\\n\\n def __repr__(self) -> str:\\n state_str = \\\", \\\".join(\\n f\\\"{field}={getattr(self, field)!r}\\\" for field in self.REPR_FIELDS\\n )\\n return f\\\"{self.__class__.__name__}({state_str})\\\"\\n\\n def __str__(self) -> str:\\n return repr(self)\\n\\n\\nclass RetryAction(BaseAction):\\n REPR_FIELDS = (\\\"sleep\\\",)\\n NAME = \\\"retry\\\"\\n\\n def __init__(self, sleep: t.SupportsFloat) -> None:\\n self.sleep = float(sleep)\\n\\n\\n_unset = object()\\n\\n\\ndef _first_set(first: t.Union[t.Any, object], second: t.Any) -> t.Any:\\n return second if first is _unset else first\\n\\n\\nclass RetryError(Exception):\\n \\\"\\\"\\\"Encapsulates the last attempt instance right before giving up.\\\"\\\"\\\"\\n\\n def __init__(self, last_attempt: \\\"Future\\\") -> None:\\n self.last_attempt = last_attempt\\n super().__init__(last_attempt)\\n\\n def reraise(self) -> t.NoReturn:\\n if self.last_attempt.failed:\\n raise self.last_attempt.result()\\n raise self\\n\\n def __str__(self) -> str:\\n return f\\\"{self.__class__.__name__}[{self.last_attempt}]\\\"\\n\\n\\nclass AttemptManager:\\n \\\"\\\"\\\"Manage attempt context.\\\"\\\"\\\"\\n\\n def __init__(self, retry_state: \\\"RetryCallState\\\"):\\n self.retry_state = retry_state\\n\\n def __enter__(self) -> None:\\n pass\\n\\n def __exit__(\\n self,\\n exc_type: t.Optional[t.Type[BaseException]],\\n exc_value: t.Optional[BaseException],\\n traceback: t.Optional[\\\"types.TracebackType\\\"],\\n ) -> t.Optional[bool]:\\n if exc_type is not None and exc_value is not None:\\n self.retry_state.set_exception((exc_type, exc_value, traceback))\\n return True # Swallow exception.\\n else:\\n # We don't have the result, actually.\\n self.retry_state.set_result(None)\\n return None\\n\\n\\nclass BaseRetrying(ABC):\\n def __init__(\\n self,\\n sleep: t.Callable[[t.Union[int, float]], None] = sleep,\\n stop: \\\"StopBaseT\\\" = stop_never,\\n wait: \\\"WaitBaseT\\\" = wait_none(),\\n retry: \\\"RetryBaseT\\\" = retry_if_exception_type(),\\n before: t.Callable[[\\\"RetryCallState\\\"], None] = before_nothing,\\n after: t.Callable[[\\\"RetryCallState\\\"], None] = after_nothing,\\n before_sleep: t.Optional[t.Callable[[\\\"RetryCallState\\\"], None]] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[RetryError] = RetryError,\\n retry_error_callback: t.Optional[t.Callable[[\\\"RetryCallState\\\"], t.Any]] = None,\\n ):\\n self.sleep = sleep\\n self.stop = stop\\n self.wait = wait\\n self.retry = retry\\n self.before = before\\n self.after = after\\n self.before_sleep = before_sleep\\n self.reraise = reraise\\n self._local = threading.local()\\n self.retry_error_cls = retry_error_cls\\n self.retry_error_callback = retry_error_callback\\n\\n def copy(\\n self,\\n sleep: t.Union[t.Callable[[t.Union[int, float]], None], object] = _unset,\\n stop: t.Union[\\\"StopBaseT\\\", object] = _unset,\\n wait: t.Union[\\\"WaitBaseT\\\", object] = _unset,\\n retry: t.Union[retry_base, object] = _unset,\\n before: t.Union[t.Callable[[\\\"RetryCallState\\\"], None], object] = _unset,\\n after: t.Union[t.Callable[[\\\"RetryCallState\\\"], None], object] = _unset,\\n before_sleep: t.Union[\\n t.Optional[t.Callable[[\\\"RetryCallState\\\"], None]], object\\n ] = _unset,\\n reraise: t.Union[bool, object] = _unset,\\n retry_error_cls: t.Union[t.Type[RetryError], object] = _unset,\\n retry_error_callback: t.Union[\\n t.Optional[t.Callable[[\\\"RetryCallState\\\"], t.Any]], object\\n ] = _unset,\\n ) -> \\\"Self\\\":\\n \\\"\\\"\\\"Copy this object with some parameters changed if needed.\\\"\\\"\\\"\\n return self.__class__(\\n sleep=_first_set(sleep, self.sleep),\\n stop=_first_set(stop, self.stop),\\n wait=_first_set(wait, self.wait),\\n retry=_first_set(retry, self.retry),\\n before=_first_set(before, self.before),\\n after=_first_set(after, self.after),\\n before_sleep=_first_set(before_sleep, self.before_sleep),\\n reraise=_first_set(reraise, self.reraise),\\n retry_error_cls=_first_set(retry_error_cls, self.retry_error_cls),\\n retry_error_callback=_first_set(\\n retry_error_callback, self.retry_error_callback\\n ),\\n )\\n\\n def __repr__(self) -> str:\\n return (\\n f\\\"<{self.__class__.__name__} object at 0x{id(self):x} (\\\"\\n f\\\"stop={self.stop}, \\\"\\n f\\\"wait={self.wait}, \\\"\\n f\\\"sleep={self.sleep}, \\\"\\n f\\\"retry={self.retry}, \\\"\\n f\\\"before={self.before}, \\\"\\n f\\\"after={self.after})>\\\"\\n )\\n\\n @property\\n def statistics(self) -> t.Dict[str, t.Any]:\\n \\\"\\\"\\\"Return a dictionary of runtime statistics.\\n\\n This dictionary will be empty when the controller has never been\\n ran. When it is running or has ran previously it should have (but\\n may not) have useful and/or informational keys and values when\\n running is underway and/or completed.\\n\\n .. warning:: The keys in this dictionary **should** be some what\\n stable (not changing), but there existence **may**\\n change between major releases as new statistics are\\n gathered or removed so before accessing keys ensure that\\n they actually exist and handle when they do not.\\n\\n .. note:: The values in this dictionary are local to the thread\\n running call (so if multiple threads share the same retrying\\n object - either directly or indirectly) they will each have\\n there own view of statistics they have collected (in the\\n future we may provide a way to aggregate the various\\n statistics from each thread).\\n \\\"\\\"\\\"\\n try:\\n return self._local.statistics # type: ignore[no-any-return]\\n except AttributeError:\\n self._local.statistics = t.cast(t.Dict[str, t.Any], {})\\n return self._local.statistics\\n\\n @property\\n def iter_state(self) -> IterState:\\n try:\\n return self._local.iter_state # type: ignore[no-any-return]\\n except AttributeError:\\n self._local.iter_state = IterState()\\n return self._local.iter_state\\n\\n def wraps(self, f: WrappedFn) -> WrappedFn:\\n \\\"\\\"\\\"Wrap a function for retrying.\\n\\n :param f: A function to wraps for retrying.\\n \\\"\\\"\\\"\\n\\n @functools.wraps(\\n f, functools.WRAPPER_ASSIGNMENTS + (\\\"__defaults__\\\", \\\"__kwdefaults__\\\")\\n )\\n def wrapped_f(*args: t.Any, **kw: t.Any) -> t.Any:\\n # Always create a copy to prevent overwriting the local contexts when\\n # calling the same wrapped functions multiple times in the same stack\\n copy = self.copy()\\n wrapped_f.statistics = copy.statistics # type: ignore[attr-defined]\\n return copy(f, *args, **kw)\\n\\n def retry_with(*args: t.Any, **kwargs: t.Any) -> WrappedFn:\\n return self.copy(*args, **kwargs).wraps(f)\\n\\n # Preserve attributes\\n wrapped_f.retry = self # type: ignore[attr-defined]\\n wrapped_f.retry_with = retry_with # type: ignore[attr-defined]\\n wrapped_f.statistics = {} # type: ignore[attr-defined]\\n\\n return wrapped_f # type: ignore[return-value]\\n\\n def begin(self) -> None:\\n self.statistics.clear()\\n self.statistics[\\\"start_time\\\"] = time.monotonic()\\n self.statistics[\\\"attempt_number\\\"] = 1\\n self.statistics[\\\"idle_for\\\"] = 0\\n\\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\\n self.iter_state.actions.append(fn)\\n\\n def _run_retry(self, retry_state: \\\"RetryCallState\\\") -> None:\\n self.iter_state.retry_run_result = self.retry(retry_state)\\n\\n def _run_wait(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if self.wait:\\n sleep = self.wait(retry_state)\\n else:\\n sleep = 0.0\\n\\n retry_state.upcoming_sleep = sleep\\n\\n def _run_stop(self, retry_state: \\\"RetryCallState\\\") -> None:\\n self.statistics[\\\"delay_since_first_attempt\\\"] = retry_state.seconds_since_start\\n self.iter_state.stop_run_result = self.stop(retry_state)\\n\\n def iter(self, retry_state: \\\"RetryCallState\\\") -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa\\n self._begin_iter(retry_state)\\n result = None\\n for action in self.iter_state.actions:\\n result = action(retry_state)\\n return result\\n\\n def _begin_iter(self, retry_state: \\\"RetryCallState\\\") -> None: # noqa\\n self.iter_state.reset()\\n\\n fut = retry_state.outcome\\n if fut is None:\\n if self.before is not None:\\n self._add_action_func(self.before)\\n self._add_action_func(lambda rs: DoAttempt())\\n return\\n\\n self.iter_state.is_explicit_retry = fut.failed and isinstance(\\n fut.exception(), TryAgain\\n )\\n if not self.iter_state.is_explicit_retry:\\n self._add_action_func(self._run_retry)\\n self._add_action_func(self._post_retry_check_actions)\\n\\n def _post_retry_check_actions(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if not (self.iter_state.is_explicit_retry or self.iter_state.retry_run_result):\\n self._add_action_func(lambda rs: rs.outcome.result())\\n return\\n\\n if self.after is not None:\\n self._add_action_func(self.after)\\n\\n self._add_action_func(self._run_wait)\\n self._add_action_func(self._run_stop)\\n self._add_action_func(self._post_stop_check_actions)\\n\\n def _post_stop_check_actions(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if self.iter_state.stop_run_result:\\n if self.retry_error_callback:\\n self._add_action_func(self.retry_error_callback)\\n return\\n\\n def exc_check(rs: \\\"RetryCallState\\\") -> None:\\n fut = t.cast(Future, rs.outcome)\\n retry_exc = self.retry_error_cls(fut)\\n if self.reraise:\\n raise retry_exc.reraise()\\n raise retry_exc from fut.exception()\\n\\n self._add_action_func(exc_check)\\n return\\n\\n def next_action(rs: \\\"RetryCallState\\\") -> None:\\n sleep = rs.upcoming_sleep\\n rs.next_action = RetryAction(sleep)\\n rs.idle_for += sleep\\n self.statistics[\\\"idle_for\\\"] += sleep\\n self.statistics[\\\"attempt_number\\\"] += 1\\n\\n self._add_action_func(next_action)\\n\\n if self.before_sleep is not None:\\n self._add_action_func(self.before_sleep)\\n\\n self._add_action_func(lambda rs: DoSleep(rs.upcoming_sleep))\\n\\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\\n self.begin()\\n\\n retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n yield AttemptManager(retry_state=retry_state)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n self.sleep(do)\\n else:\\n break\\n\\n @abstractmethod\\n def __call__(\\n self,\\n fn: t.Callable[..., WrappedFnReturnT],\\n *args: t.Any,\\n **kwargs: t.Any,\\n ) -> WrappedFnReturnT:\\n pass\\n\\n\\nclass Retrying(BaseRetrying):\\n \\\"\\\"\\\"Retrying controller.\\\"\\\"\\\"\\n\\n def __call__(\\n self,\\n fn: t.Callable[..., WrappedFnReturnT],\\n *args: t.Any,\\n **kwargs: t.Any,\\n ) -> WrappedFnReturnT:\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n self.sleep(do)\\n else:\\n return do # type: ignore[no-any-return]\\n\\n\\nif sys.version_info >= (3, 9):\\n FutureGenericT = futures.Future[t.Any]\\nelse:\\n FutureGenericT = futures.Future\\n\\n\\nclass Future(FutureGenericT):\\n \\\"\\\"\\\"Encapsulates a (future or past) attempted call to a target function.\\\"\\\"\\\"\\n\\n def __init__(self, attempt_number: int) -> None:\\n super().__init__()\\n self.attempt_number = attempt_number\\n\\n @property\\n def failed(self) -> bool:\\n \\\"\\\"\\\"Return whether a exception is being held in this future.\\\"\\\"\\\"\\n return self.exception() is not None\\n\\n @classmethod\\n def construct(\\n cls, attempt_number: int, value: t.Any, has_exception: bool\\n ) -> \\\"Future\\\":\\n \\\"\\\"\\\"Construct a new Future object.\\\"\\\"\\\"\\n fut = cls(attempt_number)\\n if has_exception:\\n fut.set_exception(value)\\n else:\\n fut.set_result(value)\\n return fut\\n\\n\\nclass RetryCallState:\\n \\\"\\\"\\\"State related to a single call wrapped with Retrying.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n retry_object: BaseRetrying,\\n fn: t.Optional[WrappedFn],\\n args: t.Any,\\n kwargs: t.Any,\\n ) -> None:\\n #: Retry call start timestamp\\n self.start_time = time.monotonic()\\n #: Retry manager object\\n self.retry_object = retry_object\\n #: Function wrapped by this retry call\\n self.fn = fn\\n #: Arguments of the function wrapped by this retry call\\n self.args = args\\n #: Keyword arguments of the function wrapped by this retry call\\n self.kwargs = kwargs\\n\\n #: The number of the current attempt\\n self.attempt_number: int = 1\\n #: Last outcome (result or exception) produced by the function\\n self.outcome: t.Optional[Future] = None\\n #: Timestamp of the last outcome\\n self.outcome_timestamp: t.Optional[float] = None\\n #: Time spent sleeping in retries\\n self.idle_for: float = 0.0\\n #: Next action as decided by the retry manager\\n self.next_action: t.Optional[RetryAction] = None\\n #: Next sleep time as decided by the retry manager.\\n self.upcoming_sleep: float = 0.0\\n\\n @property\\n def seconds_since_start(self) -> t.Optional[float]:\\n if self.outcome_timestamp is None:\\n return None\\n return self.outcome_timestamp - self.start_time\\n\\n def prepare_for_next_attempt(self) -> None:\\n self.outcome = None\\n self.outcome_timestamp = None\\n self.attempt_number += 1\\n self.next_action = None\\n\\n def set_result(self, val: t.Any) -> None:\\n ts = time.monotonic()\\n fut = Future(self.attempt_number)\\n fut.set_result(val)\\n self.outcome, self.outcome_timestamp = fut, ts\\n\\n def set_exception(\\n self,\\n exc_info: t.Tuple[\\n t.Type[BaseException], BaseException, \\\"types.TracebackType| None\\\"\\n ],\\n ) -> None:\\n ts = time.monotonic()\\n fut = Future(self.attempt_number)\\n fut.set_exception(exc_info[1])\\n self.outcome, self.outcome_timestamp = fut, ts\\n\\n def __repr__(self) -> str:\\n if self.outcome is None:\\n result = \\\"none yet\\\"\\n elif self.outcome.failed:\\n exception = self.outcome.exception()\\n result = f\\\"failed ({exception.__class__.__name__} {exception})\\\"\\n else:\\n result = f\\\"returned {self.outcome.result()}\\\"\\n\\n slept = float(round(self.idle_for, 2))\\n clsname = self.__class__.__name__\\n return f\\\"<{clsname} {id(self)}: attempt #{self.attempt_number}; slept for {slept}; last result: {result}>\\\"\\n\\n\\n@t.overload\\ndef retry(func: WrappedFn) -> WrappedFn: ...\\n\\n\\n@t.overload\\ndef retry(\\n sleep: t.Callable[[t.Union[int, float]], t.Union[None, t.Awaitable[None]]] = sleep,\\n stop: \\\"StopBaseT\\\" = stop_never,\\n wait: \\\"WaitBaseT\\\" = wait_none(),\\n retry: \\\"t.Union[RetryBaseT, tasyncio.retry.RetryBaseT]\\\" = retry_if_exception_type(),\\n before: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = before_nothing,\\n after: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = after_nothing,\\n before_sleep: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]]\\n ] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[\\\"RetryError\\\"] = RetryError,\\n retry_error_callback: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[t.Any, t.Awaitable[t.Any]]]\\n ] = None,\\n) -> t.Callable[[WrappedFn], WrappedFn]: ...\\n\\n\\ndef retry(*dargs: t.Any, **dkw: t.Any) -> t.Any:\\n \\\"\\\"\\\"Wrap a function with a new `Retrying` object.\\n\\n :param dargs: positional arguments passed to Retrying object\\n :param dkw: keyword arguments passed to the Retrying object\\n \\\"\\\"\\\"\\n # support both @retry and @retry() as valid syntax\\n if len(dargs) == 1 and callable(dargs[0]):\\n return retry()(dargs[0])\\n else:\\n\\n def wrap(f: WrappedFn) -> WrappedFn:\\n if isinstance(f, retry_base):\\n warnings.warn(\\n f\\\"Got retry_base instance ({f.__class__.__name__}) as callable argument, \\\"\\n f\\\"this will probably hang indefinitely (did you mean retry={f.__class__.__name__}(...)?)\\\"\\n )\\n r: \\\"BaseRetrying\\\"\\n if _utils.is_coroutine_callable(f):\\n r = AsyncRetrying(*dargs, **dkw)\\n elif (\\n tornado\\n and hasattr(tornado.gen, \\\"is_coroutine_function\\\")\\n and tornado.gen.is_coroutine_function(f)\\n ):\\n r = TornadoRetrying(*dargs, **dkw)\\n else:\\n r = Retrying(*dargs, **dkw)\\n\\n return r.wraps(f)\\n\\n return wrap\\n\\n\\nfrom tenacity.asyncio import AsyncRetrying # noqa:E402,I100\\n\\nif tornado:\\n from tenacity.tornadoweb import TornadoRetrying\\n\\n\\n__all__ = [\\n \\\"retry_base\\\",\\n \\\"retry_all\\\",\\n \\\"retry_always\\\",\\n \\\"retry_any\\\",\\n \\\"retry_if_exception\\\",\\n \\\"retry_if_exception_type\\\",\\n \\\"retry_if_exception_cause_type\\\",\\n \\\"retry_if_not_exception_type\\\",\\n \\\"retry_if_not_result\\\",\\n \\\"retry_if_result\\\",\\n \\\"retry_never\\\",\\n \\\"retry_unless_exception_type\\\",\\n \\\"retry_if_exception_message\\\",\\n \\\"retry_if_not_exception_message\\\",\\n \\\"sleep\\\",\\n \\\"sleep_using_event\\\",\\n \\\"stop_after_attempt\\\",\\n \\\"stop_after_delay\\\",\\n \\\"stop_before_delay\\\",\\n \\\"stop_all\\\",\\n \\\"stop_any\\\",\\n \\\"stop_never\\\",\\n \\\"stop_when_event_set\\\",\\n \\\"wait_chain\\\",\\n \\\"wait_combine\\\",\\n \\\"wait_exponential\\\",\\n \\\"wait_fixed\\\",\\n \\\"wait_incrementing\\\",\\n \\\"wait_none\\\",\\n \\\"wait_random\\\",\\n \\\"wait_random_exponential\\\",\\n \\\"wait_full_jitter\\\",\\n \\\"wait_exponential_jitter\\\",\\n \\\"before_log\\\",\\n \\\"before_nothing\\\",\\n \\\"after_log\\\",\\n \\\"after_nothing\\\",\\n \\\"before_sleep_log\\\",\\n \\\"before_sleep_nothing\\\",\\n \\\"retry\\\",\\n \\\"WrappedFn\\\",\\n \\\"TryAgain\\\",\\n \\\"NO_RESULT\\\",\\n \\\"DoAttempt\\\",\\n \\\"DoSleep\\\",\\n \\\"BaseAction\\\",\\n \\\"RetryAction\\\",\\n \\\"RetryError\\\",\\n \\\"AttemptManager\\\",\\n \\\"BaseRetrying\\\",\\n \\\"Retrying\\\",\\n \\\"Future\\\",\\n \\\"RetryCallState\\\",\\n \\\"AsyncRetrying\\\",\\n]\\n\\n[end of tenacity/__init__.py]\",\n \"filename\": \"tenacity/__init__.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport time\\nimport typing\\n\\nif typing.TYPE_CHECKING:\\n import threading\\n\\n\\ndef sleep(seconds: float) -> None:\\n \\\"\\\"\\\"\\n Sleep strategy that delays execution for a given number of seconds.\\n\\n This is the default strategy, and may be mocked out for unit testing.\\n \\\"\\\"\\\"\\n time.sleep(seconds)\\n\\n\\nclass sleep_using_event:\\n \\\"\\\"\\\"Sleep strategy that waits on an event to be set.\\\"\\\"\\\"\\n\\n def __init__(self, event: \\\"threading.Event\\\") -> None:\\n self.event = event\\n\\n def __call__(self, timeout: typing.Optional[float]) -> None:\\n # NOTE(harlowja): this may *not* actually wait for timeout\\n # seconds if the event is set (ie this may eject out early).\\n self.event.wait(timeout=timeout)\\n\\n[end of tenacity/nap.py]\",\n \"filename\": \"tenacity/nap.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef after_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"After call strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef after_log(\\n logger: \\\"logging.Logger\\\",\\n log_level: int,\\n sec_format: str = \\\"%0.3f\\\",\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"After call strategy that logs to some logger the finished attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n logger.log(\\n log_level,\\n f\\\"Finished call to '{fn_name}' \\\"\\n f\\\"after {sec_format % retry_state.seconds_since_start}(s), \\\"\\n f\\\"this was the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\\\",\\n )\\n\\n return log_it\\n\\n[end of tenacity/after.py]\",\n \"filename\": \"tenacity/after.py\",\n \"id\": \"16\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport abc\\nimport re\\nimport typing\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass retry_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for retry strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n pass\\n\\n def __and__(self, other: \\\"retry_base\\\") -> \\\"retry_all\\\":\\n return other.__rand__(self)\\n\\n def __rand__(self, other: \\\"retry_base\\\") -> \\\"retry_all\\\":\\n return retry_all(other, self)\\n\\n def __or__(self, other: \\\"retry_base\\\") -> \\\"retry_any\\\":\\n return other.__ror__(self)\\n\\n def __ror__(self, other: \\\"retry_base\\\") -> \\\"retry_any\\\":\\n return retry_any(other, self)\\n\\n\\nRetryBaseT = typing.Union[retry_base, typing.Callable[[\\\"RetryCallState\\\"], bool]]\\n\\n\\nclass _retry_never(retry_base):\\n \\\"\\\"\\\"Retry strategy that never rejects any result.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return False\\n\\n\\nretry_never = _retry_never()\\n\\n\\nclass _retry_always(retry_base):\\n \\\"\\\"\\\"Retry strategy that always rejects any result.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return True\\n\\n\\nretry_always = _retry_always()\\n\\n\\nclass retry_if_exception(retry_base):\\n \\\"\\\"\\\"Retry strategy that retries if an exception verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[BaseException], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n else:\\n return False\\n\\n\\nclass retry_if_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries if an exception has been raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: isinstance(e, exception_types))\\n\\n\\nclass retry_if_not_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries except an exception has been raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: not isinstance(e, exception_types))\\n\\n\\nclass retry_unless_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries until an exception is raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: not isinstance(e, exception_types))\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n # always retry if no exception was raised\\n if not retry_state.outcome.failed:\\n return True\\n\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n\\n\\nclass retry_if_exception_cause_type(retry_base):\\n \\\"\\\"\\\"Retries if any of the causes of the raised exception is of one or more types.\\n\\n The check on the type of the cause of the exception is done recursively (until finding\\n an exception in the chain that has no `__cause__`)\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_cause_types = exception_types\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__ called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exc = retry_state.outcome.exception()\\n while exc is not None:\\n if isinstance(exc.__cause__, self.exception_cause_types):\\n return True\\n exc = exc.__cause__\\n\\n return False\\n\\n\\nclass retry_if_result(retry_base):\\n \\\"\\\"\\\"Retries if the result verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_if_not_result(retry_base):\\n \\\"\\\"\\\"Retries if the result refutes a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return not self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_if_exception_message(retry_if_exception):\\n \\\"\\\"\\\"Retries if an exception message equals or matches.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: typing.Optional[str] = None,\\n match: typing.Optional[str] = None,\\n ) -> None:\\n if message and match:\\n raise TypeError(\\n f\\\"{self.__class__.__name__}() takes either 'message' or 'match', not both\\\"\\n )\\n\\n # set predicate\\n if message:\\n\\n def message_fnc(exception: BaseException) -> bool:\\n return message == str(exception)\\n\\n predicate = message_fnc\\n elif match:\\n prog = re.compile(match)\\n\\n def match_fnc(exception: BaseException) -> bool:\\n return bool(prog.match(str(exception)))\\n\\n predicate = match_fnc\\n else:\\n raise TypeError(\\n f\\\"{self.__class__.__name__}() missing 1 required argument 'message' or 'match'\\\"\\n )\\n\\n super().__init__(predicate)\\n\\n\\nclass retry_if_not_exception_message(retry_if_exception_message):\\n \\\"\\\"\\\"Retries until an exception message equals or matches.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: typing.Optional[str] = None,\\n match: typing.Optional[str] = None,\\n ) -> None:\\n super().__init__(message, match)\\n # invert predicate\\n if_predicate = self.predicate\\n self.predicate = lambda *args_, **kwargs_: not if_predicate(*args_, **kwargs_)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return True\\n\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n\\n\\nclass retry_any(retry_base):\\n \\\"\\\"\\\"Retries if any of the retries condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: retry_base) -> None:\\n self.retries = retries\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return any(r(retry_state) for r in self.retries)\\n\\n\\nclass retry_all(retry_base):\\n \\\"\\\"\\\"Retries if all the retries condition are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: retry_base) -> None:\\n self.retries = retries\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return all(r(retry_state) for r in self.retries)\\n\\n[end of tenacity/retry.py]\",\n \"filename\": \"tenacity/retry.py\",\n \"id\": \"17\"\n },\n {\n \"content\": \"[end of tenacity/py.typed]\",\n \"filename\": \"tenacity/py.typed\",\n \"id\": \"18\"\n },\n {\n \"content\": \"# Copyright 2017 Elisey Zanko\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport sys\\nimport typing\\n\\nfrom tenacity import BaseRetrying\\nfrom tenacity import DoAttempt\\nfrom tenacity import DoSleep\\nfrom tenacity import RetryCallState\\n\\nfrom tornado import gen\\n\\nif typing.TYPE_CHECKING:\\n from tornado.concurrent import Future\\n\\n_RetValT = typing.TypeVar(\\\"_RetValT\\\")\\n\\n\\nclass TornadoRetrying(BaseRetrying):\\n def __init__(\\n self,\\n sleep: \\\"typing.Callable[[float], Future[None]]\\\" = gen.sleep,\\n **kwargs: typing.Any,\\n ) -> None:\\n super().__init__(**kwargs)\\n self.sleep = sleep\\n\\n @gen.coroutine # type: ignore[misc]\\n def __call__(\\n self,\\n fn: \\\"typing.Callable[..., typing.Union[typing.Generator[typing.Any, typing.Any, _RetValT], Future[_RetValT]]]\\\",\\n *args: typing.Any,\\n **kwargs: typing.Any,\\n ) -> \\\"typing.Generator[typing.Any, typing.Any, _RetValT]\\\":\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = yield fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n yield self.sleep(do)\\n else:\\n raise gen.Return(do)\\n\\n[end of tenacity/tornadoweb.py]\",\n \"filename\": \"tenacity/tornadoweb.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport functools\\nimport inspect\\nimport sys\\nimport typing\\nfrom datetime import timedelta\\n\\n\\n# sys.maxsize:\\n# An integer giving the maximum value a variable of type Py_ssize_t can take.\\nMAX_WAIT = sys.maxsize / 2\\n\\n\\ndef find_ordinal(pos_num: int) -> str:\\n # See: https://en.wikipedia.org/wiki/English_numerals#Ordinal_numbers\\n if pos_num == 0:\\n return \\\"th\\\"\\n elif pos_num == 1:\\n return \\\"st\\\"\\n elif pos_num == 2:\\n return \\\"nd\\\"\\n elif pos_num == 3:\\n return \\\"rd\\\"\\n elif 4 <= pos_num <= 20:\\n return \\\"th\\\"\\n else:\\n return find_ordinal(pos_num % 10)\\n\\n\\ndef to_ordinal(pos_num: int) -> str:\\n return f\\\"{pos_num}{find_ordinal(pos_num)}\\\"\\n\\n\\ndef get_callback_name(cb: typing.Callable[..., typing.Any]) -> str:\\n \\\"\\\"\\\"Get a callback fully-qualified name.\\n\\n If no name can be produced ``repr(cb)`` is called and returned.\\n \\\"\\\"\\\"\\n segments = []\\n try:\\n segments.append(cb.__qualname__)\\n except AttributeError:\\n try:\\n segments.append(cb.__name__)\\n except AttributeError:\\n pass\\n if not segments:\\n return repr(cb)\\n else:\\n try:\\n # When running under sphinx it appears this can be none?\\n if cb.__module__:\\n segments.insert(0, cb.__module__)\\n except AttributeError:\\n pass\\n return \\\".\\\".join(segments)\\n\\n\\ntime_unit_type = typing.Union[int, float, timedelta]\\n\\n\\ndef to_seconds(time_unit: time_unit_type) -> float:\\n return float(\\n time_unit.total_seconds() if isinstance(time_unit, timedelta) else time_unit\\n )\\n\\n\\ndef is_coroutine_callable(call: typing.Callable[..., typing.Any]) -> bool:\\n if inspect.isclass(call):\\n return False\\n if inspect.iscoroutinefunction(call):\\n return True\\n partial_call = isinstance(call, functools.partial) and call.func\\n dunder_call = partial_call or getattr(call, \\\"__call__\\\", None)\\n return inspect.iscoroutinefunction(dunder_call)\\n\\n\\ndef wrap_to_async_func(\\n call: typing.Callable[..., typing.Any],\\n) -> typing.Callable[..., typing.Awaitable[typing.Any]]:\\n if is_coroutine_callable(call):\\n return call\\n\\n async def inner(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:\\n return call(*args, **kwargs)\\n\\n return inner\\n\\n[end of tenacity/_utils.py]\",\n \"filename\": \"tenacity/_utils.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport functools\\nimport sys\\nimport typing as t\\n\\nimport tenacity\\nfrom tenacity import AttemptManager\\nfrom tenacity import BaseRetrying\\nfrom tenacity import DoAttempt\\nfrom tenacity import DoSleep\\nfrom tenacity import RetryCallState\\nfrom tenacity import RetryError\\nfrom tenacity import after_nothing\\nfrom tenacity import before_nothing\\nfrom tenacity import _utils\\n\\n# Import all built-in retry strategies for easier usage.\\nfrom .retry import RetryBaseT\\nfrom .retry import retry_all # noqa\\nfrom .retry import retry_any # noqa\\nfrom .retry import retry_if_exception # noqa\\nfrom .retry import retry_if_result # noqa\\nfrom ..retry import RetryBaseT as SyncRetryBaseT\\n\\nif t.TYPE_CHECKING:\\n from tenacity.stop import StopBaseT\\n from tenacity.wait import WaitBaseT\\n\\nWrappedFnReturnT = t.TypeVar(\\\"WrappedFnReturnT\\\")\\nWrappedFn = t.TypeVar(\\\"WrappedFn\\\", bound=t.Callable[..., t.Awaitable[t.Any]])\\n\\n\\ndef _portable_async_sleep(seconds: float) -> t.Awaitable[None]:\\n # If trio is already imported, then importing it is cheap.\\n # If trio isn't already imported, then it's definitely not running, so we\\n # can skip further checks.\\n if \\\"trio\\\" in sys.modules:\\n # If trio is available, then sniffio is too\\n import trio\\n import sniffio\\n\\n if sniffio.current_async_library() == \\\"trio\\\":\\n return trio.sleep(seconds)\\n # Otherwise, assume asyncio\\n # Lazy import asyncio as it's expensive (responsible for 25-50% of total import overhead).\\n import asyncio\\n\\n return asyncio.sleep(seconds)\\n\\n\\nclass AsyncRetrying(BaseRetrying):\\n def __init__(\\n self,\\n sleep: t.Callable[\\n [t.Union[int, float]], t.Union[None, t.Awaitable[None]]\\n ] = _portable_async_sleep,\\n stop: \\\"StopBaseT\\\" = tenacity.stop.stop_never,\\n wait: \\\"WaitBaseT\\\" = tenacity.wait.wait_none(),\\n retry: \\\"t.Union[SyncRetryBaseT, RetryBaseT]\\\" = tenacity.retry_if_exception_type(),\\n before: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = before_nothing,\\n after: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = after_nothing,\\n before_sleep: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]]\\n ] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[\\\"RetryError\\\"] = RetryError,\\n retry_error_callback: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[t.Any, t.Awaitable[t.Any]]]\\n ] = None,\\n ) -> None:\\n super().__init__(\\n sleep=sleep, # type: ignore[arg-type]\\n stop=stop,\\n wait=wait,\\n retry=retry, # type: ignore[arg-type]\\n before=before, # type: ignore[arg-type]\\n after=after, # type: ignore[arg-type]\\n before_sleep=before_sleep, # type: ignore[arg-type]\\n reraise=reraise,\\n retry_error_cls=retry_error_cls,\\n retry_error_callback=retry_error_callback,\\n )\\n\\n async def __call__( # type: ignore[override]\\n self, fn: WrappedFn, *args: t.Any, **kwargs: t.Any\\n ) -> WrappedFnReturnT:\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = await self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = await fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n await self.sleep(do) # type: ignore[misc]\\n else:\\n return do # type: ignore[no-any-return]\\n\\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\\n self.iter_state.actions.append(_utils.wrap_to_async_func(fn))\\n\\n async def _run_retry(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n self.iter_state.retry_run_result = await _utils.wrap_to_async_func(self.retry)(\\n retry_state\\n )\\n\\n async def _run_wait(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n if self.wait:\\n sleep = await _utils.wrap_to_async_func(self.wait)(retry_state)\\n else:\\n sleep = 0.0\\n\\n retry_state.upcoming_sleep = sleep\\n\\n async def _run_stop(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n self.statistics[\\\"delay_since_first_attempt\\\"] = retry_state.seconds_since_start\\n self.iter_state.stop_run_result = await _utils.wrap_to_async_func(self.stop)(\\n retry_state\\n )\\n\\n async def iter(\\n self, retry_state: \\\"RetryCallState\\\"\\n ) -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa: A003\\n self._begin_iter(retry_state)\\n result = None\\n for action in self.iter_state.actions:\\n result = await action(retry_state)\\n return result\\n\\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\\n raise TypeError(\\\"AsyncRetrying object is not iterable\\\")\\n\\n def __aiter__(self) -> \\\"AsyncRetrying\\\":\\n self.begin()\\n self._retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\\n return self\\n\\n async def __anext__(self) -> AttemptManager:\\n while True:\\n do = await self.iter(retry_state=self._retry_state)\\n if do is None:\\n raise StopAsyncIteration\\n elif isinstance(do, DoAttempt):\\n return AttemptManager(retry_state=self._retry_state)\\n elif isinstance(do, DoSleep):\\n self._retry_state.prepare_for_next_attempt()\\n await self.sleep(do) # type: ignore[misc]\\n else:\\n raise StopAsyncIteration\\n\\n def wraps(self, fn: WrappedFn) -> WrappedFn:\\n wrapped = super().wraps(fn)\\n # Ensure wrapper is recognized as a coroutine function.\\n\\n @functools.wraps(\\n fn, functools.WRAPPER_ASSIGNMENTS + (\\\"__defaults__\\\", \\\"__kwdefaults__\\\")\\n )\\n async def async_wrapped(*args: t.Any, **kwargs: t.Any) -> t.Any:\\n # Always create a copy to prevent overwriting the local contexts when\\n # calling the same wrapped functions multiple times in the same stack\\n copy = self.copy()\\n async_wrapped.statistics = copy.statistics # type: ignore[attr-defined]\\n return await copy(fn, *args, **kwargs)\\n\\n # Preserve attributes\\n async_wrapped.retry = self # type: ignore[attr-defined]\\n async_wrapped.retry_with = wrapped.retry_with # type: ignore[attr-defined]\\n async_wrapped.statistics = {} # type: ignore[attr-defined]\\n\\n return async_wrapped # type: ignore[return-value]\\n\\n\\n__all__ = [\\n \\\"retry_all\\\",\\n \\\"retry_any\\\",\\n \\\"retry_if_exception\\\",\\n \\\"retry_if_result\\\",\\n \\\"WrappedFn\\\",\\n \\\"AsyncRetrying\\\",\\n]\\n\\n[end of tenacity/asyncio/__init__.py]\",\n \"filename\": \"tenacity/asyncio/__init__.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport abc\\nimport typing\\n\\nfrom tenacity import _utils\\nfrom tenacity import retry_base\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass async_retry_base(retry_base):\\n \\\"\\\"\\\"Abstract base class for async retry strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n pass\\n\\n def __and__( # type: ignore[override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_all\\\":\\n return retry_all(self, other)\\n\\n def __rand__( # type: ignore[misc,override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_all\\\":\\n return retry_all(other, self)\\n\\n def __or__( # type: ignore[override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_any\\\":\\n return retry_any(self, other)\\n\\n def __ror__( # type: ignore[misc,override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_any\\\":\\n return retry_any(other, self)\\n\\n\\nRetryBaseT = typing.Union[\\n async_retry_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Awaitable[bool]]\\n]\\n\\n\\nclass retry_if_exception(async_retry_base):\\n \\\"\\\"\\\"Retry strategy that retries if an exception verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(\\n self, predicate: typing.Callable[[BaseException], typing.Awaitable[bool]]\\n ) -> None:\\n self.predicate = predicate\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return await self.predicate(exception)\\n else:\\n return False\\n\\n\\nclass retry_if_result(async_retry_base):\\n \\\"\\\"\\\"Retries if the result verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(\\n self, predicate: typing.Callable[[typing.Any], typing.Awaitable[bool]]\\n ) -> None:\\n self.predicate = predicate\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return await self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_any(async_retry_base):\\n \\\"\\\"\\\"Retries if any of the retries condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\\n self.retries = retries\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n result = False\\n for r in self.retries:\\n result = result or await _utils.wrap_to_async_func(r)(retry_state)\\n if result:\\n break\\n return result\\n\\n\\nclass retry_all(async_retry_base):\\n \\\"\\\"\\\"Retries if all the retries condition are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\\n self.retries = retries\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n result = True\\n for r in self.retries:\\n result = result and await _utils.wrap_to_async_func(r)(retry_state)\\n if not result:\\n break\\n return result\\n\\n[end of tenacity/asyncio/retry.py]\",\n \"filename\": \"tenacity/asyncio/retry.py\",\n \"id\": \"22\"\n },\n {\n \"content\": \"Tenacity\\n========\\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\\n :target: https://pypi.python.org/pypi/tenacity\\n\\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\\n :target: https://circleci.com/gh/jd/tenacity\\n\\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\\n :target: https://mergify.io\\n :alt: Mergify Status\\n\\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\\n\\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\\nPython, to simplify the task of adding retry behavior to just about anything.\\nIt originates from `a fork of retrying\\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\\napi compatible with retrying but adds significant new functionality and\\nfixes a number of longstanding bugs.\\n\\nThe simplest use case is retrying a flaky function whenever an `Exception`\\noccurs until a value is returned.\\n\\n.. testcode::\\n\\n import random\\n from tenacity import retry\\n\\n @retry\\n def do_something_unreliable():\\n if random.randint(0, 10) > 1:\\n raise IOError(\\\"Broken sauce, everything is hosed!!!111one\\\")\\n else:\\n return \\\"Awesome sauce!\\\"\\n\\n print(do_something_unreliable())\\n\\n.. testoutput::\\n :hide:\\n\\n Awesome sauce!\\n\\n\\n.. toctree::\\n :hidden:\\n :maxdepth: 2\\n\\n changelog\\n api\\n\\n\\nFeatures\\n--------\\n\\n- Generic Decorator API\\n- Specify stop condition (i.e. limit by number of attempts)\\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\\n- Customize retrying on Exceptions\\n- Customize retrying on expected returned result\\n- Retry on coroutines\\n- Retry code block with context manager\\n\\n\\nInstallation\\n------------\\n\\nTo install *tenacity*, simply:\\n\\n.. code-block:: bash\\n\\n $ pip install tenacity\\n\\n\\nExamples\\n----------\\n\\nBasic Retry\\n~~~~~~~~~~~\\n\\n.. testsetup::\\n\\n import logging\\n #\\n # Note the following import is used for demonstration convenience only.\\n # Production code should always explicitly import the names it needs.\\n #\\n from tenacity import *\\n\\n class MyException(Exception):\\n pass\\n\\nAs you saw above, the default behavior is to retry forever without waiting when\\nan exception is raised.\\n\\n.. testcode::\\n\\n @retry\\n def never_gonna_give_you_up():\\n print(\\\"Retry forever ignoring Exceptions, don't wait between retries\\\")\\n raise Exception\\n\\nStopping\\n~~~~~~~~\\n\\nLet's be a little less persistent and set some boundaries, such as the number\\nof attempts before giving up.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(7))\\n def stop_after_7_attempts():\\n print(\\\"Stopping after 7 attempts\\\")\\n raise Exception\\n\\nWe don't have all day, so let's set a boundary for how long we should be\\nretrying stuff.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_delay(10))\\n def stop_after_10_s():\\n print(\\\"Stopping after 10 seconds\\\")\\n raise Exception\\n\\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\\nthen you can give up on retries one attempt before you would exceed the delay.\\n\\n.. testcode::\\n\\n @retry(stop=stop_before_delay(10))\\n def stop_before_10_s():\\n print(\\\"Stopping 1 attempt before 10 seconds\\\")\\n raise Exception\\n\\nYou can combine several stop conditions by using the `|` operator:\\n\\n.. testcode::\\n\\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\\n def stop_after_10_s_or_5_retries():\\n print(\\\"Stopping after 10 seconds or 5 retries\\\")\\n raise Exception\\n\\nWaiting before retrying\\n~~~~~~~~~~~~~~~~~~~~~~~\\n\\nMost things don't like to be polled as fast as possible, so let's just wait 2\\nseconds between retries.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(2))\\n def wait_2_s():\\n print(\\\"Wait 2 second between retries\\\")\\n raise Exception\\n\\nSome things perform best with a bit of randomness injected.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random(min=1, max=2))\\n def wait_random_1_to_2_s():\\n print(\\\"Randomly wait 1 to 2 seconds between retries\\\")\\n raise Exception\\n\\nThen again, it's hard to beat exponential backoff when retrying distributed\\nservices and other remote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\\n def wait_exponential_1():\\n print(\\\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\\\")\\n raise Exception\\n\\n\\nThen again, it's also hard to beat combining fixed waits and jitter (to\\nhelp avoid thundering herds) when retrying distributed services and other\\nremote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\\n def wait_fixed_jitter():\\n print(\\\"Wait at least 3 seconds, and add up to 2 seconds of random delay\\\")\\n raise Exception\\n\\nWhen multiple processes are in contention for a shared resource, exponentially\\nincreasing jitter helps minimise collisions.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\\n def wait_exponential_jitter():\\n print(\\\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\\\")\\n raise Exception\\n\\n\\nSometimes it's necessary to build a chain of backoffs.\\n\\n.. testcode::\\n\\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\\n [wait_fixed(7) for i in range(2)] +\\n [wait_fixed(9)]))\\n def wait_fixed_chained():\\n print(\\\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\\\")\\n raise Exception\\n\\nWhether to retry\\n~~~~~~~~~~~~~~~~\\n\\nWe have a few options for dealing with retries that raise specific or general\\nexceptions, as in the cases here.\\n\\n.. testcode::\\n\\n class ClientError(Exception):\\n \\\"\\\"\\\"Some type of client error.\\\"\\\"\\\"\\n\\n @retry(retry=retry_if_exception_type(IOError))\\n def might_io_error():\\n print(\\\"Retry forever with no wait if an IOError occurs, raise any other errors\\\")\\n raise Exception\\n\\n @retry(retry=retry_if_not_exception_type(ClientError))\\n def might_client_error():\\n print(\\\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\\\")\\n raise Exception\\n\\nWe can also use the result of the function to alter the behavior of retrying.\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=retry_if_result(is_none_p))\\n def might_return_none():\\n print(\\\"Retry with no wait if return value is None\\\")\\n\\nSee also these methods:\\n\\n.. testcode::\\n\\n retry_if_exception\\n retry_if_exception_type\\n retry_if_not_exception_type\\n retry_unless_exception_type\\n retry_if_result\\n retry_if_not_result\\n retry_if_exception_message\\n retry_if_not_exception_message\\n retry_any\\n retry_all\\n\\nWe can also combine several conditions:\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\\n def might_return_none():\\n print(\\\"Retry forever ignoring Exceptions with no wait if return value is None\\\")\\n\\nAny combination of stop, wait, etc. is also supported to give you the freedom\\nto mix and match.\\n\\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\\nexception:\\n\\n.. testcode::\\n\\n @retry\\n def do_something():\\n result = something_else()\\n if result == 23:\\n raise TryAgain\\n\\nError Handling\\n~~~~~~~~~~~~~~\\n\\nNormally when your function fails its final time (and will not be retried again based on your settings),\\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\\nof the stack trace.\\n\\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\\nis most visible), you can set `reraise=True`.\\n\\n.. testcode::\\n\\n @retry(reraise=True, stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except MyException:\\n # timed out retrying\\n pass\\n\\nBefore and After Retry, and Logging\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's possible to execute an action before any attempt of calling the function\\nby using the before callback function:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIn the same spirit, It's possible to execute after a call that failed:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIt's also possible to only log failures that are going to be retried. Normally\\nretries happen after a wait interval, so the keyword argument is called\\n``before_sleep``:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3),\\n before_sleep=before_sleep_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n\\nStatistics\\n~~~~~~~~~~\\n\\nYou can access the statistics about the retry made over a function by using the\\n`statistics` attribute attached to the function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nCustom Callbacks\\n~~~~~~~~~~~~~~~~\\n\\nYou can also define your own callbacks. The callback should accept one\\nparameter called ``retry_state`` that contains all information about current\\nretry invocation.\\n\\nFor example, you can call a custom callback function after all retries failed,\\nwithout raising an exception (or you can re-raise or do anything really)\\n\\n.. testcode::\\n\\n def return_last_value(retry_state):\\n \\\"\\\"\\\"return the result of the last call attempt\\\"\\\"\\\"\\n return retry_state.outcome.result()\\n\\n def is_false(value):\\n \\\"\\\"\\\"Return True if value is False\\\"\\\"\\\"\\n return value is False\\n\\n # will return False after trying 3 times to get a different result\\n @retry(stop=stop_after_attempt(3),\\n retry_error_callback=return_last_value,\\n retry=retry_if_result(is_false))\\n def eventually_return_false():\\n return False\\n\\nRetryCallState\\n~~~~~~~~~~~~~~\\n\\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\\n\\nOther Custom Callbacks\\n~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's also possible to define custom callbacks for other keyword arguments.\\n\\n.. function:: my_stop(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should stop\\n :rtype: bool\\n\\n.. function:: my_wait(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: number of seconds to wait before next retry\\n :rtype: float\\n\\n.. function:: my_retry(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should continue\\n :rtype: bool\\n\\n.. function:: my_before(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_after(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_before_sleep(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\nHere's an example with a custom ``before_sleep`` function:\\n\\n.. testcode::\\n\\n import logging\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n def my_before_sleep(retry_state):\\n if retry_state.attempt_number < 1:\\n loglevel = logging.INFO\\n else:\\n loglevel = logging.WARNING\\n logger.log(\\n loglevel, 'Retrying %s: attempt %s ended with: %s',\\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\\n\\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except RetryError:\\n pass\\n\\n\\nChanging Arguments at Run Time\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nYou can change the arguments of a retry decorator as needed when calling it by\\nusing the `retry_with` function attached to the wrapped function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nIf you want to use variables to set up the retry parameters, you don't have\\nto use the `retry` decorator - you can instead use `Retrying` directly:\\n\\n.. testcode::\\n\\n def never_good_enough(arg1):\\n raise Exception('Invalid argument: {}'.format(arg1))\\n\\n def try_never_good_enough(max_attempts=3):\\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\\n retryer(never_good_enough, 'I really do try')\\n\\nYou may also want to change the behaviour of a decorated function temporarily,\\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\\nattribute attached to the function. Bear in mind this is a write-only attribute,\\nstatistics should be read from the function `statistics` attribute.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n from unittest import mock\\n\\n with mock.patch.object(raise_my_exception.retry, \\\"wait\\\", wait_fixed(0)):\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nRetrying code block\\n~~~~~~~~~~~~~~~~~~~\\n\\nTenacity allows you to retry a code block without the need to wraps it in an\\nisolated function. This makes it easy to isolate failing block while sharing\\ncontext. The trick is to combine a for loop and a context manager.\\n\\n.. testcode::\\n\\n from tenacity import Retrying, RetryError, stop_after_attempt\\n\\n try:\\n for attempt in Retrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nYou can configure every details of retry policy by configuring the Retrying\\nobject.\\n\\nWith async code you can use AsyncRetrying.\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\\n\\n async def function():\\n try:\\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nIn both cases, you may want to set the result to the attempt so it's available\\nin retry strategies like ``retry_if_result``. This can be done accessing the\\n``retry_state`` property:\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, retry_if_result\\n\\n async def function():\\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\\n with attempt:\\n result = 1 # Some complex calculation, function call, etc.\\n if not attempt.retry_state.outcome.failed:\\n attempt.retry_state.set_result(result)\\n return result\\n\\nAsync and retry\\n~~~~~~~~~~~~~~~\\n\\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\\nSleeps are done asynchronously too.\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_asyncio_function(loop):\\n await loop.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_async_trio_function():\\n await trio.socket.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n @tornado.gen.coroutine\\n def my_async_tornado_function(http_client, url):\\n yield http_client.fetch(url)\\n\\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\\n\\n.. code-block:: python\\n\\n @retry(sleep=curio.sleep)\\n async def my_async_curio_function():\\n await asks.get('https://example.org')\\n\\nContribute\\n----------\\n\\n#. Check for open issues or open a fresh issue to start a discussion around a\\n feature idea or a bug.\\n#. Fork `the repository`_ on GitHub to start making your changes to the\\n **main** branch (or branch off of it).\\n#. Write a test which shows that the bug was fixed or that the feature works as\\n expected.\\n#. Add a `changelog <#Changelogs>`_\\n#. Make the docs better (or more detailed, or more easier to read, or ...)\\n\\n.. _`the repository`: https://github.com/jd/tenacity\\n\\nChangelogs\\n~~~~~~~~~~\\n\\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\\n\\nThe doc generation will automatically compile the changelogs. You just need to add them.\\n\\n.. code-block:: sh\\n\\n # Opens a template file in an editor\\n tox -e reno -- new some-slug-for-my-change --edit\\n\\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\\n\\n[end of doc/source/index.rst]\",\n \"filename\": \"doc/source/index.rst\",\n \"id\": \"23\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport os\\nimport sys\\n\\nmaster_doc = \\\"index\\\"\\nproject = \\\"Tenacity\\\"\\n\\n# Add tenacity to the path, so sphinx can find the functions for autodoc.\\nsys.path.insert(0, os.path.abspath(\\\"../..\\\"))\\n\\nextensions = [\\n \\\"sphinx.ext.doctest\\\",\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"reno.sphinxext\\\",\\n]\\n\\n# -- Options for sphinx.ext.doctest -----------------------------------------\\n\\n# doctest_default_flags =\\ncwd = os.path.abspath(os.path.dirname(__file__))\\ntenacity_path = os.path.join(cwd, os.pardir, os.pardir)\\ndoctest_path = [tenacity_path]\\n# doctest_global_setup =\\n# doctest_global_cleanup =\\n# doctest_test_doctest_blocks =\\n\\n[end of doc/source/conf.py]\",\n \"filename\": \"doc/source/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"Changelog\\n=========\\n\\n.. release-notes::\\n\\n[end of doc/source/changelog.rst]\",\n \"filename\": \"doc/source/changelog.rst\",\n \"id\": \"25\"\n },\n {\n \"content\": \"===============\\n API Reference\\n===============\\n\\nRetry Main API\\n--------------\\n\\n.. autofunction:: tenacity.retry\\n :noindex:\\n\\n.. autoclass:: tenacity.Retrying\\n :members:\\n\\n.. autoclass:: tenacity.AsyncRetrying\\n :members:\\n\\n.. autoclass:: tenacity.tornadoweb.TornadoRetrying\\n :members:\\n\\n.. autoclass:: tenacity.RetryCallState\\n :members:\\n\\nAfter Functions\\n---------------\\n\\nThose functions can be used as the `after` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.after\\n :members:\\n\\nBefore Functions\\n----------------\\n\\nThose functions can be used as the `before` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.before\\n :members:\\n\\nBefore Sleep Functions\\n----------------------\\n\\nThose functions can be used as the `before_sleep` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.before_sleep\\n :members:\\n\\nNap Functions\\n-------------\\n\\nThose functions can be used as the `sleep` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.nap\\n :members:\\n\\nRetry Functions\\n---------------\\n\\nThose functions can be used as the `retry` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.retry\\n :members:\\n\\nStop Functions\\n--------------\\n\\nThose functions can be used as the `stop` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.stop\\n :members:\\n\\nWait Functions\\n--------------\\n\\nThose functions can be used as the `wait` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.wait\\n :members:\\n\\n[end of doc/source/api.rst]\",\n \"filename\": \"doc/source/api.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"---\\nupgrade:\\n - |\\n Support for Python 3.6 has been removed.\\n\\n[end of releasenotes/notes/remove-py36-876c0416cf279d15.yaml]\",\n \"filename\": \"releasenotes/notes/remove-py36-876c0416cf279d15.yaml\",\n \"id\": \"27\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Fix async loop with retrying code block when result is available.\\n\\n[end of releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml]\",\n \"filename\": \"releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml\",\n \"id\": \"28\"\n },\n {\n \"content\": \"---\\nupgrade:\\n - \\\"Removed `BaseRetrying.call`: was long time deprecated and produced `DeprecationWarning`\\\"\\n - \\\"Removed `BaseRetrying.fn`: was noted as deprecated\\\"\\n - \\\"API change: `BaseRetrying.begin()` do not require arguments anymore as it not setting `BaseRetrying.fn`\\\"\\n\\n[end of releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml]\",\n \"filename\": \"releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml\",\n \"id\": \"29\"\n },\n {\n \"content\": \"---\\nfixes:\\n - Fix setuptools config to include tenacity.asyncio package in release distributions.\\n\\n[end of releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml]\",\n \"filename\": \"releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml\",\n \"id\": \"30\"\n },\n {\n \"content\": \"---\\nother:\\n - Add a \\\\\\\"test\\\\\\\" extra\\n\\n[end of releasenotes/notes/add-test-extra-55e869261b03e56d.yaml]\",\n \"filename\": \"releasenotes/notes/add-test-extra-55e869261b03e56d.yaml\",\n \"id\": \"31\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Use str.format to format the logs internally to make logging compatible with other logger such as loguru.\\n\\n[end of releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml]\",\n \"filename\": \"releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml\",\n \"id\": \"32\"\n },\n {\n \"content\": \"---\\nother:\\n - Unit tests can now mock ``nap.sleep()`` for testing in all tenacity usage styles\\n[end of releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml]\",\n \"filename\": \"releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml\",\n \"id\": \"33\"\n },\n {\n \"content\": \"---\\nfixes:\\n - \\\"Fix after_log logger format: function name was used with delay formatting.\\\"\\n\\n[end of releasenotes/notes/after_log-50f4d73b24ce9203.yaml]\",\n \"filename\": \"releasenotes/notes/after_log-50f4d73b24ce9203.yaml\",\n \"id\": \"34\"\n },\n {\n \"content\": \"---\\nother:\\n - \\\"Use `black` for code formatting and validate using `black --check`. Code compatibility: py26-py39.\\\"\\n - \\\"Enforce maximal line length to 120 symbols\\\"\\n\\n[end of releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml]\",\n \"filename\": \"releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml\",\n \"id\": \"35\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Preserve __defaults__ and __kwdefaults__ through retry decorator\\n\\n[end of releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml]\",\n \"filename\": \"releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml\",\n \"id\": \"36\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add ``retry_if_not_exception_type()`` that allows to retry if a raised exception doesn't match given exceptions.\\n\\n[end of releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml]\",\n \"filename\": \"releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml\",\n \"id\": \"37\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Argument `wait` was improperly annotated, making mypy checks fail.\\n Now it's annotated as `typing.Union[wait_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Union[float, int]]]`\\n\\n[end of releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml]\",\n \"filename\": \"releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml\",\n \"id\": \"38\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Explicitly export convenience symbols from tenacity root module\\n\\n[end of releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml]\",\n \"filename\": \"releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml\",\n \"id\": \"39\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add ``datetime.timedelta`` as accepted wait unit type.\\n\\n[end of releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml]\",\n \"filename\": \"releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml\",\n \"id\": \"40\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Add a Dependabot configuration submit PRs monthly (as needed)\\n to keep GitHub action versions updated.\\n\\n[end of releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml]\",\n \"filename\": \"releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml\",\n \"id\": \"41\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Add a new `retry_base` class called `retry_if_exception_cause_type` that\\n checks, recursively, if any of the causes of the raised exception is of a certain type.\\n\\n[end of releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml]\",\n \"filename\": \"releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml\",\n \"id\": \"42\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Added the ability to use async functions for retries. This way, you can now use\\n asyncio coroutines for retry strategy predicates.\\n\\n[end of releasenotes/notes/add-async-actions-b249c527d99723bb.yaml]\",\n \"filename\": \"releasenotes/notes/add-async-actions-b249c527d99723bb.yaml\",\n \"id\": \"43\"\n },\n {\n \"content\": \"---\\nprelude: >\\n Clarify usage of `reraise` keyword argument\\n\\n[end of releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml]\",\n \"filename\": \"releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml\",\n \"id\": \"44\"\n },\n {\n \"content\": \"---\\nfixes: Sphinx build error where Sphinx complains about an undefined class.\\n\\n[end of releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml]\",\n \"filename\": \"releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml\",\n \"id\": \"45\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add reno (changelog system)\\n\\n[end of releasenotes/notes/add-reno-d1ab5710f272650a.yaml]\",\n \"filename\": \"releasenotes/notes/add-reno-d1ab5710f272650a.yaml\",\n \"id\": \"46\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Avoid overwriting local contexts when applying the retry decorator.\\n\\n[end of releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml]\",\n \"filename\": \"releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml\",\n \"id\": \"47\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Most part of the code is type annotated.\\n - Python 3.10 support has been added.\\n\\n[end of releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml]\",\n \"filename\": \"releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml\",\n \"id\": \"48\"\n },\n {\n \"content\": \"---\\nother:\\n - Add type annotations to cover all public API.\\n\\n[end of releasenotes/notes/annotate_code-197b93130df14042.yaml]\",\n \"filename\": \"releasenotes/notes/annotate_code-197b93130df14042.yaml\",\n \"id\": \"49\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n `AsyncRetrying` was erroneously implementing `__iter__()`, making tenacity\\n retrying mechanism working but in a synchronous fashion and not waiting as\\n expected. This interface has been removed, `__aiter__()` should be used\\n instead.\\n\\n[end of releasenotes/notes/no-async-iter-6132a42e52348a75.yaml]\",\n \"filename\": \"releasenotes/notes/no-async-iter-6132a42e52348a75.yaml\",\n \"id\": \"50\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Added a new stop function: stop_before_delay, which will stop execution\\n if the next sleep time would cause overall delay to exceed the specified delay. \\n Useful for use cases where you have some upper bound on retry times that you must\\n not exceed, so returning before that timeout is preferable than returning after that timeout.\\n[end of releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml]\",\n \"filename\": \"releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml\",\n \"id\": \"51\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n If you're using `Trio <https://trio.readthedocs.io>`__, then\\n ``@retry`` now works automatically. It's no longer necessary to\\n pass ``sleep=trio.sleep``.\\n\\n[end of releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml]\",\n \"filename\": \"releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml\",\n \"id\": \"52\"\n },\n {\n \"content\": \"---\\nother: >-\\n Corrected the PyPI-published wheel tag to match the\\n metadata saying that the release is Python 3 only.\\n...\\n\\n[end of releasenotes/notes/pr320-py3-only-wheel-tag.yaml]\",\n \"filename\": \"releasenotes/notes/pr320-py3-only-wheel-tag.yaml\",\n \"id\": \"53\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n - accept ``datetime.timedelta`` instances as argument to ``tenacity.stop.stop_after_delay``\\n\\n[end of releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml]\",\n \"filename\": \"releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml\",\n \"id\": \"54\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Restore the value of the `retry` attribute for wrapped functions. Also,\\n clarify that those attributes are write-only and statistics should be\\n read from the function attribute directly.\\n\\n[end of releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml]\",\n \"filename\": \"releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml\",\n \"id\": \"55\"\n },\n {\n \"content\": \"---\\nfixes:\\n - \\\"Fix issue #288 : __name__ and other attributes for async functions\\\"\\n\\n[end of releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml]\",\n \"filename\": \"releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml\",\n \"id\": \"56\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Added a link to the documentation, as code snippets are not being rendered properly\\n Changed branch name to main in index.rst\\n\\n[end of releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml]\",\n \"filename\": \"releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml\",\n \"id\": \"57\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Respects `min` arg for `wait_random_exponential`\\n\\n[end of releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml]\",\n \"filename\": \"releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml\",\n \"id\": \"58\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add a ``__repr__`` method to ``RetryCallState`` objects for easier debugging.\\n\\n[end of releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml]\",\n \"filename\": \"releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml\",\n \"id\": \"59\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Drop support for deprecated Python versions (2.7 and 3.5)\\n\\n[end of releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml]\",\n \"filename\": \"releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml\",\n \"id\": \"60\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add an ``exc_info`` option to the ``before_sleep_log()`` strategy.\\n[end of releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml]\",\n \"filename\": \"releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml\",\n \"id\": \"61\"\n },\n {\n \"content\": \"---\\nother:\\n - Add `retry_if_exception_cause_type`and `wait_exponential_jitter` to __all__ of init.py\\n[end of releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml]\",\n \"filename\": \"releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml\",\n \"id\": \"62\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Implement a wait.wait_exponential_jitter per Google's storage retry guide.\\n See https://cloud.google.com/storage/docs/retry-strategy\\n\\n[end of releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml]\",\n \"filename\": \"releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml\",\n \"id\": \"63\"\n }\n]","isConversational":false}}},{"rowIdx":67,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 67,\n \"num_files\": 64,\n \"repo_id\": \"repo_0067\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"queue_rules:\n - name: default\n merge_method: squash\n queue_conditions:\n - or:\n - author = jd\n - \"#approved-reviews-by >= 1\"\n - author = dependabot[bot]\n - or:\n - files ~= ^releasenotes/notes/\n - label = no-changelog\n - author = dependabot[bot]\n - \"check-success=test (3.9, py39)\"\n - \"check-success=test (3.10, py310)\"\n - \"check-success=test (3.11, py311)\"\n - \"check-success=test (3.12, py312)\"\n - \"check-success=test (3.13, py313,py313-trio)\"\n - \"check-success=test (3.12, pep8)\"\n\npull_request_rules:\n - name: warn on no changelog\n conditions:\n - -files~=^releasenotes/notes/\n - label!=no-changelog\n - -closed\n actions:\n comment:\n message: >\n ⚠️ No release notes detected. Please make sure to use\n [reno](https://docs.openstack.org/reno/latest/user/usage.html) to add\n a changelog entry.\n\n - name: automatic queue\n conditions: []\n actions:\n queue:\n\n - name: dismiss reviews\n conditions: []\n actions:\n dismiss_reviews: {}\n\n[end of .mergify.yml]","filename":".mergify.yml","id":"0"},{"content":"---\nunreleased_version_title: Unreleased\n\n[end of reno.yaml]","filename":"reno.yaml","id":"1"},{"content":"Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\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[end of LICENSE]","filename":"LICENSE","id":"2"},{"content":"[build-system]\n# Minimum requirements for the build system to execute.\n# PEP 508 specifications for PEP 518.\n# Banned setuptools versions have well-known issues\nrequires = [\n \"setuptools >= 21.0.0,!=24.0.0,!=34.0.0,!=34.0.1,!=34.0.2,!=34.0.3,!=34.1.0,!=34.1.1,!=34.2.0,!=34.3.0,!=34.3.1,!=34.3.2,!=36.2.0\", # PSF/ZPL\n \"setuptools_scm[toml]>=3.4\",\n]\nbuild-backend=\"setuptools.build_meta\"\n\n[tool.ruff]\nline-length = 88\nindent-width = 4\ntarget-version = \"py39\"\n\n[tool.mypy]\nstrict = true\nfiles = [\"tenacity\", \"tests\"]\nshow_error_codes = true\n\n[[tool.mypy.overrides]]\nmodule = \"tornado.*\"\nignore_missing_imports = true\n\n[tool.setuptools_scm]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"version: 2\npython:\n install:\n - method: pip\n path: .\n extra_requirements:\n - doc\n\n[end of .readthedocs.yml]","filename":".readthedocs.yml","id":"4"},{"content":"root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\nindent_size = 2\nindent_style = space\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.{py,pyx,pxd,pyi}]\nindent_size = 4\nmax_line_length = 120\n\n[*.ini]\nindent_size = 4\n\n[*.rst]\nmax_line_length = 150\n\n[Makefile]\nindent_style = tab\n\n[end of .editorconfig]","filename":".editorconfig","id":"5"},{"content":"#!/usr/bin/env python\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\n# implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport setuptools\n\nsetuptools.setup(\n setup_requires=[\"setuptools_scm\"],\n use_scm_version=True,\n)\n\n[end of setup.py]","filename":"setup.py","id":"6"},{"content":"[tox]\n# we only test trio on latest python version\nenvlist = py3{9,10,11,12,13,13-trio}, pep8, pypy3\nskip_missing_interpreters = True\n\n[testenv]\nusedevelop = True\nsitepackages = False\ndeps =\n .[test]\n .[doc]\n trio: trio\ncommands =\n py3{8,9,10,11,12,13},pypy3: pytest {posargs}\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b doctest doc/source doc/build\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b html doc/source doc/build\n\n[testenv:pep8]\nbasepython = python3\ndeps = ruff\ncommands =\n ruff check . {posargs}\n ruff format --check . {posargs}\n\n[testenv:mypy]\ndeps =\n mypy>=1.0.0\n pytest # for stubs\n trio\ncommands =\n mypy {posargs}\n\n[testenv:reno]\nbasepython = python3\ndeps = reno\ncommands = reno {posargs}\n\n[end of tox.ini]","filename":"tox.ini","id":"7"},{"content":"[metadata]\nname = tenacity\nlicense = Apache 2.0\nurl = https://github.com/jd/tenacity\nsummary = Retry code until it succeeds\nlong_description = Tenacity is a general-purpose retrying library to simplify the task of adding retry behavior to just about anything.\nauthor = Julien Danjou\nauthor_email = julien@danjou.info\nhome_page = https://github.com/jd/tenacity\nclassifier =\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 :: Only\n Programming Language :: Python :: 3.9\n Programming Language :: Python :: 3.10\n Programming Language :: Python :: 3.11\n Programming Language :: Python :: 3.12\n Programming Language :: Python :: 3.13\n Topic :: Utilities\n\n[options]\ninstall_requires =\npython_requires = >=3.9\npackages = find:\n\n[options.packages.find]\ninclude = tenacity*\nexclude = tests\n\n[options.package_data]\ntenacity = py.typed\n\n[options.extras_require]\ndoc =\n reno\n sphinx\ntest =\n pytest\n tornado>=4.5\n typeguard\n\n[tool:pytest]\nfilterwarnings =\n # Show any DeprecationWarnings once\n once::DeprecationWarning\n\n[end of setup.cfg]","filename":"setup.cfg","id":"8"},{"content":"Tenacity\n========\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\n :target: https://pypi.python.org/pypi/tenacity\n\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\n :target: https://circleci.com/gh/jd/tenacity\n\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\n :target: https://mergify.io\n :alt: Mergify Status\n\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\n\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\nPython, to simplify the task of adding retry behavior to just about anything.\nIt originates from `a fork of retrying\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\napi compatible with retrying but adds significant new functionality and\nfixes a number of longstanding bugs.\n\nThe simplest use case is retrying a flaky function whenever an `Exception`\noccurs until a value is returned.\n\n.. testcode::\n\n import random\n from tenacity import retry\n\n @retry\n def do_something_unreliable():\n if random.randint(0, 10) > 1:\n raise IOError(\"Broken sauce, everything is hosed!!!111one\")\n else:\n return \"Awesome sauce!\"\n\n print(do_something_unreliable())\n\n.. testoutput::\n :hide:\n\n Awesome sauce!\n\n\n.. toctree::\n :hidden:\n :maxdepth: 2\n\n changelog\n api\n\n\nFeatures\n--------\n\n- Generic Decorator API\n- Specify stop condition (i.e. limit by number of attempts)\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\n- Customize retrying on Exceptions\n- Customize retrying on expected returned result\n- Retry on coroutines\n- Retry code block with context manager\n\n\nInstallation\n------------\n\nTo install *tenacity*, simply:\n\n.. code-block:: bash\n\n $ pip install tenacity\n\n\nExamples\n----------\n\nBasic Retry\n~~~~~~~~~~~\n\n.. testsetup::\n\n import logging\n #\n # Note the following import is used for demonstration convenience only.\n # Production code should always explicitly import the names it needs.\n #\n from tenacity import *\n\n class MyException(Exception):\n pass\n\nAs you saw above, the default behavior is to retry forever without waiting when\nan exception is raised.\n\n.. testcode::\n\n @retry\n def never_gonna_give_you_up():\n print(\"Retry forever ignoring Exceptions, don't wait between retries\")\n raise Exception\n\nStopping\n~~~~~~~~\n\nLet's be a little less persistent and set some boundaries, such as the number\nof attempts before giving up.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(7))\n def stop_after_7_attempts():\n print(\"Stopping after 7 attempts\")\n raise Exception\n\nWe don't have all day, so let's set a boundary for how long we should be\nretrying stuff.\n\n.. testcode::\n\n @retry(stop=stop_after_delay(10))\n def stop_after_10_s():\n print(\"Stopping after 10 seconds\")\n raise Exception\n\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\nthen you can give up on retries one attempt before you would exceed the delay.\n\n.. testcode::\n\n @retry(stop=stop_before_delay(10))\n def stop_before_10_s():\n print(\"Stopping 1 attempt before 10 seconds\")\n raise Exception\n\nYou can combine several stop conditions by using the `|` operator:\n\n.. testcode::\n\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\n def stop_after_10_s_or_5_retries():\n print(\"Stopping after 10 seconds or 5 retries\")\n raise Exception\n\nWaiting before retrying\n~~~~~~~~~~~~~~~~~~~~~~~\n\nMost things don't like to be polled as fast as possible, so let's just wait 2\nseconds between retries.\n\n.. testcode::\n\n @retry(wait=wait_fixed(2))\n def wait_2_s():\n print(\"Wait 2 second between retries\")\n raise Exception\n\nSome things perform best with a bit of randomness injected.\n\n.. testcode::\n\n @retry(wait=wait_random(min=1, max=2))\n def wait_random_1_to_2_s():\n print(\"Randomly wait 1 to 2 seconds between retries\")\n raise Exception\n\nThen again, it's hard to beat exponential backoff when retrying distributed\nservices and other remote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\n def wait_exponential_1():\n print(\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\")\n raise Exception\n\n\nThen again, it's also hard to beat combining fixed waits and jitter (to\nhelp avoid thundering herds) when retrying distributed services and other\nremote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\n def wait_fixed_jitter():\n print(\"Wait at least 3 seconds, and add up to 2 seconds of random delay\")\n raise Exception\n\nWhen multiple processes are in contention for a shared resource, exponentially\nincreasing jitter helps minimise collisions.\n\n.. testcode::\n\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\n def wait_exponential_jitter():\n print(\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\")\n raise Exception\n\n\nSometimes it's necessary to build a chain of backoffs.\n\n.. testcode::\n\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\n [wait_fixed(7) for i in range(2)] +\n [wait_fixed(9)]))\n def wait_fixed_chained():\n print(\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\")\n raise Exception\n\nWhether to retry\n~~~~~~~~~~~~~~~~\n\nWe have a few options for dealing with retries that raise specific or general\nexceptions, as in the cases here.\n\n.. testcode::\n\n class ClientError(Exception):\n \"\"\"Some type of client error.\"\"\"\n\n @retry(retry=retry_if_exception_type(IOError))\n def might_io_error():\n print(\"Retry forever with no wait if an IOError occurs, raise any other errors\")\n raise Exception\n\n @retry(retry=retry_if_not_exception_type(ClientError))\n def might_client_error():\n print(\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\")\n raise Exception\n\nWe can also use the result of the function to alter the behavior of retrying.\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=retry_if_result(is_none_p))\n def might_return_none():\n print(\"Retry with no wait if return value is None\")\n\nSee also these methods:\n\n.. testcode::\n\n retry_if_exception\n retry_if_exception_type\n retry_if_not_exception_type\n retry_unless_exception_type\n retry_if_result\n retry_if_not_result\n retry_if_exception_message\n retry_if_not_exception_message\n retry_any\n retry_all\n\nWe can also combine several conditions:\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\n def might_return_none():\n print(\"Retry forever ignoring Exceptions with no wait if return value is None\")\n\nAny combination of stop, wait, etc. is also supported to give you the freedom\nto mix and match.\n\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\nexception:\n\n.. testcode::\n\n @retry\n def do_something():\n result = something_else()\n if result == 23:\n raise TryAgain\n\nError Handling\n~~~~~~~~~~~~~~\n\nNormally when your function fails its final time (and will not be retried again based on your settings),\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\nof the stack trace.\n\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\nis most visible), you can set `reraise=True`.\n\n.. testcode::\n\n @retry(reraise=True, stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except MyException:\n # timed out retrying\n pass\n\nBefore and After Retry, and Logging\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIt's possible to execute an action before any attempt of calling the function\nby using the before callback function:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIn the same spirit, It's possible to execute after a call that failed:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIt's also possible to only log failures that are going to be retried. Normally\nretries happen after a wait interval, so the keyword argument is called\n``before_sleep``:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3),\n before_sleep=before_sleep_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n\nStatistics\n~~~~~~~~~~\n\nYou can access the statistics about the retry made over a function by using the\n`statistics` attribute attached to the function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nCustom Callbacks\n~~~~~~~~~~~~~~~~\n\nYou can also define your own callbacks. The callback should accept one\nparameter called ``retry_state`` that contains all information about current\nretry invocation.\n\nFor example, you can call a custom callback function after all retries failed,\nwithout raising an exception (or you can re-raise or do anything really)\n\n.. testcode::\n\n def return_last_value(retry_state):\n \"\"\"return the result of the last call attempt\"\"\"\n return retry_state.outcome.result()\n\n def is_false(value):\n \"\"\"Return True if value is False\"\"\"\n return value is False\n\n # will return False after trying 3 times to get a different result\n @retry(stop=stop_after_attempt(3),\n retry_error_callback=return_last_value,\n retry=retry_if_result(is_false))\n def eventually_return_false():\n return False\n\nRetryCallState\n~~~~~~~~~~~~~~\n\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\n\nOther Custom Callbacks\n~~~~~~~~~~~~~~~~~~~~~~\n\nIt's also possible to define custom callbacks for other keyword arguments.\n\n.. function:: my_stop(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should stop\n :rtype: bool\n\n.. function:: my_wait(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: number of seconds to wait before next retry\n :rtype: float\n\n.. function:: my_retry(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should continue\n :rtype: bool\n\n.. function:: my_before(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_after(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_before_sleep(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\nHere's an example with a custom ``before_sleep`` function:\n\n.. testcode::\n\n import logging\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n def my_before_sleep(retry_state):\n if retry_state.attempt_number < 1:\n loglevel = logging.INFO\n else:\n loglevel = logging.WARNING\n logger.log(\n loglevel, 'Retrying %s: attempt %s ended with: %s',\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\n\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except RetryError:\n pass\n\n\nChanging Arguments at Run Time\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can change the arguments of a retry decorator as needed when calling it by\nusing the `retry_with` function attached to the wrapped function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nIf you want to use variables to set up the retry parameters, you don't have\nto use the `retry` decorator - you can instead use `Retrying` directly:\n\n.. testcode::\n\n def never_good_enough(arg1):\n raise Exception('Invalid argument: {}'.format(arg1))\n\n def try_never_good_enough(max_attempts=3):\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\n retryer(never_good_enough, 'I really do try')\n\nYou may also want to change the behaviour of a decorated function temporarily,\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\nattribute attached to the function. Bear in mind this is a write-only attribute,\nstatistics should be read from the function `statistics` attribute.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n from unittest import mock\n\n with mock.patch.object(raise_my_exception.retry, \"wait\", wait_fixed(0)):\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nRetrying code block\n~~~~~~~~~~~~~~~~~~~\n\nTenacity allows you to retry a code block without the need to wraps it in an\nisolated function. This makes it easy to isolate failing block while sharing\ncontext. The trick is to combine a for loop and a context manager.\n\n.. testcode::\n\n from tenacity import Retrying, RetryError, stop_after_attempt\n\n try:\n for attempt in Retrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nYou can configure every details of retry policy by configuring the Retrying\nobject.\n\nWith async code you can use AsyncRetrying.\n\n.. testcode::\n\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\n\n async def function():\n try:\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nIn both cases, you may want to set the result to the attempt so it's available\nin retry strategies like ``retry_if_result``. This can be done accessing the\n``retry_state`` property:\n\n.. testcode::\n\n from tenacity import AsyncRetrying, retry_if_result\n\n async def function():\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\n with attempt:\n result = 1 # Some complex calculation, function call, etc.\n if not attempt.retry_state.outcome.failed:\n attempt.retry_state.set_result(result)\n return result\n\nAsync and retry\n~~~~~~~~~~~~~~~\n\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\nSleeps are done asynchronously too.\n\n.. code-block:: python\n\n @retry\n async def my_asyncio_function(loop):\n await loop.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n async def my_async_trio_function():\n await trio.socket.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n @tornado.gen.coroutine\n def my_async_tornado_function(http_client, url):\n yield http_client.fetch(url)\n\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\n\n.. code-block:: python\n\n @retry(sleep=curio.sleep)\n async def my_async_curio_function():\n await asks.get('https://example.org')\n\nContribute\n----------\n\n#. Check for open issues or open a fresh issue to start a discussion around a\n feature idea or a bug.\n#. Fork `the repository`_ on GitHub to start making your changes to the\n **main** branch (or branch off of it).\n#. Write a test which shows that the bug was fixed or that the feature works as\n expected.\n#. Add a `changelog <#Changelogs>`_\n#. Make the docs better (or more detailed, or more easier to read, or ...)\n\n.. _`the repository`: https://github.com/jd/tenacity\n\nChangelogs\n~~~~~~~~~~\n\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\n\nThe doc generation will automatically compile the changelogs. You just need to add them.\n\n.. code-block:: sh\n\n # Opens a template file in an editor\n tox -e reno -- new some-slug-for-my-change --edit\n\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\n\n[end of README.rst]","filename":"README.rst","id":"9"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef before_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"Before call strategy that does nothing.\"\"\"\n\n\ndef before_log(\n logger: \"logging.Logger\", log_level: int\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"Before call strategy that logs to some logger the attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n logger.log(\n log_level,\n f\"Starting call to '{fn_name}', \"\n f\"this is the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\",\n )\n\n return log_it\n\n[end of tenacity/before.py]","filename":"tenacity/before.py","id":"10"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef before_sleep_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"Before sleep strategy that does nothing.\"\"\"\n\n\ndef before_sleep_log(\n logger: \"logging.Logger\",\n log_level: int,\n exc_info: bool = False,\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"Before sleep strategy that logs to some logger the attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n local_exc_info: BaseException | bool | None\n\n if retry_state.outcome is None:\n raise RuntimeError(\"log_it() called before outcome was set\")\n\n if retry_state.next_action is None:\n raise RuntimeError(\"log_it() called before next_action was set\")\n\n if retry_state.outcome.failed:\n ex = retry_state.outcome.exception()\n verb, value = \"raised\", f\"{ex.__class__.__name__}: {ex}\"\n\n if exc_info:\n local_exc_info = retry_state.outcome.exception()\n else:\n local_exc_info = False\n else:\n verb, value = \"returned\", retry_state.outcome.result()\n local_exc_info = False # exc_info does not apply when no exception\n\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n\n logger.log(\n log_level,\n f\"Retrying {fn_name} \"\n f\"in {retry_state.next_action.sleep} seconds as it {verb} {value}.\",\n exc_info=local_exc_info,\n )\n\n return log_it\n\n[end of tenacity/before_sleep.py]","filename":"tenacity/before_sleep.py","id":"11"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport abc\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import threading\n\n from tenacity import RetryCallState\n\n\nclass stop_base(abc.ABC):\n \"\"\"Abstract base class for stop strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n pass\n\n def __and__(self, other: \"stop_base\") -> \"stop_all\":\n return stop_all(self, other)\n\n def __or__(self, other: \"stop_base\") -> \"stop_any\":\n return stop_any(self, other)\n\n\nStopBaseT = typing.Union[stop_base, typing.Callable[[\"RetryCallState\"], bool]]\n\n\nclass stop_any(stop_base):\n \"\"\"Stop if any of the stop condition is valid.\"\"\"\n\n def __init__(self, *stops: stop_base) -> None:\n self.stops = stops\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return any(x(retry_state) for x in self.stops)\n\n\nclass stop_all(stop_base):\n \"\"\"Stop if all the stop conditions are valid.\"\"\"\n\n def __init__(self, *stops: stop_base) -> None:\n self.stops = stops\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return all(x(retry_state) for x in self.stops)\n\n\nclass _stop_never(stop_base):\n \"\"\"Never stop.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return False\n\n\nstop_never = _stop_never()\n\n\nclass stop_when_event_set(stop_base):\n \"\"\"Stop when the given event is set.\"\"\"\n\n def __init__(self, event: \"threading.Event\") -> None:\n self.event = event\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return self.event.is_set()\n\n\nclass stop_after_attempt(stop_base):\n \"\"\"Stop when the previous attempt >= max_attempt.\"\"\"\n\n def __init__(self, max_attempt_number: int) -> None:\n self.max_attempt_number = max_attempt_number\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return retry_state.attempt_number >= self.max_attempt_number\n\n\nclass stop_after_delay(stop_base):\n \"\"\"\n Stop when the time from the first attempt >= limit.\n\n Note: `max_delay` will be exceeded, so when used with a `wait`, the actual total delay will be greater\n than `max_delay` by some of the final sleep period before `max_delay` is exceeded.\n\n If you need stricter timing with waits, consider `stop_before_delay` instead.\n \"\"\"\n\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\n self.max_delay = _utils.to_seconds(max_delay)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.seconds_since_start is None:\n raise RuntimeError(\"__call__() called but seconds_since_start is not set\")\n return retry_state.seconds_since_start >= self.max_delay\n\n\nclass stop_before_delay(stop_base):\n \"\"\"\n Stop right before the next attempt would take place after the time from the first attempt >= limit.\n\n Most useful when you are using with a `wait` function like wait_random_exponential, but need to make\n sure that the max_delay is not exceeded.\n \"\"\"\n\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\n self.max_delay = _utils.to_seconds(max_delay)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.seconds_since_start is None:\n raise RuntimeError(\"__call__() called but seconds_since_start is not set\")\n return (\n retry_state.seconds_since_start + retry_state.upcoming_sleep\n >= self.max_delay\n )\n\n[end of tenacity/stop.py]","filename":"tenacity/stop.py","id":"12"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport abc\nimport random\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass wait_base(abc.ABC):\n \"\"\"Abstract base class for wait strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n pass\n\n def __add__(self, other: \"wait_base\") -> \"wait_combine\":\n return wait_combine(self, other)\n\n def __radd__(self, other: \"wait_base\") -> typing.Union[\"wait_combine\", \"wait_base\"]:\n # make it possible to use multiple waits with the built-in sum function\n if other == 0: # type: ignore[comparison-overlap]\n return self\n return self.__add__(other)\n\n\nWaitBaseT = typing.Union[\n wait_base, typing.Callable[[\"RetryCallState\"], typing.Union[float, int]]\n]\n\n\nclass wait_fixed(wait_base):\n \"\"\"Wait strategy that waits a fixed amount of time between each retry.\"\"\"\n\n def __init__(self, wait: _utils.time_unit_type) -> None:\n self.wait_fixed = _utils.to_seconds(wait)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return self.wait_fixed\n\n\nclass wait_none(wait_fixed):\n \"\"\"Wait strategy that doesn't wait at all before retrying.\"\"\"\n\n def __init__(self) -> None:\n super().__init__(0)\n\n\nclass wait_random(wait_base):\n \"\"\"Wait strategy that waits a random amount of time between min/max.\"\"\"\n\n def __init__(\n self, min: _utils.time_unit_type = 0, max: _utils.time_unit_type = 1\n ) -> None: # noqa\n self.wait_random_min = _utils.to_seconds(min)\n self.wait_random_max = _utils.to_seconds(max)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return self.wait_random_min + (\n random.random() * (self.wait_random_max - self.wait_random_min)\n )\n\n\nclass wait_combine(wait_base):\n \"\"\"Combine several waiting strategies.\"\"\"\n\n def __init__(self, *strategies: wait_base) -> None:\n self.wait_funcs = strategies\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return sum(x(retry_state=retry_state) for x in self.wait_funcs)\n\n\nclass wait_chain(wait_base):\n \"\"\"Chain two or more waiting strategies.\n\n If all strategies are exhausted, the very last strategy is used\n thereafter.\n\n For example::\n\n @retry(wait=wait_chain(*[wait_fixed(1) for i in range(3)] +\n [wait_fixed(2) for j in range(5)] +\n [wait_fixed(5) for k in range(4)))\n def wait_chained():\n print(\"Wait 1s for 3 attempts, 2s for 5 attempts and 5s\n thereafter.\")\n \"\"\"\n\n def __init__(self, *strategies: wait_base) -> None:\n self.strategies = strategies\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n wait_func_no = min(max(retry_state.attempt_number, 1), len(self.strategies))\n wait_func = self.strategies[wait_func_no - 1]\n return wait_func(retry_state=retry_state)\n\n\nclass wait_incrementing(wait_base):\n \"\"\"Wait an incremental amount of time after each attempt.\n\n Starting at a starting value and incrementing by a value for each attempt\n (and restricting the upper limit to some maximum value).\n \"\"\"\n\n def __init__(\n self,\n start: _utils.time_unit_type = 0,\n increment: _utils.time_unit_type = 100,\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\n ) -> None:\n self.start = _utils.to_seconds(start)\n self.increment = _utils.to_seconds(increment)\n self.max = _utils.to_seconds(max)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n result = self.start + (self.increment * (retry_state.attempt_number - 1))\n return max(0, min(result, self.max))\n\n\nclass wait_exponential(wait_base):\n \"\"\"Wait strategy that applies exponential backoff.\n\n It allows for a customized multiplier and an ability to restrict the\n upper and lower limits to some maximum and minimum value.\n\n The intervals are fixed (i.e. there is no jitter), so this strategy is\n suitable for balancing retries against latency when a required resource is\n unavailable for an unknown duration, but *not* suitable for resolving\n contention between multiple processes for a shared resource. Use\n wait_random_exponential for the latter case.\n \"\"\"\n\n def __init__(\n self,\n multiplier: typing.Union[int, float] = 1,\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\n exp_base: typing.Union[int, float] = 2,\n min: _utils.time_unit_type = 0, # noqa\n ) -> None:\n self.multiplier = multiplier\n self.min = _utils.to_seconds(min)\n self.max = _utils.to_seconds(max)\n self.exp_base = exp_base\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n try:\n exp = self.exp_base ** (retry_state.attempt_number - 1)\n result = self.multiplier * exp\n except OverflowError:\n return self.max\n return max(max(0, self.min), min(result, self.max))\n\n\nclass wait_random_exponential(wait_exponential):\n \"\"\"Random wait with exponentially widening window.\n\n An exponential backoff strategy used to mediate contention between multiple\n uncoordinated processes for a shared resource in distributed systems. This\n is the sense in which \"exponential backoff\" is meant in e.g. Ethernet\n networking, and corresponds to the \"Full Jitter\" algorithm described in\n this blog post:\n\n https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/\n\n Each retry occurs at a random time in a geometrically expanding interval.\n It allows for a custom multiplier and an ability to restrict the upper\n limit of the random interval to some maximum value.\n\n Example::\n\n wait_random_exponential(multiplier=0.5, # initial window 0.5s\n max=60) # max 60s timeout\n\n When waiting for an unavailable resource to become available again, as\n opposed to trying to resolve contention for a shared resource, the\n wait_exponential strategy (which uses a fixed interval) may be preferable.\n\n \"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n high = super().__call__(retry_state=retry_state)\n return random.uniform(self.min, high)\n\n\nclass wait_exponential_jitter(wait_base):\n \"\"\"Wait strategy that applies exponential backoff and jitter.\n\n It allows for a customized initial wait, maximum wait and jitter.\n\n This implements the strategy described here:\n https://cloud.google.com/storage/docs/retry-strategy\n\n The wait time is min(initial * 2**n + random.uniform(0, jitter), maximum)\n where n is the retry count.\n \"\"\"\n\n def __init__(\n self,\n initial: float = 1,\n max: float = _utils.MAX_WAIT, # noqa\n exp_base: float = 2,\n jitter: float = 1,\n ) -> None:\n self.initial = initial\n self.max = max\n self.exp_base = exp_base\n self.jitter = jitter\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n jitter = random.uniform(0, self.jitter)\n try:\n exp = self.exp_base ** (retry_state.attempt_number - 1)\n result = self.initial * exp + jitter\n except OverflowError:\n result = self.max\n return max(0, min(result, self.max))\n\n[end of tenacity/wait.py]","filename":"tenacity/wait.py","id":"13"},{"content":"# Copyright 2016-2018 Julien Danjou\n# Copyright 2017 Elisey Zanko\n# Copyright 2016 Étienne Bersac\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport dataclasses\nimport functools\nimport sys\nimport threading\nimport time\nimport typing as t\nimport warnings\nfrom abc import ABC, abstractmethod\nfrom concurrent import futures\n\nfrom . import _utils\n\n# Import all built-in retry strategies for easier usage.\nfrom .retry import retry_base # noqa\nfrom .retry import retry_all # noqa\nfrom .retry import retry_always # noqa\nfrom .retry import retry_any # noqa\nfrom .retry import retry_if_exception # noqa\nfrom .retry import retry_if_exception_type # noqa\nfrom .retry import retry_if_exception_cause_type # noqa\nfrom .retry import retry_if_not_exception_type # noqa\nfrom .retry import retry_if_not_result # noqa\nfrom .retry import retry_if_result # noqa\nfrom .retry import retry_never # noqa\nfrom .retry import retry_unless_exception_type # noqa\nfrom .retry import retry_if_exception_message # noqa\nfrom .retry import retry_if_not_exception_message # noqa\n\n# Import all nap strategies for easier usage.\nfrom .nap import sleep # noqa\nfrom .nap import sleep_using_event # noqa\n\n# Import all built-in stop strategies for easier usage.\nfrom .stop import stop_after_attempt # noqa\nfrom .stop import stop_after_delay # noqa\nfrom .stop import stop_before_delay # noqa\nfrom .stop import stop_all # noqa\nfrom .stop import stop_any # noqa\nfrom .stop import stop_never # noqa\nfrom .stop import stop_when_event_set # noqa\n\n# Import all built-in wait strategies for easier usage.\nfrom .wait import wait_chain # noqa\nfrom .wait import wait_combine # noqa\nfrom .wait import wait_exponential # noqa\nfrom .wait import wait_fixed # noqa\nfrom .wait import wait_incrementing # noqa\nfrom .wait import wait_none # noqa\nfrom .wait import wait_random # noqa\nfrom .wait import wait_random_exponential # noqa\nfrom .wait import wait_random_exponential as wait_full_jitter # noqa\nfrom .wait import wait_exponential_jitter # noqa\n\n# Import all built-in before strategies for easier usage.\nfrom .before import before_log # noqa\nfrom .before import before_nothing # noqa\n\n# Import all built-in after strategies for easier usage.\nfrom .after import after_log # noqa\nfrom .after import after_nothing # noqa\n\n# Import all built-in before sleep strategies for easier usage.\nfrom .before_sleep import before_sleep_log # noqa\nfrom .before_sleep import before_sleep_nothing # noqa\n\ntry:\n import tornado\nexcept ImportError:\n tornado = None\n\nif t.TYPE_CHECKING:\n import types\n\n from typing_extensions import Self\n\n from . import asyncio as tasyncio\n from .retry import RetryBaseT\n from .stop import StopBaseT\n from .wait import WaitBaseT\n\n\nWrappedFnReturnT = t.TypeVar(\"WrappedFnReturnT\")\nWrappedFn = t.TypeVar(\"WrappedFn\", bound=t.Callable[..., t.Any])\n\n\ndataclass_kwargs = {}\nif sys.version_info >= (3, 10):\n dataclass_kwargs.update({\"slots\": True})\n\n\n@dataclasses.dataclass(**dataclass_kwargs)\nclass IterState:\n actions: t.List[t.Callable[[\"RetryCallState\"], t.Any]] = dataclasses.field(\n default_factory=list\n )\n retry_run_result: bool = False\n delay_since_first_attempt: int = 0\n stop_run_result: bool = False\n is_explicit_retry: bool = False\n\n def reset(self) -> None:\n self.actions = []\n self.retry_run_result = False\n self.delay_since_first_attempt = 0\n self.stop_run_result = False\n self.is_explicit_retry = False\n\n\nclass TryAgain(Exception):\n \"\"\"Always retry the executed function when raised.\"\"\"\n\n\nNO_RESULT = object()\n\n\nclass DoAttempt:\n pass\n\n\nclass DoSleep(float):\n pass\n\n\nclass BaseAction:\n \"\"\"Base class for representing actions to take by retry object.\n\n Concrete implementations must define:\n - __init__: to initialize all necessary fields\n - REPR_FIELDS: class variable specifying attributes to include in repr(self)\n - NAME: for identification in retry object methods and callbacks\n \"\"\"\n\n REPR_FIELDS: t.Sequence[str] = ()\n NAME: t.Optional[str] = None\n\n def __repr__(self) -> str:\n state_str = \", \".join(\n f\"{field}={getattr(self, field)!r}\" for field in self.REPR_FIELDS\n )\n return f\"{self.__class__.__name__}({state_str})\"\n\n def __str__(self) -> str:\n return repr(self)\n\n\nclass RetryAction(BaseAction):\n REPR_FIELDS = (\"sleep\",)\n NAME = \"retry\"\n\n def __init__(self, sleep: t.SupportsFloat) -> None:\n self.sleep = float(sleep)\n\n\n_unset = object()\n\n\ndef _first_set(first: t.Union[t.Any, object], second: t.Any) -> t.Any:\n return second if first is _unset else first\n\n\nclass RetryError(Exception):\n \"\"\"Encapsulates the last attempt instance right before giving up.\"\"\"\n\n def __init__(self, last_attempt: \"Future\") -> None:\n self.last_attempt = last_attempt\n super().__init__(last_attempt)\n\n def reraise(self) -> t.NoReturn:\n if self.last_attempt.failed:\n raise self.last_attempt.result()\n raise self\n\n def __str__(self) -> str:\n return f\"{self.__class__.__name__}[{self.last_attempt}]\"\n\n\nclass AttemptManager:\n \"\"\"Manage attempt context.\"\"\"\n\n def __init__(self, retry_state: \"RetryCallState\"):\n self.retry_state = retry_state\n\n def __enter__(self) -> None:\n pass\n\n def __exit__(\n self,\n exc_type: t.Optional[t.Type[BaseException]],\n exc_value: t.Optional[BaseException],\n traceback: t.Optional[\"types.TracebackType\"],\n ) -> t.Optional[bool]:\n if exc_type is not None and exc_value is not None:\n self.retry_state.set_exception((exc_type, exc_value, traceback))\n return True # Swallow exception.\n else:\n # We don't have the result, actually.\n self.retry_state.set_result(None)\n return None\n\n\nclass BaseRetrying(ABC):\n def __init__(\n self,\n sleep: t.Callable[[t.Union[int, float]], None] = sleep,\n stop: \"StopBaseT\" = stop_never,\n wait: \"WaitBaseT\" = wait_none(),\n retry: \"RetryBaseT\" = retry_if_exception_type(),\n before: t.Callable[[\"RetryCallState\"], None] = before_nothing,\n after: t.Callable[[\"RetryCallState\"], None] = after_nothing,\n before_sleep: t.Optional[t.Callable[[\"RetryCallState\"], None]] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[RetryError] = RetryError,\n retry_error_callback: t.Optional[t.Callable[[\"RetryCallState\"], t.Any]] = None,\n ):\n self.sleep = sleep\n self.stop = stop\n self.wait = wait\n self.retry = retry\n self.before = before\n self.after = after\n self.before_sleep = before_sleep\n self.reraise = reraise\n self._local = threading.local()\n self.retry_error_cls = retry_error_cls\n self.retry_error_callback = retry_error_callback\n\n def copy(\n self,\n sleep: t.Union[t.Callable[[t.Union[int, float]], None], object] = _unset,\n stop: t.Union[\"StopBaseT\", object] = _unset,\n wait: t.Union[\"WaitBaseT\", object] = _unset,\n retry: t.Union[retry_base, object] = _unset,\n before: t.Union[t.Callable[[\"RetryCallState\"], None], object] = _unset,\n after: t.Union[t.Callable[[\"RetryCallState\"], None], object] = _unset,\n before_sleep: t.Union[\n t.Optional[t.Callable[[\"RetryCallState\"], None]], object\n ] = _unset,\n reraise: t.Union[bool, object] = _unset,\n retry_error_cls: t.Union[t.Type[RetryError], object] = _unset,\n retry_error_callback: t.Union[\n t.Optional[t.Callable[[\"RetryCallState\"], t.Any]], object\n ] = _unset,\n ) -> \"Self\":\n \"\"\"Copy this object with some parameters changed if needed.\"\"\"\n return self.__class__(\n sleep=_first_set(sleep, self.sleep),\n stop=_first_set(stop, self.stop),\n wait=_first_set(wait, self.wait),\n retry=_first_set(retry, self.retry),\n before=_first_set(before, self.before),\n after=_first_set(after, self.after),\n before_sleep=_first_set(before_sleep, self.before_sleep),\n reraise=_first_set(reraise, self.reraise),\n retry_error_cls=_first_set(retry_error_cls, self.retry_error_cls),\n retry_error_callback=_first_set(\n retry_error_callback, self.retry_error_callback\n ),\n )\n\n def __repr__(self) -> str:\n return (\n f\"<{self.__class__.__name__} object at 0x{id(self):x} (\"\n f\"stop={self.stop}, \"\n f\"wait={self.wait}, \"\n f\"sleep={self.sleep}, \"\n f\"retry={self.retry}, \"\n f\"before={self.before}, \"\n f\"after={self.after})>\"\n )\n\n @property\n def statistics(self) -> t.Dict[str, t.Any]:\n \"\"\"Return a dictionary of runtime statistics.\n\n This dictionary will be empty when the controller has never been\n ran. When it is running or has ran previously it should have (but\n may not) have useful and/or informational keys and values when\n running is underway and/or completed.\n\n .. warning:: The keys in this dictionary **should** be some what\n stable (not changing), but there existence **may**\n change between major releases as new statistics are\n gathered or removed so before accessing keys ensure that\n they actually exist and handle when they do not.\n\n .. note:: The values in this dictionary are local to the thread\n running call (so if multiple threads share the same retrying\n object - either directly or indirectly) they will each have\n there own view of statistics they have collected (in the\n future we may provide a way to aggregate the various\n statistics from each thread).\n \"\"\"\n try:\n return self._local.statistics # type: ignore[no-any-return]\n except AttributeError:\n self._local.statistics = t.cast(t.Dict[str, t.Any], {})\n return self._local.statistics\n\n @property\n def iter_state(self) -> IterState:\n try:\n return self._local.iter_state # type: ignore[no-any-return]\n except AttributeError:\n self._local.iter_state = IterState()\n return self._local.iter_state\n\n def wraps(self, f: WrappedFn) -> WrappedFn:\n \"\"\"Wrap a function for retrying.\n\n :param f: A function to wraps for retrying.\n \"\"\"\n\n @functools.wraps(\n f, functools.WRAPPER_ASSIGNMENTS + (\"__defaults__\", \"__kwdefaults__\")\n )\n def wrapped_f(*args: t.Any, **kw: t.Any) -> t.Any:\n # Always create a copy to prevent overwriting the local contexts when\n # calling the same wrapped functions multiple times in the same stack\n copy = self.copy()\n wrapped_f.statistics = copy.statistics # type: ignore[attr-defined]\n return copy(f, *args, **kw)\n\n def retry_with(*args: t.Any, **kwargs: t.Any) -> WrappedFn:\n return self.copy(*args, **kwargs).wraps(f)\n\n # Preserve attributes\n wrapped_f.retry = self # type: ignore[attr-defined]\n wrapped_f.retry_with = retry_with # type: ignore[attr-defined]\n wrapped_f.statistics = {} # type: ignore[attr-defined]\n\n return wrapped_f # type: ignore[return-value]\n\n def begin(self) -> None:\n self.statistics.clear()\n self.statistics[\"start_time\"] = time.monotonic()\n self.statistics[\"attempt_number\"] = 1\n self.statistics[\"idle_for\"] = 0\n\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\n self.iter_state.actions.append(fn)\n\n def _run_retry(self, retry_state: \"RetryCallState\") -> None:\n self.iter_state.retry_run_result = self.retry(retry_state)\n\n def _run_wait(self, retry_state: \"RetryCallState\") -> None:\n if self.wait:\n sleep = self.wait(retry_state)\n else:\n sleep = 0.0\n\n retry_state.upcoming_sleep = sleep\n\n def _run_stop(self, retry_state: \"RetryCallState\") -> None:\n self.statistics[\"delay_since_first_attempt\"] = retry_state.seconds_since_start\n self.iter_state.stop_run_result = self.stop(retry_state)\n\n def iter(self, retry_state: \"RetryCallState\") -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa\n self._begin_iter(retry_state)\n result = None\n for action in self.iter_state.actions:\n result = action(retry_state)\n return result\n\n def _begin_iter(self, retry_state: \"RetryCallState\") -> None: # noqa\n self.iter_state.reset()\n\n fut = retry_state.outcome\n if fut is None:\n if self.before is not None:\n self._add_action_func(self.before)\n self._add_action_func(lambda rs: DoAttempt())\n return\n\n self.iter_state.is_explicit_retry = fut.failed and isinstance(\n fut.exception(), TryAgain\n )\n if not self.iter_state.is_explicit_retry:\n self._add_action_func(self._run_retry)\n self._add_action_func(self._post_retry_check_actions)\n\n def _post_retry_check_actions(self, retry_state: \"RetryCallState\") -> None:\n if not (self.iter_state.is_explicit_retry or self.iter_state.retry_run_result):\n self._add_action_func(lambda rs: rs.outcome.result())\n return\n\n if self.after is not None:\n self._add_action_func(self.after)\n\n self._add_action_func(self._run_wait)\n self._add_action_func(self._run_stop)\n self._add_action_func(self._post_stop_check_actions)\n\n def _post_stop_check_actions(self, retry_state: \"RetryCallState\") -> None:\n if self.iter_state.stop_run_result:\n if self.retry_error_callback:\n self._add_action_func(self.retry_error_callback)\n return\n\n def exc_check(rs: \"RetryCallState\") -> None:\n fut = t.cast(Future, rs.outcome)\n retry_exc = self.retry_error_cls(fut)\n if self.reraise:\n raise retry_exc.reraise()\n raise retry_exc from fut.exception()\n\n self._add_action_func(exc_check)\n return\n\n def next_action(rs: \"RetryCallState\") -> None:\n sleep = rs.upcoming_sleep\n rs.next_action = RetryAction(sleep)\n rs.idle_for += sleep\n self.statistics[\"idle_for\"] += sleep\n self.statistics[\"attempt_number\"] += 1\n\n self._add_action_func(next_action)\n\n if self.before_sleep is not None:\n self._add_action_func(self.before_sleep)\n\n self._add_action_func(lambda rs: DoSleep(rs.upcoming_sleep))\n\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\n self.begin()\n\n retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n yield AttemptManager(retry_state=retry_state)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n self.sleep(do)\n else:\n break\n\n @abstractmethod\n def __call__(\n self,\n fn: t.Callable[..., WrappedFnReturnT],\n *args: t.Any,\n **kwargs: t.Any,\n ) -> WrappedFnReturnT:\n pass\n\n\nclass Retrying(BaseRetrying):\n \"\"\"Retrying controller.\"\"\"\n\n def __call__(\n self,\n fn: t.Callable[..., WrappedFnReturnT],\n *args: t.Any,\n **kwargs: t.Any,\n ) -> WrappedFnReturnT:\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n self.sleep(do)\n else:\n return do # type: ignore[no-any-return]\n\n\nif sys.version_info >= (3, 9):\n FutureGenericT = futures.Future[t.Any]\nelse:\n FutureGenericT = futures.Future\n\n\nclass Future(FutureGenericT):\n \"\"\"Encapsulates a (future or past) attempted call to a target function.\"\"\"\n\n def __init__(self, attempt_number: int) -> None:\n super().__init__()\n self.attempt_number = attempt_number\n\n @property\n def failed(self) -> bool:\n \"\"\"Return whether a exception is being held in this future.\"\"\"\n return self.exception() is not None\n\n @classmethod\n def construct(\n cls, attempt_number: int, value: t.Any, has_exception: bool\n ) -> \"Future\":\n \"\"\"Construct a new Future object.\"\"\"\n fut = cls(attempt_number)\n if has_exception:\n fut.set_exception(value)\n else:\n fut.set_result(value)\n return fut\n\n\nclass RetryCallState:\n \"\"\"State related to a single call wrapped with Retrying.\"\"\"\n\n def __init__(\n self,\n retry_object: BaseRetrying,\n fn: t.Optional[WrappedFn],\n args: t.Any,\n kwargs: t.Any,\n ) -> None:\n #: Retry call start timestamp\n self.start_time = time.monotonic()\n #: Retry manager object\n self.retry_object = retry_object\n #: Function wrapped by this retry call\n self.fn = fn\n #: Arguments of the function wrapped by this retry call\n self.args = args\n #: Keyword arguments of the function wrapped by this retry call\n self.kwargs = kwargs\n\n #: The number of the current attempt\n self.attempt_number: int = 1\n #: Last outcome (result or exception) produced by the function\n self.outcome: t.Optional[Future] = None\n #: Timestamp of the last outcome\n self.outcome_timestamp: t.Optional[float] = None\n #: Time spent sleeping in retries\n self.idle_for: float = 0.0\n #: Next action as decided by the retry manager\n self.next_action: t.Optional[RetryAction] = None\n #: Next sleep time as decided by the retry manager.\n self.upcoming_sleep: float = 0.0\n\n @property\n def seconds_since_start(self) -> t.Optional[float]:\n if self.outcome_timestamp is None:\n return None\n return self.outcome_timestamp - self.start_time\n\n def prepare_for_next_attempt(self) -> None:\n self.outcome = None\n self.outcome_timestamp = None\n self.attempt_number += 1\n self.next_action = None\n\n def set_result(self, val: t.Any) -> None:\n ts = time.monotonic()\n fut = Future(self.attempt_number)\n fut.set_result(val)\n self.outcome, self.outcome_timestamp = fut, ts\n\n def set_exception(\n self,\n exc_info: t.Tuple[\n t.Type[BaseException], BaseException, \"types.TracebackType| None\"\n ],\n ) -> None:\n ts = time.monotonic()\n fut = Future(self.attempt_number)\n fut.set_exception(exc_info[1])\n self.outcome, self.outcome_timestamp = fut, ts\n\n def __repr__(self) -> str:\n if self.outcome is None:\n result = \"none yet\"\n elif self.outcome.failed:\n exception = self.outcome.exception()\n result = f\"failed ({exception.__class__.__name__} {exception})\"\n else:\n result = f\"returned {self.outcome.result()}\"\n\n slept = float(round(self.idle_for, 2))\n clsname = self.__class__.__name__\n return f\"<{clsname} {id(self)}: attempt #{self.attempt_number}; slept for {slept}; last result: {result}>\"\n\n\n@t.overload\ndef retry(func: WrappedFn) -> WrappedFn: ...\n\n\n@t.overload\ndef retry(\n sleep: t.Callable[[t.Union[int, float]], t.Union[None, t.Awaitable[None]]] = sleep,\n stop: \"StopBaseT\" = stop_never,\n wait: \"WaitBaseT\" = wait_none(),\n retry: \"t.Union[RetryBaseT, tasyncio.retry.RetryBaseT]\" = retry_if_exception_type(),\n before: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = before_nothing,\n after: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = after_nothing,\n before_sleep: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[None, t.Awaitable[None]]]\n ] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[\"RetryError\"] = RetryError,\n retry_error_callback: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[t.Any, t.Awaitable[t.Any]]]\n ] = None,\n) -> t.Callable[[WrappedFn], WrappedFn]: ...\n\n\ndef retry(*dargs: t.Any, **dkw: t.Any) -> t.Any:\n \"\"\"Wrap a function with a new `Retrying` object.\n\n :param dargs: positional arguments passed to Retrying object\n :param dkw: keyword arguments passed to the Retrying object\n \"\"\"\n # support both @retry and @retry() as valid syntax\n if len(dargs) == 1 and callable(dargs[0]):\n return retry()(dargs[0])\n else:\n\n def wrap(f: WrappedFn) -> WrappedFn:\n if isinstance(f, retry_base):\n warnings.warn(\n f\"Got retry_base instance ({f.__class__.__name__}) as callable argument, \"\n f\"this will probably hang indefinitely (did you mean retry={f.__class__.__name__}(...)?)\"\n )\n r: \"BaseRetrying\"\n if _utils.is_coroutine_callable(f):\n r = AsyncRetrying(*dargs, **dkw)\n elif (\n tornado\n and hasattr(tornado.gen, \"is_coroutine_function\")\n and tornado.gen.is_coroutine_function(f)\n ):\n r = TornadoRetrying(*dargs, **dkw)\n else:\n r = Retrying(*dargs, **dkw)\n\n return r.wraps(f)\n\n return wrap\n\n\nfrom tenacity.asyncio import AsyncRetrying # noqa:E402,I100\n\nif tornado:\n from tenacity.tornadoweb import TornadoRetrying\n\n\n__all__ = [\n \"retry_base\",\n \"retry_all\",\n \"retry_always\",\n \"retry_any\",\n \"retry_if_exception\",\n \"retry_if_exception_type\",\n \"retry_if_exception_cause_type\",\n \"retry_if_not_exception_type\",\n \"retry_if_not_result\",\n \"retry_if_result\",\n \"retry_never\",\n \"retry_unless_exception_type\",\n \"retry_if_exception_message\",\n \"retry_if_not_exception_message\",\n \"sleep\",\n \"sleep_using_event\",\n \"stop_after_attempt\",\n \"stop_after_delay\",\n \"stop_before_delay\",\n \"stop_all\",\n \"stop_any\",\n \"stop_never\",\n \"stop_when_event_set\",\n \"wait_chain\",\n \"wait_combine\",\n \"wait_exponential\",\n \"wait_fixed\",\n \"wait_incrementing\",\n \"wait_none\",\n \"wait_random\",\n \"wait_random_exponential\",\n \"wait_full_jitter\",\n \"wait_exponential_jitter\",\n \"before_log\",\n \"before_nothing\",\n \"after_log\",\n \"after_nothing\",\n \"before_sleep_log\",\n \"before_sleep_nothing\",\n \"retry\",\n \"WrappedFn\",\n \"TryAgain\",\n \"NO_RESULT\",\n \"DoAttempt\",\n \"DoSleep\",\n \"BaseAction\",\n \"RetryAction\",\n \"RetryError\",\n \"AttemptManager\",\n \"BaseRetrying\",\n \"Retrying\",\n \"Future\",\n \"RetryCallState\",\n \"AsyncRetrying\",\n]\n\n[end of tenacity/__init__.py]","filename":"tenacity/__init__.py","id":"14"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport time\nimport typing\n\nif typing.TYPE_CHECKING:\n import threading\n\n\ndef sleep(seconds: float) -> None:\n \"\"\"\n Sleep strategy that delays execution for a given number of seconds.\n\n This is the default strategy, and may be mocked out for unit testing.\n \"\"\"\n time.sleep(seconds)\n\n\nclass sleep_using_event:\n \"\"\"Sleep strategy that waits on an event to be set.\"\"\"\n\n def __init__(self, event: \"threading.Event\") -> None:\n self.event = event\n\n def __call__(self, timeout: typing.Optional[float]) -> None:\n # NOTE(harlowja): this may *not* actually wait for timeout\n # seconds if the event is set (ie this may eject out early).\n self.event.wait(timeout=timeout)\n\n[end of tenacity/nap.py]","filename":"tenacity/nap.py","id":"15"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef after_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"After call strategy that does nothing.\"\"\"\n\n\ndef after_log(\n logger: \"logging.Logger\",\n log_level: int,\n sec_format: str = \"%0.3f\",\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"After call strategy that logs to some logger the finished attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n logger.log(\n log_level,\n f\"Finished call to '{fn_name}' \"\n f\"after {sec_format % retry_state.seconds_since_start}(s), \"\n f\"this was the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\",\n )\n\n return log_it\n\n[end of tenacity/after.py]","filename":"tenacity/after.py","id":"16"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport abc\nimport re\nimport typing\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass retry_base(abc.ABC):\n \"\"\"Abstract base class for retry strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n pass\n\n def __and__(self, other: \"retry_base\") -> \"retry_all\":\n return other.__rand__(self)\n\n def __rand__(self, other: \"retry_base\") -> \"retry_all\":\n return retry_all(other, self)\n\n def __or__(self, other: \"retry_base\") -> \"retry_any\":\n return other.__ror__(self)\n\n def __ror__(self, other: \"retry_base\") -> \"retry_any\":\n return retry_any(other, self)\n\n\nRetryBaseT = typing.Union[retry_base, typing.Callable[[\"RetryCallState\"], bool]]\n\n\nclass _retry_never(retry_base):\n \"\"\"Retry strategy that never rejects any result.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return False\n\n\nretry_never = _retry_never()\n\n\nclass _retry_always(retry_base):\n \"\"\"Retry strategy that always rejects any result.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return True\n\n\nretry_always = _retry_always()\n\n\nclass retry_if_exception(retry_base):\n \"\"\"Retry strategy that retries if an exception verifies a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[BaseException], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if retry_state.outcome.failed:\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n else:\n return False\n\n\nclass retry_if_exception_type(retry_if_exception):\n \"\"\"Retries if an exception has been raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: isinstance(e, exception_types))\n\n\nclass retry_if_not_exception_type(retry_if_exception):\n \"\"\"Retries except an exception has been raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: not isinstance(e, exception_types))\n\n\nclass retry_unless_exception_type(retry_if_exception):\n \"\"\"Retries until an exception is raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: not isinstance(e, exception_types))\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n # always retry if no exception was raised\n if not retry_state.outcome.failed:\n return True\n\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n\n\nclass retry_if_exception_cause_type(retry_base):\n \"\"\"Retries if any of the causes of the raised exception is of one or more types.\n\n The check on the type of the cause of the exception is done recursively (until finding\n an exception in the chain that has no `__cause__`)\n \"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_cause_types = exception_types\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__ called before outcome was set\")\n\n if retry_state.outcome.failed:\n exc = retry_state.outcome.exception()\n while exc is not None:\n if isinstance(exc.__cause__, self.exception_cause_types):\n return True\n exc = exc.__cause__\n\n return False\n\n\nclass retry_if_result(retry_base):\n \"\"\"Retries if the result verifies a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_if_not_result(retry_base):\n \"\"\"Retries if the result refutes a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return not self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_if_exception_message(retry_if_exception):\n \"\"\"Retries if an exception message equals or matches.\"\"\"\n\n def __init__(\n self,\n message: typing.Optional[str] = None,\n match: typing.Optional[str] = None,\n ) -> None:\n if message and match:\n raise TypeError(\n f\"{self.__class__.__name__}() takes either 'message' or 'match', not both\"\n )\n\n # set predicate\n if message:\n\n def message_fnc(exception: BaseException) -> bool:\n return message == str(exception)\n\n predicate = message_fnc\n elif match:\n prog = re.compile(match)\n\n def match_fnc(exception: BaseException) -> bool:\n return bool(prog.match(str(exception)))\n\n predicate = match_fnc\n else:\n raise TypeError(\n f\"{self.__class__.__name__}() missing 1 required argument 'message' or 'match'\"\n )\n\n super().__init__(predicate)\n\n\nclass retry_if_not_exception_message(retry_if_exception_message):\n \"\"\"Retries until an exception message equals or matches.\"\"\"\n\n def __init__(\n self,\n message: typing.Optional[str] = None,\n match: typing.Optional[str] = None,\n ) -> None:\n super().__init__(message, match)\n # invert predicate\n if_predicate = self.predicate\n self.predicate = lambda *args_, **kwargs_: not if_predicate(*args_, **kwargs_)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return True\n\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n\n\nclass retry_any(retry_base):\n \"\"\"Retries if any of the retries condition is valid.\"\"\"\n\n def __init__(self, *retries: retry_base) -> None:\n self.retries = retries\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return any(r(retry_state) for r in self.retries)\n\n\nclass retry_all(retry_base):\n \"\"\"Retries if all the retries condition are valid.\"\"\"\n\n def __init__(self, *retries: retry_base) -> None:\n self.retries = retries\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return all(r(retry_state) for r in self.retries)\n\n[end of tenacity/retry.py]","filename":"tenacity/retry.py","id":"17"},{"content":"[end of tenacity/py.typed]","filename":"tenacity/py.typed","id":"18"},{"content":"# Copyright 2017 Elisey Zanko\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport sys\nimport typing\n\nfrom tenacity import BaseRetrying\nfrom tenacity import DoAttempt\nfrom tenacity import DoSleep\nfrom tenacity import RetryCallState\n\nfrom tornado import gen\n\nif typing.TYPE_CHECKING:\n from tornado.concurrent import Future\n\n_RetValT = typing.TypeVar(\"_RetValT\")\n\n\nclass TornadoRetrying(BaseRetrying):\n def __init__(\n self,\n sleep: \"typing.Callable[[float], Future[None]]\" = gen.sleep,\n **kwargs: typing.Any,\n ) -> None:\n super().__init__(**kwargs)\n self.sleep = sleep\n\n @gen.coroutine # type: ignore[misc]\n def __call__(\n self,\n fn: \"typing.Callable[..., typing.Union[typing.Generator[typing.Any, typing.Any, _RetValT], Future[_RetValT]]]\",\n *args: typing.Any,\n **kwargs: typing.Any,\n ) -> \"typing.Generator[typing.Any, typing.Any, _RetValT]\":\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = yield fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n yield self.sleep(do)\n else:\n raise gen.Return(do)\n\n[end of tenacity/tornadoweb.py]","filename":"tenacity/tornadoweb.py","id":"19"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport functools\nimport inspect\nimport sys\nimport typing\nfrom datetime import timedelta\n\n\n# sys.maxsize:\n# An integer giving the maximum value a variable of type Py_ssize_t can take.\nMAX_WAIT = sys.maxsize / 2\n\n\ndef find_ordinal(pos_num: int) -> str:\n # See: https://en.wikipedia.org/wiki/English_numerals#Ordinal_numbers\n if pos_num == 0:\n return \"th\"\n elif pos_num == 1:\n return \"st\"\n elif pos_num == 2:\n return \"nd\"\n elif pos_num == 3:\n return \"rd\"\n elif 4 <= pos_num <= 20:\n return \"th\"\n else:\n return find_ordinal(pos_num % 10)\n\n\ndef to_ordinal(pos_num: int) -> str:\n return f\"{pos_num}{find_ordinal(pos_num)}\"\n\n\ndef get_callback_name(cb: typing.Callable[..., typing.Any]) -> str:\n \"\"\"Get a callback fully-qualified name.\n\n If no name can be produced ``repr(cb)`` is called and returned.\n \"\"\"\n segments = []\n try:\n segments.append(cb.__qualname__)\n except AttributeError:\n try:\n segments.append(cb.__name__)\n except AttributeError:\n pass\n if not segments:\n return repr(cb)\n else:\n try:\n # When running under sphinx it appears this can be none?\n if cb.__module__:\n segments.insert(0, cb.__module__)\n except AttributeError:\n pass\n return \".\".join(segments)\n\n\ntime_unit_type = typing.Union[int, float, timedelta]\n\n\ndef to_seconds(time_unit: time_unit_type) -> float:\n return float(\n time_unit.total_seconds() if isinstance(time_unit, timedelta) else time_unit\n )\n\n\ndef is_coroutine_callable(call: typing.Callable[..., typing.Any]) -> bool:\n if inspect.isclass(call):\n return False\n if inspect.iscoroutinefunction(call):\n return True\n partial_call = isinstance(call, functools.partial) and call.func\n dunder_call = partial_call or getattr(call, \"__call__\", None)\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef wrap_to_async_func(\n call: typing.Callable[..., typing.Any],\n) -> typing.Callable[..., typing.Awaitable[typing.Any]]:\n if is_coroutine_callable(call):\n return call\n\n async def inner(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:\n return call(*args, **kwargs)\n\n return inner\n\n[end of tenacity/_utils.py]","filename":"tenacity/_utils.py","id":"20"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport functools\nimport sys\nimport typing as t\n\nimport tenacity\nfrom tenacity import AttemptManager\nfrom tenacity import BaseRetrying\nfrom tenacity import DoAttempt\nfrom tenacity import DoSleep\nfrom tenacity import RetryCallState\nfrom tenacity import RetryError\nfrom tenacity import after_nothing\nfrom tenacity import before_nothing\nfrom tenacity import _utils\n\n# Import all built-in retry strategies for easier usage.\nfrom .retry import RetryBaseT\nfrom .retry import retry_all # noqa\nfrom .retry import retry_any # noqa\nfrom .retry import retry_if_exception # noqa\nfrom .retry import retry_if_result # noqa\nfrom ..retry import RetryBaseT as SyncRetryBaseT\n\nif t.TYPE_CHECKING:\n from tenacity.stop import StopBaseT\n from tenacity.wait import WaitBaseT\n\nWrappedFnReturnT = t.TypeVar(\"WrappedFnReturnT\")\nWrappedFn = t.TypeVar(\"WrappedFn\", bound=t.Callable[..., t.Awaitable[t.Any]])\n\n\ndef _portable_async_sleep(seconds: float) -> t.Awaitable[None]:\n # If trio is already imported, then importing it is cheap.\n # If trio isn't already imported, then it's definitely not running, so we\n # can skip further checks.\n if \"trio\" in sys.modules:\n # If trio is available, then sniffio is too\n import trio\n import sniffio\n\n if sniffio.current_async_library() == \"trio\":\n return trio.sleep(seconds)\n # Otherwise, assume asyncio\n # Lazy import asyncio as it's expensive (responsible for 25-50% of total import overhead).\n import asyncio\n\n return asyncio.sleep(seconds)\n\n\nclass AsyncRetrying(BaseRetrying):\n def __init__(\n self,\n sleep: t.Callable[\n [t.Union[int, float]], t.Union[None, t.Awaitable[None]]\n ] = _portable_async_sleep,\n stop: \"StopBaseT\" = tenacity.stop.stop_never,\n wait: \"WaitBaseT\" = tenacity.wait.wait_none(),\n retry: \"t.Union[SyncRetryBaseT, RetryBaseT]\" = tenacity.retry_if_exception_type(),\n before: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = before_nothing,\n after: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = after_nothing,\n before_sleep: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[None, t.Awaitable[None]]]\n ] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[\"RetryError\"] = RetryError,\n retry_error_callback: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[t.Any, t.Awaitable[t.Any]]]\n ] = None,\n ) -> None:\n super().__init__(\n sleep=sleep, # type: ignore[arg-type]\n stop=stop,\n wait=wait,\n retry=retry, # type: ignore[arg-type]\n before=before, # type: ignore[arg-type]\n after=after, # type: ignore[arg-type]\n before_sleep=before_sleep, # type: ignore[arg-type]\n reraise=reraise,\n retry_error_cls=retry_error_cls,\n retry_error_callback=retry_error_callback,\n )\n\n async def __call__( # type: ignore[override]\n self, fn: WrappedFn, *args: t.Any, **kwargs: t.Any\n ) -> WrappedFnReturnT:\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = await self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = await fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n await self.sleep(do) # type: ignore[misc]\n else:\n return do # type: ignore[no-any-return]\n\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\n self.iter_state.actions.append(_utils.wrap_to_async_func(fn))\n\n async def _run_retry(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n self.iter_state.retry_run_result = await _utils.wrap_to_async_func(self.retry)(\n retry_state\n )\n\n async def _run_wait(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n if self.wait:\n sleep = await _utils.wrap_to_async_func(self.wait)(retry_state)\n else:\n sleep = 0.0\n\n retry_state.upcoming_sleep = sleep\n\n async def _run_stop(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n self.statistics[\"delay_since_first_attempt\"] = retry_state.seconds_since_start\n self.iter_state.stop_run_result = await _utils.wrap_to_async_func(self.stop)(\n retry_state\n )\n\n async def iter(\n self, retry_state: \"RetryCallState\"\n ) -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa: A003\n self._begin_iter(retry_state)\n result = None\n for action in self.iter_state.actions:\n result = await action(retry_state)\n return result\n\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\n raise TypeError(\"AsyncRetrying object is not iterable\")\n\n def __aiter__(self) -> \"AsyncRetrying\":\n self.begin()\n self._retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\n return self\n\n async def __anext__(self) -> AttemptManager:\n while True:\n do = await self.iter(retry_state=self._retry_state)\n if do is None:\n raise StopAsyncIteration\n elif isinstance(do, DoAttempt):\n return AttemptManager(retry_state=self._retry_state)\n elif isinstance(do, DoSleep):\n self._retry_state.prepare_for_next_attempt()\n await self.sleep(do) # type: ignore[misc]\n else:\n raise StopAsyncIteration\n\n def wraps(self, fn: WrappedFn) -> WrappedFn:\n wrapped = super().wraps(fn)\n # Ensure wrapper is recognized as a coroutine function.\n\n @functools.wraps(\n fn, functools.WRAPPER_ASSIGNMENTS + (\"__defaults__\", \"__kwdefaults__\")\n )\n async def async_wrapped(*args: t.Any, **kwargs: t.Any) -> t.Any:\n # Always create a copy to prevent overwriting the local contexts when\n # calling the same wrapped functions multiple times in the same stack\n copy = self.copy()\n async_wrapped.statistics = copy.statistics # type: ignore[attr-defined]\n return await copy(fn, *args, **kwargs)\n\n # Preserve attributes\n async_wrapped.retry = self # type: ignore[attr-defined]\n async_wrapped.retry_with = wrapped.retry_with # type: ignore[attr-defined]\n async_wrapped.statistics = {} # type: ignore[attr-defined]\n\n return async_wrapped # type: ignore[return-value]\n\n\n__all__ = [\n \"retry_all\",\n \"retry_any\",\n \"retry_if_exception\",\n \"retry_if_result\",\n \"WrappedFn\",\n \"AsyncRetrying\",\n]\n\n[end of tenacity/asyncio/__init__.py]","filename":"tenacity/asyncio/__init__.py","id":"21"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport abc\nimport typing\n\nfrom tenacity import _utils\nfrom tenacity import retry_base\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass async_retry_base(retry_base):\n \"\"\"Abstract base class for async retry strategies.\"\"\"\n\n @abc.abstractmethod\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n pass\n\n def __and__( # type: ignore[override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_all\":\n return retry_all(self, other)\n\n def __rand__( # type: ignore[misc,override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_all\":\n return retry_all(other, self)\n\n def __or__( # type: ignore[override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_any\":\n return retry_any(self, other)\n\n def __ror__( # type: ignore[misc,override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_any\":\n return retry_any(other, self)\n\n\nRetryBaseT = typing.Union[\n async_retry_base, typing.Callable[[\"RetryCallState\"], typing.Awaitable[bool]]\n]\n\n\nclass retry_if_exception(async_retry_base):\n \"\"\"Retry strategy that retries if an exception verifies a predicate.\"\"\"\n\n def __init__(\n self, predicate: typing.Callable[[BaseException], typing.Awaitable[bool]]\n ) -> None:\n self.predicate = predicate\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if retry_state.outcome.failed:\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return await self.predicate(exception)\n else:\n return False\n\n\nclass retry_if_result(async_retry_base):\n \"\"\"Retries if the result verifies a predicate.\"\"\"\n\n def __init__(\n self, predicate: typing.Callable[[typing.Any], typing.Awaitable[bool]]\n ) -> None:\n self.predicate = predicate\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return await self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_any(async_retry_base):\n \"\"\"Retries if any of the retries condition is valid.\"\"\"\n\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\n self.retries = retries\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n result = False\n for r in self.retries:\n result = result or await _utils.wrap_to_async_func(r)(retry_state)\n if result:\n break\n return result\n\n\nclass retry_all(async_retry_base):\n \"\"\"Retries if all the retries condition are valid.\"\"\"\n\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\n self.retries = retries\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n result = True\n for r in self.retries:\n result = result and await _utils.wrap_to_async_func(r)(retry_state)\n if not result:\n break\n return result\n\n[end of tenacity/asyncio/retry.py]","filename":"tenacity/asyncio/retry.py","id":"22"},{"content":"Tenacity\n========\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\n :target: https://pypi.python.org/pypi/tenacity\n\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\n :target: https://circleci.com/gh/jd/tenacity\n\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\n :target: https://mergify.io\n :alt: Mergify Status\n\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\n\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\nPython, to simplify the task of adding retry behavior to just about anything.\nIt originates from `a fork of retrying\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\napi compatible with retrying but adds significant new functionality and\nfixes a number of longstanding bugs.\n\nThe simplest use case is retrying a flaky function whenever an `Exception`\noccurs until a value is returned.\n\n.. testcode::\n\n import random\n from tenacity import retry\n\n @retry\n def do_something_unreliable():\n if random.randint(0, 10) > 1:\n raise IOError(\"Broken sauce, everything is hosed!!!111one\")\n else:\n return \"Awesome sauce!\"\n\n print(do_something_unreliable())\n\n.. testoutput::\n :hide:\n\n Awesome sauce!\n\n\n.. toctree::\n :hidden:\n :maxdepth: 2\n\n changelog\n api\n\n\nFeatures\n--------\n\n- Generic Decorator API\n- Specify stop condition (i.e. limit by number of attempts)\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\n- Customize retrying on Exceptions\n- Customize retrying on expected returned result\n- Retry on coroutines\n- Retry code block with context manager\n\n\nInstallation\n------------\n\nTo install *tenacity*, simply:\n\n.. code-block:: bash\n\n $ pip install tenacity\n\n\nExamples\n----------\n\nBasic Retry\n~~~~~~~~~~~\n\n.. testsetup::\n\n import logging\n #\n # Note the following import is used for demonstration convenience only.\n # Production code should always explicitly import the names it needs.\n #\n from tenacity import *\n\n class MyException(Exception):\n pass\n\nAs you saw above, the default behavior is to retry forever without waiting when\nan exception is raised.\n\n.. testcode::\n\n @retry\n def never_gonna_give_you_up():\n print(\"Retry forever ignoring Exceptions, don't wait between retries\")\n raise Exception\n\nStopping\n~~~~~~~~\n\nLet's be a little less persistent and set some boundaries, such as the number\nof attempts before giving up.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(7))\n def stop_after_7_attempts():\n print(\"Stopping after 7 attempts\")\n raise Exception\n\nWe don't have all day, so let's set a boundary for how long we should be\nretrying stuff.\n\n.. testcode::\n\n @retry(stop=stop_after_delay(10))\n def stop_after_10_s():\n print(\"Stopping after 10 seconds\")\n raise Exception\n\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\nthen you can give up on retries one attempt before you would exceed the delay.\n\n.. testcode::\n\n @retry(stop=stop_before_delay(10))\n def stop_before_10_s():\n print(\"Stopping 1 attempt before 10 seconds\")\n raise Exception\n\nYou can combine several stop conditions by using the `|` operator:\n\n.. testcode::\n\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\n def stop_after_10_s_or_5_retries():\n print(\"Stopping after 10 seconds or 5 retries\")\n raise Exception\n\nWaiting before retrying\n~~~~~~~~~~~~~~~~~~~~~~~\n\nMost things don't like to be polled as fast as possible, so let's just wait 2\nseconds between retries.\n\n.. testcode::\n\n @retry(wait=wait_fixed(2))\n def wait_2_s():\n print(\"Wait 2 second between retries\")\n raise Exception\n\nSome things perform best with a bit of randomness injected.\n\n.. testcode::\n\n @retry(wait=wait_random(min=1, max=2))\n def wait_random_1_to_2_s():\n print(\"Randomly wait 1 to 2 seconds between retries\")\n raise Exception\n\nThen again, it's hard to beat exponential backoff when retrying distributed\nservices and other remote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\n def wait_exponential_1():\n print(\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\")\n raise Exception\n\n\nThen again, it's also hard to beat combining fixed waits and jitter (to\nhelp avoid thundering herds) when retrying distributed services and other\nremote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\n def wait_fixed_jitter():\n print(\"Wait at least 3 seconds, and add up to 2 seconds of random delay\")\n raise Exception\n\nWhen multiple processes are in contention for a shared resource, exponentially\nincreasing jitter helps minimise collisions.\n\n.. testcode::\n\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\n def wait_exponential_jitter():\n print(\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\")\n raise Exception\n\n\nSometimes it's necessary to build a chain of backoffs.\n\n.. testcode::\n\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\n [wait_fixed(7) for i in range(2)] +\n [wait_fixed(9)]))\n def wait_fixed_chained():\n print(\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\")\n raise Exception\n\nWhether to retry\n~~~~~~~~~~~~~~~~\n\nWe have a few options for dealing with retries that raise specific or general\nexceptions, as in the cases here.\n\n.. testcode::\n\n class ClientError(Exception):\n \"\"\"Some type of client error.\"\"\"\n\n @retry(retry=retry_if_exception_type(IOError))\n def might_io_error():\n print(\"Retry forever with no wait if an IOError occurs, raise any other errors\")\n raise Exception\n\n @retry(retry=retry_if_not_exception_type(ClientError))\n def might_client_error():\n print(\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\")\n raise Exception\n\nWe can also use the result of the function to alter the behavior of retrying.\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=retry_if_result(is_none_p))\n def might_return_none():\n print(\"Retry with no wait if return value is None\")\n\nSee also these methods:\n\n.. testcode::\n\n retry_if_exception\n retry_if_exception_type\n retry_if_not_exception_type\n retry_unless_exception_type\n retry_if_result\n retry_if_not_result\n retry_if_exception_message\n retry_if_not_exception_message\n retry_any\n retry_all\n\nWe can also combine several conditions:\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\n def might_return_none():\n print(\"Retry forever ignoring Exceptions with no wait if return value is None\")\n\nAny combination of stop, wait, etc. is also supported to give you the freedom\nto mix and match.\n\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\nexception:\n\n.. testcode::\n\n @retry\n def do_something():\n result = something_else()\n if result == 23:\n raise TryAgain\n\nError Handling\n~~~~~~~~~~~~~~\n\nNormally when your function fails its final time (and will not be retried again based on your settings),\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\nof the stack trace.\n\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\nis most visible), you can set `reraise=True`.\n\n.. testcode::\n\n @retry(reraise=True, stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except MyException:\n # timed out retrying\n pass\n\nBefore and After Retry, and Logging\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIt's possible to execute an action before any attempt of calling the function\nby using the before callback function:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIn the same spirit, It's possible to execute after a call that failed:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIt's also possible to only log failures that are going to be retried. Normally\nretries happen after a wait interval, so the keyword argument is called\n``before_sleep``:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3),\n before_sleep=before_sleep_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n\nStatistics\n~~~~~~~~~~\n\nYou can access the statistics about the retry made over a function by using the\n`statistics` attribute attached to the function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nCustom Callbacks\n~~~~~~~~~~~~~~~~\n\nYou can also define your own callbacks. The callback should accept one\nparameter called ``retry_state`` that contains all information about current\nretry invocation.\n\nFor example, you can call a custom callback function after all retries failed,\nwithout raising an exception (or you can re-raise or do anything really)\n\n.. testcode::\n\n def return_last_value(retry_state):\n \"\"\"return the result of the last call attempt\"\"\"\n return retry_state.outcome.result()\n\n def is_false(value):\n \"\"\"Return True if value is False\"\"\"\n return value is False\n\n # will return False after trying 3 times to get a different result\n @retry(stop=stop_after_attempt(3),\n retry_error_callback=return_last_value,\n retry=retry_if_result(is_false))\n def eventually_return_false():\n return False\n\nRetryCallState\n~~~~~~~~~~~~~~\n\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\n\nOther Custom Callbacks\n~~~~~~~~~~~~~~~~~~~~~~\n\nIt's also possible to define custom callbacks for other keyword arguments.\n\n.. function:: my_stop(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should stop\n :rtype: bool\n\n.. function:: my_wait(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: number of seconds to wait before next retry\n :rtype: float\n\n.. function:: my_retry(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should continue\n :rtype: bool\n\n.. function:: my_before(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_after(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_before_sleep(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\nHere's an example with a custom ``before_sleep`` function:\n\n.. testcode::\n\n import logging\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n def my_before_sleep(retry_state):\n if retry_state.attempt_number < 1:\n loglevel = logging.INFO\n else:\n loglevel = logging.WARNING\n logger.log(\n loglevel, 'Retrying %s: attempt %s ended with: %s',\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\n\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except RetryError:\n pass\n\n\nChanging Arguments at Run Time\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can change the arguments of a retry decorator as needed when calling it by\nusing the `retry_with` function attached to the wrapped function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nIf you want to use variables to set up the retry parameters, you don't have\nto use the `retry` decorator - you can instead use `Retrying` directly:\n\n.. testcode::\n\n def never_good_enough(arg1):\n raise Exception('Invalid argument: {}'.format(arg1))\n\n def try_never_good_enough(max_attempts=3):\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\n retryer(never_good_enough, 'I really do try')\n\nYou may also want to change the behaviour of a decorated function temporarily,\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\nattribute attached to the function. Bear in mind this is a write-only attribute,\nstatistics should be read from the function `statistics` attribute.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n from unittest import mock\n\n with mock.patch.object(raise_my_exception.retry, \"wait\", wait_fixed(0)):\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nRetrying code block\n~~~~~~~~~~~~~~~~~~~\n\nTenacity allows you to retry a code block without the need to wraps it in an\nisolated function. This makes it easy to isolate failing block while sharing\ncontext. The trick is to combine a for loop and a context manager.\n\n.. testcode::\n\n from tenacity import Retrying, RetryError, stop_after_attempt\n\n try:\n for attempt in Retrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nYou can configure every details of retry policy by configuring the Retrying\nobject.\n\nWith async code you can use AsyncRetrying.\n\n.. testcode::\n\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\n\n async def function():\n try:\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nIn both cases, you may want to set the result to the attempt so it's available\nin retry strategies like ``retry_if_result``. This can be done accessing the\n``retry_state`` property:\n\n.. testcode::\n\n from tenacity import AsyncRetrying, retry_if_result\n\n async def function():\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\n with attempt:\n result = 1 # Some complex calculation, function call, etc.\n if not attempt.retry_state.outcome.failed:\n attempt.retry_state.set_result(result)\n return result\n\nAsync and retry\n~~~~~~~~~~~~~~~\n\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\nSleeps are done asynchronously too.\n\n.. code-block:: python\n\n @retry\n async def my_asyncio_function(loop):\n await loop.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n async def my_async_trio_function():\n await trio.socket.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n @tornado.gen.coroutine\n def my_async_tornado_function(http_client, url):\n yield http_client.fetch(url)\n\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\n\n.. code-block:: python\n\n @retry(sleep=curio.sleep)\n async def my_async_curio_function():\n await asks.get('https://example.org')\n\nContribute\n----------\n\n#. Check for open issues or open a fresh issue to start a discussion around a\n feature idea or a bug.\n#. Fork `the repository`_ on GitHub to start making your changes to the\n **main** branch (or branch off of it).\n#. Write a test which shows that the bug was fixed or that the feature works as\n expected.\n#. Add a `changelog <#Changelogs>`_\n#. Make the docs better (or more detailed, or more easier to read, or ...)\n\n.. _`the repository`: https://github.com/jd/tenacity\n\nChangelogs\n~~~~~~~~~~\n\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\n\nThe doc generation will automatically compile the changelogs. You just need to add them.\n\n.. code-block:: sh\n\n # Opens a template file in an editor\n tox -e reno -- new some-slug-for-my-change --edit\n\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\n\n[end of doc/source/index.rst]","filename":"doc/source/index.rst","id":"23"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport os\nimport sys\n\nmaster_doc = \"index\"\nproject = \"Tenacity\"\n\n# Add tenacity to the path, so sphinx can find the functions for autodoc.\nsys.path.insert(0, os.path.abspath(\"../..\"))\n\nextensions = [\n \"sphinx.ext.doctest\",\n \"sphinx.ext.autodoc\",\n \"reno.sphinxext\",\n]\n\n# -- Options for sphinx.ext.doctest -----------------------------------------\n\n# doctest_default_flags =\ncwd = os.path.abspath(os.path.dirname(__file__))\ntenacity_path = os.path.join(cwd, os.pardir, os.pardir)\ndoctest_path = [tenacity_path]\n# doctest_global_setup =\n# doctest_global_cleanup =\n# doctest_test_doctest_blocks =\n\n[end of doc/source/conf.py]","filename":"doc/source/conf.py","id":"24"},{"content":"Changelog\n=========\n\n.. release-notes::\n\n[end of doc/source/changelog.rst]","filename":"doc/source/changelog.rst","id":"25"},{"content":"===============\n API Reference\n===============\n\nRetry Main API\n--------------\n\n.. autofunction:: tenacity.retry\n :noindex:\n\n.. autoclass:: tenacity.Retrying\n :members:\n\n.. autoclass:: tenacity.AsyncRetrying\n :members:\n\n.. autoclass:: tenacity.tornadoweb.TornadoRetrying\n :members:\n\n.. autoclass:: tenacity.RetryCallState\n :members:\n\nAfter Functions\n---------------\n\nThose functions can be used as the `after` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.after\n :members:\n\nBefore Functions\n----------------\n\nThose functions can be used as the `before` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.before\n :members:\n\nBefore Sleep Functions\n----------------------\n\nThose functions can be used as the `before_sleep` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.before_sleep\n :members:\n\nNap Functions\n-------------\n\nThose functions can be used as the `sleep` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.nap\n :members:\n\nRetry Functions\n---------------\n\nThose functions can be used as the `retry` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.retry\n :members:\n\nStop Functions\n--------------\n\nThose functions can be used as the `stop` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.stop\n :members:\n\nWait Functions\n--------------\n\nThose functions can be used as the `wait` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.wait\n :members:\n\n[end of doc/source/api.rst]","filename":"doc/source/api.rst","id":"26"},{"content":"---\nupgrade:\n - |\n Support for Python 3.6 has been removed.\n\n[end of releasenotes/notes/remove-py36-876c0416cf279d15.yaml]","filename":"releasenotes/notes/remove-py36-876c0416cf279d15.yaml","id":"27"},{"content":"---\nfixes:\n - |\n Fix async loop with retrying code block when result is available.\n\n[end of releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml]","filename":"releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml","id":"28"},{"content":"---\nupgrade:\n - \"Removed `BaseRetrying.call`: was long time deprecated and produced `DeprecationWarning`\"\n - \"Removed `BaseRetrying.fn`: was noted as deprecated\"\n - \"API change: `BaseRetrying.begin()` do not require arguments anymore as it not setting `BaseRetrying.fn`\"\n\n[end of releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml]","filename":"releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml","id":"29"},{"content":"---\nfixes:\n - Fix setuptools config to include tenacity.asyncio package in release distributions.\n\n[end of releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml]","filename":"releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml","id":"30"},{"content":"---\nother:\n - Add a \\\"test\\\" extra\n\n[end of releasenotes/notes/add-test-extra-55e869261b03e56d.yaml]","filename":"releasenotes/notes/add-test-extra-55e869261b03e56d.yaml","id":"31"},{"content":"---\nfixes:\n - |\n Use str.format to format the logs internally to make logging compatible with other logger such as loguru.\n\n[end of releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml]","filename":"releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml","id":"32"},{"content":"---\nother:\n - Unit tests can now mock ``nap.sleep()`` for testing in all tenacity usage styles\n[end of releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml]","filename":"releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml","id":"33"},{"content":"---\nfixes:\n - \"Fix after_log logger format: function name was used with delay formatting.\"\n\n[end of releasenotes/notes/after_log-50f4d73b24ce9203.yaml]","filename":"releasenotes/notes/after_log-50f4d73b24ce9203.yaml","id":"34"},{"content":"---\nother:\n - \"Use `black` for code formatting and validate using `black --check`. Code compatibility: py26-py39.\"\n - \"Enforce maximal line length to 120 symbols\"\n\n[end of releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml]","filename":"releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml","id":"35"},{"content":"---\nfixes:\n - |\n Preserve __defaults__ and __kwdefaults__ through retry decorator\n\n[end of releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml]","filename":"releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml","id":"36"},{"content":"---\nfeatures:\n - Add ``retry_if_not_exception_type()`` that allows to retry if a raised exception doesn't match given exceptions.\n\n[end of releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml]","filename":"releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml","id":"37"},{"content":"---\nfixes:\n - |\n Argument `wait` was improperly annotated, making mypy checks fail.\n Now it's annotated as `typing.Union[wait_base, typing.Callable[[\"RetryCallState\"], typing.Union[float, int]]]`\n\n[end of releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml]","filename":"releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml","id":"38"},{"content":"---\nfeatures:\n - Explicitly export convenience symbols from tenacity root module\n\n[end of releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml]","filename":"releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml","id":"39"},{"content":"---\nfeatures:\n - Add ``datetime.timedelta`` as accepted wait unit type.\n\n[end of releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml]","filename":"releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml","id":"40"},{"content":"---\nother:\n - |\n Add a Dependabot configuration submit PRs monthly (as needed)\n to keep GitHub action versions updated.\n\n[end of releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml]","filename":"releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml","id":"41"},{"content":"---\nfeatures:\n - |\n Add a new `retry_base` class called `retry_if_exception_cause_type` that\n checks, recursively, if any of the causes of the raised exception is of a certain type.\n\n[end of releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml]","filename":"releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml","id":"42"},{"content":"---\nfeatures:\n - |\n Added the ability to use async functions for retries. This way, you can now use\n asyncio coroutines for retry strategy predicates.\n\n[end of releasenotes/notes/add-async-actions-b249c527d99723bb.yaml]","filename":"releasenotes/notes/add-async-actions-b249c527d99723bb.yaml","id":"43"},{"content":"---\nprelude: >\n Clarify usage of `reraise` keyword argument\n\n[end of releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml]","filename":"releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml","id":"44"},{"content":"---\nfixes: Sphinx build error where Sphinx complains about an undefined class.\n\n[end of releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml]","filename":"releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml","id":"45"},{"content":"---\nfeatures:\n - Add reno (changelog system)\n\n[end of releasenotes/notes/add-reno-d1ab5710f272650a.yaml]","filename":"releasenotes/notes/add-reno-d1ab5710f272650a.yaml","id":"46"},{"content":"---\nfixes:\n - |\n Avoid overwriting local contexts when applying the retry decorator.\n\n[end of releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml]","filename":"releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml","id":"47"},{"content":"---\nfeatures:\n - Most part of the code is type annotated.\n - Python 3.10 support has been added.\n\n[end of releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml]","filename":"releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml","id":"48"},{"content":"---\nother:\n - Add type annotations to cover all public API.\n\n[end of releasenotes/notes/annotate_code-197b93130df14042.yaml]","filename":"releasenotes/notes/annotate_code-197b93130df14042.yaml","id":"49"},{"content":"---\nfixes:\n - |\n `AsyncRetrying` was erroneously implementing `__iter__()`, making tenacity\n retrying mechanism working but in a synchronous fashion and not waiting as\n expected. This interface has been removed, `__aiter__()` should be used\n instead.\n\n[end of releasenotes/notes/no-async-iter-6132a42e52348a75.yaml]","filename":"releasenotes/notes/no-async-iter-6132a42e52348a75.yaml","id":"50"},{"content":"---\nfeatures:\n - |\n Added a new stop function: stop_before_delay, which will stop execution\n if the next sleep time would cause overall delay to exceed the specified delay. \n Useful for use cases where you have some upper bound on retry times that you must\n not exceed, so returning before that timeout is preferable than returning after that timeout.\n[end of releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml]","filename":"releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml","id":"51"},{"content":"---\nfeatures:\n - |\n If you're using `Trio <https://trio.readthedocs.io>`__, then\n ``@retry`` now works automatically. It's no longer necessary to\n pass ``sleep=trio.sleep``.\n\n[end of releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml]","filename":"releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml","id":"52"},{"content":"---\nother: >-\n Corrected the PyPI-published wheel tag to match the\n metadata saying that the release is Python 3 only.\n...\n\n[end of releasenotes/notes/pr320-py3-only-wheel-tag.yaml]","filename":"releasenotes/notes/pr320-py3-only-wheel-tag.yaml","id":"53"},{"content":"---\nfeatures:\n - |\n - accept ``datetime.timedelta`` instances as argument to ``tenacity.stop.stop_after_delay``\n\n[end of releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml]","filename":"releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml","id":"54"},{"content":"---\nfixes:\n - |\n Restore the value of the `retry` attribute for wrapped functions. Also,\n clarify that those attributes are write-only and statistics should be\n read from the function attribute directly.\n\n[end of releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml]","filename":"releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml","id":"55"},{"content":"---\nfixes:\n - \"Fix issue #288 : __name__ and other attributes for async functions\"\n\n[end of releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml]","filename":"releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml","id":"56"},{"content":"---\nother:\n - |\n Added a link to the documentation, as code snippets are not being rendered properly\n Changed branch name to main in index.rst\n\n[end of releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml]","filename":"releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml","id":"57"},{"content":"---\nfixes:\n - |\n Respects `min` arg for `wait_random_exponential`\n\n[end of releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml]","filename":"releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml","id":"58"},{"content":"---\nfeatures:\n - Add a ``__repr__`` method to ``RetryCallState`` objects for easier debugging.\n\n[end of releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml]","filename":"releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml","id":"59"},{"content":"---\nother:\n - |\n Drop support for deprecated Python versions (2.7 and 3.5)\n\n[end of releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml]","filename":"releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml","id":"60"},{"content":"---\nfeatures:\n - Add an ``exc_info`` option to the ``before_sleep_log()`` strategy.\n[end of releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml]","filename":"releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml","id":"61"},{"content":"---\nother:\n - Add `retry_if_exception_cause_type`and `wait_exponential_jitter` to __all__ of init.py\n[end of releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml]","filename":"releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml","id":"62"},{"content":"---\nfeatures:\n - |\n Implement a wait.wait_exponential_jitter per Google's storage retry guide.\n See https://cloud.google.com/storage/docs/retry-strategy\n\n[end of releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml]","filename":"releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml","id":"63"}],"string":"[\n {\n \"content\": \"queue_rules:\\n - name: default\\n merge_method: squash\\n queue_conditions:\\n - or:\\n - author = jd\\n - \\\"#approved-reviews-by >= 1\\\"\\n - author = dependabot[bot]\\n - or:\\n - files ~= ^releasenotes/notes/\\n - label = no-changelog\\n - author = dependabot[bot]\\n - \\\"check-success=test (3.9, py39)\\\"\\n - \\\"check-success=test (3.10, py310)\\\"\\n - \\\"check-success=test (3.11, py311)\\\"\\n - \\\"check-success=test (3.12, py312)\\\"\\n - \\\"check-success=test (3.13, py313,py313-trio)\\\"\\n - \\\"check-success=test (3.12, pep8)\\\"\\n\\npull_request_rules:\\n - name: warn on no changelog\\n conditions:\\n - -files~=^releasenotes/notes/\\n - label!=no-changelog\\n - -closed\\n actions:\\n comment:\\n message: >\\n ⚠️ No release notes detected. Please make sure to use\\n [reno](https://docs.openstack.org/reno/latest/user/usage.html) to add\\n a changelog entry.\\n\\n - name: automatic queue\\n conditions: []\\n actions:\\n queue:\\n\\n - name: dismiss reviews\\n conditions: []\\n actions:\\n dismiss_reviews: {}\\n\\n[end of .mergify.yml]\",\n \"filename\": \".mergify.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"---\\nunreleased_version_title: Unreleased\\n\\n[end of reno.yaml]\",\n \"filename\": \"reno.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"Apache License\\n Version 2.0, January 2004\\n http://www.apache.org/licenses/\\n\\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\\n\\n 1. Definitions.\\n\\n \\\"License\\\" shall mean the terms and conditions for use, reproduction,\\n and distribution as defined by Sections 1 through 9 of this document.\\n\\n \\\"Licensor\\\" shall mean the copyright owner or entity authorized by\\n the copyright owner that is granting the License.\\n\\n \\\"Legal Entity\\\" shall mean the union of the acting entity and all\\n other entities that control, are controlled by, or are under common\\n control with that entity. For the purposes of this definition,\\n \\\"control\\\" means (i) the power, direct or indirect, to cause the\\n direction or management of such entity, whether by contract or\\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\\n outstanding shares, or (iii) beneficial ownership of such entity.\\n\\n \\\"You\\\" (or \\\"Your\\\") shall mean an individual or Legal Entity\\n exercising permissions granted by this License.\\n\\n \\\"Source\\\" form shall mean the preferred form for making modifications,\\n including but not limited to software source code, documentation\\n source, and configuration files.\\n\\n \\\"Object\\\" form shall mean any form resulting from mechanical\\n transformation or translation of a Source form, including but\\n not limited to compiled object code, generated documentation,\\n and conversions to other media types.\\n\\n \\\"Work\\\" shall mean the work of authorship, whether in Source or\\n Object form, made available under the License, as indicated by a\\n copyright notice that is included in or attached to the work\\n (an example is provided in the Appendix below).\\n\\n \\\"Derivative Works\\\" shall mean any work, whether in Source or Object\\n form, that is based on (or derived from) the Work and for which the\\n editorial revisions, annotations, elaborations, or other modifications\\n represent, as a whole, an original work of authorship. For the purposes\\n of this License, Derivative Works shall not include works that remain\\n separable from, or merely link (or bind by name) to the interfaces of,\\n the Work and Derivative Works thereof.\\n\\n \\\"Contribution\\\" shall mean any work of authorship, including\\n the original version of the Work and any modifications or additions\\n to that Work or Derivative Works thereof, that is intentionally\\n submitted to Licensor for inclusion in the Work by the copyright owner\\n or by an individual or Legal Entity authorized to submit on behalf of\\n the copyright owner. For the purposes of this definition, \\\"submitted\\\"\\n means any form of electronic, verbal, or written communication sent\\n to the Licensor or its representatives, including but not limited to\\n communication on electronic mailing lists, source code control systems,\\n and issue tracking systems that are managed by, or on behalf of, the\\n Licensor for the purpose of discussing and improving the Work, but\\n excluding communication that is conspicuously marked or otherwise\\n designated in writing by the copyright owner as \\\"Not a Contribution.\\\"\\n\\n \\\"Contributor\\\" shall mean Licensor and any individual or Legal Entity\\n on behalf of whom a Contribution has been received by Licensor and\\n subsequently incorporated within the Work.\\n\\n 2. Grant of Copyright License. Subject to the terms and conditions of\\n this License, each Contributor hereby grants to You a perpetual,\\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\\n copyright license to reproduce, prepare Derivative Works of,\\n publicly display, publicly perform, sublicense, and distribute the\\n Work and such Derivative Works in Source or Object form.\\n\\n 3. Grant of Patent License. Subject to the terms and conditions of\\n this License, each Contributor hereby grants to You a perpetual,\\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\\n (except as stated in this section) patent license to make, have made,\\n use, offer to sell, sell, import, and otherwise transfer the Work,\\n where such license applies only to those patent claims licensable\\n by such Contributor that are necessarily infringed by their\\n Contribution(s) alone or by combination of their Contribution(s)\\n with the Work to which such Contribution(s) was submitted. If You\\n institute patent litigation against any entity (including a\\n cross-claim or counterclaim in a lawsuit) alleging that the Work\\n or a Contribution incorporated within the Work constitutes direct\\n or contributory patent infringement, then any patent licenses\\n granted to You under this License for that Work shall terminate\\n as of the date such litigation is filed.\\n\\n 4. Redistribution. You may reproduce and distribute copies of the\\n Work or Derivative Works thereof in any medium, with or without\\n modifications, and in Source or Object form, provided that You\\n meet the following conditions:\\n\\n (a) You must give any other recipients of the Work or\\n Derivative Works a copy of this License; and\\n\\n (b) You must cause any modified files to carry prominent notices\\n stating that You changed the files; and\\n\\n (c) You must retain, in the Source form of any Derivative Works\\n that You distribute, all copyright, patent, trademark, and\\n attribution notices from the Source form of the Work,\\n excluding those notices that do not pertain to any part of\\n the Derivative Works; and\\n\\n (d) If the Work includes a \\\"NOTICE\\\" text file as part of its\\n distribution, then any Derivative Works that You distribute must\\n include a readable copy of the attribution notices contained\\n within such NOTICE file, excluding those notices that do not\\n pertain to any part of the Derivative Works, in at least one\\n of the following places: within a NOTICE text file distributed\\n as part of the Derivative Works; within the Source form or\\n documentation, if provided along with the Derivative Works; or,\\n within a display generated by the Derivative Works, if and\\n wherever such third-party notices normally appear. The contents\\n of the NOTICE file are for informational purposes only and\\n do not modify the License. You may add Your own attribution\\n notices within Derivative Works that You distribute, alongside\\n or as an addendum to the NOTICE text from the Work, provided\\n that such additional attribution notices cannot be construed\\n as modifying the License.\\n\\n You may add Your own copyright statement to Your modifications and\\n may provide additional or different license terms and conditions\\n for use, reproduction, or distribution of Your modifications, or\\n for any such Derivative Works as a whole, provided Your use,\\n reproduction, and distribution of the Work otherwise complies with\\n the conditions stated in this License.\\n\\n 5. Submission of Contributions. Unless You explicitly state otherwise,\\n any Contribution intentionally submitted for inclusion in the Work\\n by You to the Licensor shall be under the terms and conditions of\\n this License, without any additional terms or conditions.\\n Notwithstanding the above, nothing herein shall supersede or modify\\n the terms of any separate license agreement you may have executed\\n with Licensor regarding such Contributions.\\n\\n 6. Trademarks. This License does not grant permission to use the trade\\n names, trademarks, service marks, or product names of the Licensor,\\n except as required for reasonable and customary use in describing the\\n origin of the Work and reproducing the content of the NOTICE file.\\n\\n 7. Disclaimer of Warranty. Unless required by applicable law or\\n agreed to in writing, Licensor provides the Work (and each\\n Contributor provides its Contributions) on an \\\"AS IS\\\" BASIS,\\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\\n implied, including, without limitation, any warranties or conditions\\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\\n PARTICULAR PURPOSE. You are solely responsible for determining the\\n appropriateness of using or redistributing the Work and assume any\\n risks associated with Your exercise of permissions under this License.\\n\\n 8. Limitation of Liability. In no event and under no legal theory,\\n whether in tort (including negligence), contract, or otherwise,\\n unless required by applicable law (such as deliberate and grossly\\n negligent acts) or agreed to in writing, shall any Contributor be\\n liable to You for damages, including any direct, indirect, special,\\n incidental, or consequential damages of any character arising as a\\n result of this License or out of the use or inability to use the\\n Work (including but not limited to damages for loss of goodwill,\\n work stoppage, computer failure or malfunction, or any and all\\n other commercial damages or losses), even if such Contributor\\n has been advised of the possibility of such damages.\\n\\n 9. Accepting Warranty or Additional Liability. While redistributing\\n the Work or Derivative Works thereof, You may choose to offer,\\n and charge a fee for, acceptance of support, warranty, indemnity,\\n or other liability obligations and/or rights consistent with this\\n License. However, in accepting such obligations, You may act only\\n on Your own behalf and on Your sole responsibility, not on behalf\\n of any other Contributor, and only if You agree to indemnify,\\n defend, and hold each Contributor harmless for any liability\\n incurred by, or claims asserted against, such Contributor by reason\\n of your accepting any such warranty or additional liability.\\n\\n END OF TERMS AND CONDITIONS\\n\\n APPENDIX: How to apply the Apache License to your work.\\n\\n To apply the Apache License to your work, attach the following\\n boilerplate notice, with the fields enclosed by brackets \\\"[]\\\"\\n replaced with your own identifying information. (Don't include\\n the brackets!) The text should be enclosed in the appropriate\\n comment syntax for the file format. We also recommend that a\\n file or class name and description of purpose be included on the\\n same \\\"printed page\\\" as the copyright notice for easier\\n identification within third-party archives.\\n\\n Copyright [yyyy] [name of copyright owner]\\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[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[build-system]\\n# Minimum requirements for the build system to execute.\\n# PEP 508 specifications for PEP 518.\\n# Banned setuptools versions have well-known issues\\nrequires = [\\n \\\"setuptools >= 21.0.0,!=24.0.0,!=34.0.0,!=34.0.1,!=34.0.2,!=34.0.3,!=34.1.0,!=34.1.1,!=34.2.0,!=34.3.0,!=34.3.1,!=34.3.2,!=36.2.0\\\", # PSF/ZPL\\n \\\"setuptools_scm[toml]>=3.4\\\",\\n]\\nbuild-backend=\\\"setuptools.build_meta\\\"\\n\\n[tool.ruff]\\nline-length = 88\\nindent-width = 4\\ntarget-version = \\\"py39\\\"\\n\\n[tool.mypy]\\nstrict = true\\nfiles = [\\\"tenacity\\\", \\\"tests\\\"]\\nshow_error_codes = true\\n\\n[[tool.mypy.overrides]]\\nmodule = \\\"tornado.*\\\"\\nignore_missing_imports = true\\n\\n[tool.setuptools_scm]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"version: 2\\npython:\\n install:\\n - method: pip\\n path: .\\n extra_requirements:\\n - doc\\n\\n[end of .readthedocs.yml]\",\n \"filename\": \".readthedocs.yml\",\n \"id\": \"4\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\ncharset = utf-8\\nend_of_line = lf\\nindent_size = 2\\nindent_style = space\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\n\\n[*.{py,pyx,pxd,pyi}]\\nindent_size = 4\\nmax_line_length = 120\\n\\n[*.ini]\\nindent_size = 4\\n\\n[*.rst]\\nmax_line_length = 150\\n\\n[Makefile]\\nindent_style = tab\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"5\"\n },\n {\n \"content\": \"#!/usr/bin/env python\\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\\n# implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport setuptools\\n\\nsetuptools.setup(\\n setup_requires=[\\\"setuptools_scm\\\"],\\n use_scm_version=True,\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"[tox]\\n# we only test trio on latest python version\\nenvlist = py3{9,10,11,12,13,13-trio}, pep8, pypy3\\nskip_missing_interpreters = True\\n\\n[testenv]\\nusedevelop = True\\nsitepackages = False\\ndeps =\\n .[test]\\n .[doc]\\n trio: trio\\ncommands =\\n py3{8,9,10,11,12,13},pypy3: pytest {posargs}\\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b doctest doc/source doc/build\\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b html doc/source doc/build\\n\\n[testenv:pep8]\\nbasepython = python3\\ndeps = ruff\\ncommands =\\n ruff check . {posargs}\\n ruff format --check . {posargs}\\n\\n[testenv:mypy]\\ndeps =\\n mypy>=1.0.0\\n pytest # for stubs\\n trio\\ncommands =\\n mypy {posargs}\\n\\n[testenv:reno]\\nbasepython = python3\\ndeps = reno\\ncommands = reno {posargs}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"7\"\n },\n {\n \"content\": \"[metadata]\\nname = tenacity\\nlicense = Apache 2.0\\nurl = https://github.com/jd/tenacity\\nsummary = Retry code until it succeeds\\nlong_description = Tenacity is a general-purpose retrying library to simplify the task of adding retry behavior to just about anything.\\nauthor = Julien Danjou\\nauthor_email = julien@danjou.info\\nhome_page = https://github.com/jd/tenacity\\nclassifier =\\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 :: Only\\n Programming Language :: Python :: 3.9\\n Programming Language :: Python :: 3.10\\n Programming Language :: Python :: 3.11\\n Programming Language :: Python :: 3.12\\n Programming Language :: Python :: 3.13\\n Topic :: Utilities\\n\\n[options]\\ninstall_requires =\\npython_requires = >=3.9\\npackages = find:\\n\\n[options.packages.find]\\ninclude = tenacity*\\nexclude = tests\\n\\n[options.package_data]\\ntenacity = py.typed\\n\\n[options.extras_require]\\ndoc =\\n reno\\n sphinx\\ntest =\\n pytest\\n tornado>=4.5\\n typeguard\\n\\n[tool:pytest]\\nfilterwarnings =\\n # Show any DeprecationWarnings once\\n once::DeprecationWarning\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"8\"\n },\n {\n \"content\": \"Tenacity\\n========\\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\\n :target: https://pypi.python.org/pypi/tenacity\\n\\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\\n :target: https://circleci.com/gh/jd/tenacity\\n\\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\\n :target: https://mergify.io\\n :alt: Mergify Status\\n\\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\\n\\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\\nPython, to simplify the task of adding retry behavior to just about anything.\\nIt originates from `a fork of retrying\\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\\napi compatible with retrying but adds significant new functionality and\\nfixes a number of longstanding bugs.\\n\\nThe simplest use case is retrying a flaky function whenever an `Exception`\\noccurs until a value is returned.\\n\\n.. testcode::\\n\\n import random\\n from tenacity import retry\\n\\n @retry\\n def do_something_unreliable():\\n if random.randint(0, 10) > 1:\\n raise IOError(\\\"Broken sauce, everything is hosed!!!111one\\\")\\n else:\\n return \\\"Awesome sauce!\\\"\\n\\n print(do_something_unreliable())\\n\\n.. testoutput::\\n :hide:\\n\\n Awesome sauce!\\n\\n\\n.. toctree::\\n :hidden:\\n :maxdepth: 2\\n\\n changelog\\n api\\n\\n\\nFeatures\\n--------\\n\\n- Generic Decorator API\\n- Specify stop condition (i.e. limit by number of attempts)\\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\\n- Customize retrying on Exceptions\\n- Customize retrying on expected returned result\\n- Retry on coroutines\\n- Retry code block with context manager\\n\\n\\nInstallation\\n------------\\n\\nTo install *tenacity*, simply:\\n\\n.. code-block:: bash\\n\\n $ pip install tenacity\\n\\n\\nExamples\\n----------\\n\\nBasic Retry\\n~~~~~~~~~~~\\n\\n.. testsetup::\\n\\n import logging\\n #\\n # Note the following import is used for demonstration convenience only.\\n # Production code should always explicitly import the names it needs.\\n #\\n from tenacity import *\\n\\n class MyException(Exception):\\n pass\\n\\nAs you saw above, the default behavior is to retry forever without waiting when\\nan exception is raised.\\n\\n.. testcode::\\n\\n @retry\\n def never_gonna_give_you_up():\\n print(\\\"Retry forever ignoring Exceptions, don't wait between retries\\\")\\n raise Exception\\n\\nStopping\\n~~~~~~~~\\n\\nLet's be a little less persistent and set some boundaries, such as the number\\nof attempts before giving up.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(7))\\n def stop_after_7_attempts():\\n print(\\\"Stopping after 7 attempts\\\")\\n raise Exception\\n\\nWe don't have all day, so let's set a boundary for how long we should be\\nretrying stuff.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_delay(10))\\n def stop_after_10_s():\\n print(\\\"Stopping after 10 seconds\\\")\\n raise Exception\\n\\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\\nthen you can give up on retries one attempt before you would exceed the delay.\\n\\n.. testcode::\\n\\n @retry(stop=stop_before_delay(10))\\n def stop_before_10_s():\\n print(\\\"Stopping 1 attempt before 10 seconds\\\")\\n raise Exception\\n\\nYou can combine several stop conditions by using the `|` operator:\\n\\n.. testcode::\\n\\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\\n def stop_after_10_s_or_5_retries():\\n print(\\\"Stopping after 10 seconds or 5 retries\\\")\\n raise Exception\\n\\nWaiting before retrying\\n~~~~~~~~~~~~~~~~~~~~~~~\\n\\nMost things don't like to be polled as fast as possible, so let's just wait 2\\nseconds between retries.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(2))\\n def wait_2_s():\\n print(\\\"Wait 2 second between retries\\\")\\n raise Exception\\n\\nSome things perform best with a bit of randomness injected.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random(min=1, max=2))\\n def wait_random_1_to_2_s():\\n print(\\\"Randomly wait 1 to 2 seconds between retries\\\")\\n raise Exception\\n\\nThen again, it's hard to beat exponential backoff when retrying distributed\\nservices and other remote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\\n def wait_exponential_1():\\n print(\\\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\\\")\\n raise Exception\\n\\n\\nThen again, it's also hard to beat combining fixed waits and jitter (to\\nhelp avoid thundering herds) when retrying distributed services and other\\nremote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\\n def wait_fixed_jitter():\\n print(\\\"Wait at least 3 seconds, and add up to 2 seconds of random delay\\\")\\n raise Exception\\n\\nWhen multiple processes are in contention for a shared resource, exponentially\\nincreasing jitter helps minimise collisions.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\\n def wait_exponential_jitter():\\n print(\\\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\\\")\\n raise Exception\\n\\n\\nSometimes it's necessary to build a chain of backoffs.\\n\\n.. testcode::\\n\\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\\n [wait_fixed(7) for i in range(2)] +\\n [wait_fixed(9)]))\\n def wait_fixed_chained():\\n print(\\\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\\\")\\n raise Exception\\n\\nWhether to retry\\n~~~~~~~~~~~~~~~~\\n\\nWe have a few options for dealing with retries that raise specific or general\\nexceptions, as in the cases here.\\n\\n.. testcode::\\n\\n class ClientError(Exception):\\n \\\"\\\"\\\"Some type of client error.\\\"\\\"\\\"\\n\\n @retry(retry=retry_if_exception_type(IOError))\\n def might_io_error():\\n print(\\\"Retry forever with no wait if an IOError occurs, raise any other errors\\\")\\n raise Exception\\n\\n @retry(retry=retry_if_not_exception_type(ClientError))\\n def might_client_error():\\n print(\\\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\\\")\\n raise Exception\\n\\nWe can also use the result of the function to alter the behavior of retrying.\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=retry_if_result(is_none_p))\\n def might_return_none():\\n print(\\\"Retry with no wait if return value is None\\\")\\n\\nSee also these methods:\\n\\n.. testcode::\\n\\n retry_if_exception\\n retry_if_exception_type\\n retry_if_not_exception_type\\n retry_unless_exception_type\\n retry_if_result\\n retry_if_not_result\\n retry_if_exception_message\\n retry_if_not_exception_message\\n retry_any\\n retry_all\\n\\nWe can also combine several conditions:\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\\n def might_return_none():\\n print(\\\"Retry forever ignoring Exceptions with no wait if return value is None\\\")\\n\\nAny combination of stop, wait, etc. is also supported to give you the freedom\\nto mix and match.\\n\\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\\nexception:\\n\\n.. testcode::\\n\\n @retry\\n def do_something():\\n result = something_else()\\n if result == 23:\\n raise TryAgain\\n\\nError Handling\\n~~~~~~~~~~~~~~\\n\\nNormally when your function fails its final time (and will not be retried again based on your settings),\\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\\nof the stack trace.\\n\\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\\nis most visible), you can set `reraise=True`.\\n\\n.. testcode::\\n\\n @retry(reraise=True, stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except MyException:\\n # timed out retrying\\n pass\\n\\nBefore and After Retry, and Logging\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's possible to execute an action before any attempt of calling the function\\nby using the before callback function:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIn the same spirit, It's possible to execute after a call that failed:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIt's also possible to only log failures that are going to be retried. Normally\\nretries happen after a wait interval, so the keyword argument is called\\n``before_sleep``:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3),\\n before_sleep=before_sleep_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n\\nStatistics\\n~~~~~~~~~~\\n\\nYou can access the statistics about the retry made over a function by using the\\n`statistics` attribute attached to the function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nCustom Callbacks\\n~~~~~~~~~~~~~~~~\\n\\nYou can also define your own callbacks. The callback should accept one\\nparameter called ``retry_state`` that contains all information about current\\nretry invocation.\\n\\nFor example, you can call a custom callback function after all retries failed,\\nwithout raising an exception (or you can re-raise or do anything really)\\n\\n.. testcode::\\n\\n def return_last_value(retry_state):\\n \\\"\\\"\\\"return the result of the last call attempt\\\"\\\"\\\"\\n return retry_state.outcome.result()\\n\\n def is_false(value):\\n \\\"\\\"\\\"Return True if value is False\\\"\\\"\\\"\\n return value is False\\n\\n # will return False after trying 3 times to get a different result\\n @retry(stop=stop_after_attempt(3),\\n retry_error_callback=return_last_value,\\n retry=retry_if_result(is_false))\\n def eventually_return_false():\\n return False\\n\\nRetryCallState\\n~~~~~~~~~~~~~~\\n\\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\\n\\nOther Custom Callbacks\\n~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's also possible to define custom callbacks for other keyword arguments.\\n\\n.. function:: my_stop(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should stop\\n :rtype: bool\\n\\n.. function:: my_wait(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: number of seconds to wait before next retry\\n :rtype: float\\n\\n.. function:: my_retry(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should continue\\n :rtype: bool\\n\\n.. function:: my_before(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_after(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_before_sleep(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\nHere's an example with a custom ``before_sleep`` function:\\n\\n.. testcode::\\n\\n import logging\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n def my_before_sleep(retry_state):\\n if retry_state.attempt_number < 1:\\n loglevel = logging.INFO\\n else:\\n loglevel = logging.WARNING\\n logger.log(\\n loglevel, 'Retrying %s: attempt %s ended with: %s',\\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\\n\\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except RetryError:\\n pass\\n\\n\\nChanging Arguments at Run Time\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nYou can change the arguments of a retry decorator as needed when calling it by\\nusing the `retry_with` function attached to the wrapped function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nIf you want to use variables to set up the retry parameters, you don't have\\nto use the `retry` decorator - you can instead use `Retrying` directly:\\n\\n.. testcode::\\n\\n def never_good_enough(arg1):\\n raise Exception('Invalid argument: {}'.format(arg1))\\n\\n def try_never_good_enough(max_attempts=3):\\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\\n retryer(never_good_enough, 'I really do try')\\n\\nYou may also want to change the behaviour of a decorated function temporarily,\\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\\nattribute attached to the function. Bear in mind this is a write-only attribute,\\nstatistics should be read from the function `statistics` attribute.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n from unittest import mock\\n\\n with mock.patch.object(raise_my_exception.retry, \\\"wait\\\", wait_fixed(0)):\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nRetrying code block\\n~~~~~~~~~~~~~~~~~~~\\n\\nTenacity allows you to retry a code block without the need to wraps it in an\\nisolated function. This makes it easy to isolate failing block while sharing\\ncontext. The trick is to combine a for loop and a context manager.\\n\\n.. testcode::\\n\\n from tenacity import Retrying, RetryError, stop_after_attempt\\n\\n try:\\n for attempt in Retrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nYou can configure every details of retry policy by configuring the Retrying\\nobject.\\n\\nWith async code you can use AsyncRetrying.\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\\n\\n async def function():\\n try:\\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nIn both cases, you may want to set the result to the attempt so it's available\\nin retry strategies like ``retry_if_result``. This can be done accessing the\\n``retry_state`` property:\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, retry_if_result\\n\\n async def function():\\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\\n with attempt:\\n result = 1 # Some complex calculation, function call, etc.\\n if not attempt.retry_state.outcome.failed:\\n attempt.retry_state.set_result(result)\\n return result\\n\\nAsync and retry\\n~~~~~~~~~~~~~~~\\n\\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\\nSleeps are done asynchronously too.\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_asyncio_function(loop):\\n await loop.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_async_trio_function():\\n await trio.socket.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n @tornado.gen.coroutine\\n def my_async_tornado_function(http_client, url):\\n yield http_client.fetch(url)\\n\\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\\n\\n.. code-block:: python\\n\\n @retry(sleep=curio.sleep)\\n async def my_async_curio_function():\\n await asks.get('https://example.org')\\n\\nContribute\\n----------\\n\\n#. Check for open issues or open a fresh issue to start a discussion around a\\n feature idea or a bug.\\n#. Fork `the repository`_ on GitHub to start making your changes to the\\n **main** branch (or branch off of it).\\n#. Write a test which shows that the bug was fixed or that the feature works as\\n expected.\\n#. Add a `changelog <#Changelogs>`_\\n#. Make the docs better (or more detailed, or more easier to read, or ...)\\n\\n.. _`the repository`: https://github.com/jd/tenacity\\n\\nChangelogs\\n~~~~~~~~~~\\n\\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\\n\\nThe doc generation will automatically compile the changelogs. You just need to add them.\\n\\n.. code-block:: sh\\n\\n # Opens a template file in an editor\\n tox -e reno -- new some-slug-for-my-change --edit\\n\\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef before_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"Before call strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef before_log(\\n logger: \\\"logging.Logger\\\", log_level: int\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"Before call strategy that logs to some logger the attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n logger.log(\\n log_level,\\n f\\\"Starting call to '{fn_name}', \\\"\\n f\\\"this is the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\\\",\\n )\\n\\n return log_it\\n\\n[end of tenacity/before.py]\",\n \"filename\": \"tenacity/before.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef before_sleep_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"Before sleep strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef before_sleep_log(\\n logger: \\\"logging.Logger\\\",\\n log_level: int,\\n exc_info: bool = False,\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"Before sleep strategy that logs to some logger the attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n local_exc_info: BaseException | bool | None\\n\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"log_it() called before outcome was set\\\")\\n\\n if retry_state.next_action is None:\\n raise RuntimeError(\\\"log_it() called before next_action was set\\\")\\n\\n if retry_state.outcome.failed:\\n ex = retry_state.outcome.exception()\\n verb, value = \\\"raised\\\", f\\\"{ex.__class__.__name__}: {ex}\\\"\\n\\n if exc_info:\\n local_exc_info = retry_state.outcome.exception()\\n else:\\n local_exc_info = False\\n else:\\n verb, value = \\\"returned\\\", retry_state.outcome.result()\\n local_exc_info = False # exc_info does not apply when no exception\\n\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n\\n logger.log(\\n log_level,\\n f\\\"Retrying {fn_name} \\\"\\n f\\\"in {retry_state.next_action.sleep} seconds as it {verb} {value}.\\\",\\n exc_info=local_exc_info,\\n )\\n\\n return log_it\\n\\n[end of tenacity/before_sleep.py]\",\n \"filename\": \"tenacity/before_sleep.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport abc\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import threading\\n\\n from tenacity import RetryCallState\\n\\n\\nclass stop_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for stop strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n pass\\n\\n def __and__(self, other: \\\"stop_base\\\") -> \\\"stop_all\\\":\\n return stop_all(self, other)\\n\\n def __or__(self, other: \\\"stop_base\\\") -> \\\"stop_any\\\":\\n return stop_any(self, other)\\n\\n\\nStopBaseT = typing.Union[stop_base, typing.Callable[[\\\"RetryCallState\\\"], bool]]\\n\\n\\nclass stop_any(stop_base):\\n \\\"\\\"\\\"Stop if any of the stop condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *stops: stop_base) -> None:\\n self.stops = stops\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return any(x(retry_state) for x in self.stops)\\n\\n\\nclass stop_all(stop_base):\\n \\\"\\\"\\\"Stop if all the stop conditions are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *stops: stop_base) -> None:\\n self.stops = stops\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return all(x(retry_state) for x in self.stops)\\n\\n\\nclass _stop_never(stop_base):\\n \\\"\\\"\\\"Never stop.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return False\\n\\n\\nstop_never = _stop_never()\\n\\n\\nclass stop_when_event_set(stop_base):\\n \\\"\\\"\\\"Stop when the given event is set.\\\"\\\"\\\"\\n\\n def __init__(self, event: \\\"threading.Event\\\") -> None:\\n self.event = event\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return self.event.is_set()\\n\\n\\nclass stop_after_attempt(stop_base):\\n \\\"\\\"\\\"Stop when the previous attempt >= max_attempt.\\\"\\\"\\\"\\n\\n def __init__(self, max_attempt_number: int) -> None:\\n self.max_attempt_number = max_attempt_number\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return retry_state.attempt_number >= self.max_attempt_number\\n\\n\\nclass stop_after_delay(stop_base):\\n \\\"\\\"\\\"\\n Stop when the time from the first attempt >= limit.\\n\\n Note: `max_delay` will be exceeded, so when used with a `wait`, the actual total delay will be greater\\n than `max_delay` by some of the final sleep period before `max_delay` is exceeded.\\n\\n If you need stricter timing with waits, consider `stop_before_delay` instead.\\n \\\"\\\"\\\"\\n\\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\\n self.max_delay = _utils.to_seconds(max_delay)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.seconds_since_start is None:\\n raise RuntimeError(\\\"__call__() called but seconds_since_start is not set\\\")\\n return retry_state.seconds_since_start >= self.max_delay\\n\\n\\nclass stop_before_delay(stop_base):\\n \\\"\\\"\\\"\\n Stop right before the next attempt would take place after the time from the first attempt >= limit.\\n\\n Most useful when you are using with a `wait` function like wait_random_exponential, but need to make\\n sure that the max_delay is not exceeded.\\n \\\"\\\"\\\"\\n\\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\\n self.max_delay = _utils.to_seconds(max_delay)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.seconds_since_start is None:\\n raise RuntimeError(\\\"__call__() called but seconds_since_start is not set\\\")\\n return (\\n retry_state.seconds_since_start + retry_state.upcoming_sleep\\n >= self.max_delay\\n )\\n\\n[end of tenacity/stop.py]\",\n \"filename\": \"tenacity/stop.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport abc\\nimport random\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass wait_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for wait strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n pass\\n\\n def __add__(self, other: \\\"wait_base\\\") -> \\\"wait_combine\\\":\\n return wait_combine(self, other)\\n\\n def __radd__(self, other: \\\"wait_base\\\") -> typing.Union[\\\"wait_combine\\\", \\\"wait_base\\\"]:\\n # make it possible to use multiple waits with the built-in sum function\\n if other == 0: # type: ignore[comparison-overlap]\\n return self\\n return self.__add__(other)\\n\\n\\nWaitBaseT = typing.Union[\\n wait_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Union[float, int]]\\n]\\n\\n\\nclass wait_fixed(wait_base):\\n \\\"\\\"\\\"Wait strategy that waits a fixed amount of time between each retry.\\\"\\\"\\\"\\n\\n def __init__(self, wait: _utils.time_unit_type) -> None:\\n self.wait_fixed = _utils.to_seconds(wait)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return self.wait_fixed\\n\\n\\nclass wait_none(wait_fixed):\\n \\\"\\\"\\\"Wait strategy that doesn't wait at all before retrying.\\\"\\\"\\\"\\n\\n def __init__(self) -> None:\\n super().__init__(0)\\n\\n\\nclass wait_random(wait_base):\\n \\\"\\\"\\\"Wait strategy that waits a random amount of time between min/max.\\\"\\\"\\\"\\n\\n def __init__(\\n self, min: _utils.time_unit_type = 0, max: _utils.time_unit_type = 1\\n ) -> None: # noqa\\n self.wait_random_min = _utils.to_seconds(min)\\n self.wait_random_max = _utils.to_seconds(max)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return self.wait_random_min + (\\n random.random() * (self.wait_random_max - self.wait_random_min)\\n )\\n\\n\\nclass wait_combine(wait_base):\\n \\\"\\\"\\\"Combine several waiting strategies.\\\"\\\"\\\"\\n\\n def __init__(self, *strategies: wait_base) -> None:\\n self.wait_funcs = strategies\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return sum(x(retry_state=retry_state) for x in self.wait_funcs)\\n\\n\\nclass wait_chain(wait_base):\\n \\\"\\\"\\\"Chain two or more waiting strategies.\\n\\n If all strategies are exhausted, the very last strategy is used\\n thereafter.\\n\\n For example::\\n\\n @retry(wait=wait_chain(*[wait_fixed(1) for i in range(3)] +\\n [wait_fixed(2) for j in range(5)] +\\n [wait_fixed(5) for k in range(4)))\\n def wait_chained():\\n print(\\\"Wait 1s for 3 attempts, 2s for 5 attempts and 5s\\n thereafter.\\\")\\n \\\"\\\"\\\"\\n\\n def __init__(self, *strategies: wait_base) -> None:\\n self.strategies = strategies\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n wait_func_no = min(max(retry_state.attempt_number, 1), len(self.strategies))\\n wait_func = self.strategies[wait_func_no - 1]\\n return wait_func(retry_state=retry_state)\\n\\n\\nclass wait_incrementing(wait_base):\\n \\\"\\\"\\\"Wait an incremental amount of time after each attempt.\\n\\n Starting at a starting value and incrementing by a value for each attempt\\n (and restricting the upper limit to some maximum value).\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n start: _utils.time_unit_type = 0,\\n increment: _utils.time_unit_type = 100,\\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\\n ) -> None:\\n self.start = _utils.to_seconds(start)\\n self.increment = _utils.to_seconds(increment)\\n self.max = _utils.to_seconds(max)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n result = self.start + (self.increment * (retry_state.attempt_number - 1))\\n return max(0, min(result, self.max))\\n\\n\\nclass wait_exponential(wait_base):\\n \\\"\\\"\\\"Wait strategy that applies exponential backoff.\\n\\n It allows for a customized multiplier and an ability to restrict the\\n upper and lower limits to some maximum and minimum value.\\n\\n The intervals are fixed (i.e. there is no jitter), so this strategy is\\n suitable for balancing retries against latency when a required resource is\\n unavailable for an unknown duration, but *not* suitable for resolving\\n contention between multiple processes for a shared resource. Use\\n wait_random_exponential for the latter case.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n multiplier: typing.Union[int, float] = 1,\\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\\n exp_base: typing.Union[int, float] = 2,\\n min: _utils.time_unit_type = 0, # noqa\\n ) -> None:\\n self.multiplier = multiplier\\n self.min = _utils.to_seconds(min)\\n self.max = _utils.to_seconds(max)\\n self.exp_base = exp_base\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n try:\\n exp = self.exp_base ** (retry_state.attempt_number - 1)\\n result = self.multiplier * exp\\n except OverflowError:\\n return self.max\\n return max(max(0, self.min), min(result, self.max))\\n\\n\\nclass wait_random_exponential(wait_exponential):\\n \\\"\\\"\\\"Random wait with exponentially widening window.\\n\\n An exponential backoff strategy used to mediate contention between multiple\\n uncoordinated processes for a shared resource in distributed systems. This\\n is the sense in which \\\"exponential backoff\\\" is meant in e.g. Ethernet\\n networking, and corresponds to the \\\"Full Jitter\\\" algorithm described in\\n this blog post:\\n\\n https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/\\n\\n Each retry occurs at a random time in a geometrically expanding interval.\\n It allows for a custom multiplier and an ability to restrict the upper\\n limit of the random interval to some maximum value.\\n\\n Example::\\n\\n wait_random_exponential(multiplier=0.5, # initial window 0.5s\\n max=60) # max 60s timeout\\n\\n When waiting for an unavailable resource to become available again, as\\n opposed to trying to resolve contention for a shared resource, the\\n wait_exponential strategy (which uses a fixed interval) may be preferable.\\n\\n \\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n high = super().__call__(retry_state=retry_state)\\n return random.uniform(self.min, high)\\n\\n\\nclass wait_exponential_jitter(wait_base):\\n \\\"\\\"\\\"Wait strategy that applies exponential backoff and jitter.\\n\\n It allows for a customized initial wait, maximum wait and jitter.\\n\\n This implements the strategy described here:\\n https://cloud.google.com/storage/docs/retry-strategy\\n\\n The wait time is min(initial * 2**n + random.uniform(0, jitter), maximum)\\n where n is the retry count.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n initial: float = 1,\\n max: float = _utils.MAX_WAIT, # noqa\\n exp_base: float = 2,\\n jitter: float = 1,\\n ) -> None:\\n self.initial = initial\\n self.max = max\\n self.exp_base = exp_base\\n self.jitter = jitter\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n jitter = random.uniform(0, self.jitter)\\n try:\\n exp = self.exp_base ** (retry_state.attempt_number - 1)\\n result = self.initial * exp + jitter\\n except OverflowError:\\n result = self.max\\n return max(0, min(result, self.max))\\n\\n[end of tenacity/wait.py]\",\n \"filename\": \"tenacity/wait.py\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# Copyright 2016-2018 Julien Danjou\\n# Copyright 2017 Elisey Zanko\\n# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport dataclasses\\nimport functools\\nimport sys\\nimport threading\\nimport time\\nimport typing as t\\nimport warnings\\nfrom abc import ABC, abstractmethod\\nfrom concurrent import futures\\n\\nfrom . import _utils\\n\\n# Import all built-in retry strategies for easier usage.\\nfrom .retry import retry_base # noqa\\nfrom .retry import retry_all # noqa\\nfrom .retry import retry_always # noqa\\nfrom .retry import retry_any # noqa\\nfrom .retry import retry_if_exception # noqa\\nfrom .retry import retry_if_exception_type # noqa\\nfrom .retry import retry_if_exception_cause_type # noqa\\nfrom .retry import retry_if_not_exception_type # noqa\\nfrom .retry import retry_if_not_result # noqa\\nfrom .retry import retry_if_result # noqa\\nfrom .retry import retry_never # noqa\\nfrom .retry import retry_unless_exception_type # noqa\\nfrom .retry import retry_if_exception_message # noqa\\nfrom .retry import retry_if_not_exception_message # noqa\\n\\n# Import all nap strategies for easier usage.\\nfrom .nap import sleep # noqa\\nfrom .nap import sleep_using_event # noqa\\n\\n# Import all built-in stop strategies for easier usage.\\nfrom .stop import stop_after_attempt # noqa\\nfrom .stop import stop_after_delay # noqa\\nfrom .stop import stop_before_delay # noqa\\nfrom .stop import stop_all # noqa\\nfrom .stop import stop_any # noqa\\nfrom .stop import stop_never # noqa\\nfrom .stop import stop_when_event_set # noqa\\n\\n# Import all built-in wait strategies for easier usage.\\nfrom .wait import wait_chain # noqa\\nfrom .wait import wait_combine # noqa\\nfrom .wait import wait_exponential # noqa\\nfrom .wait import wait_fixed # noqa\\nfrom .wait import wait_incrementing # noqa\\nfrom .wait import wait_none # noqa\\nfrom .wait import wait_random # noqa\\nfrom .wait import wait_random_exponential # noqa\\nfrom .wait import wait_random_exponential as wait_full_jitter # noqa\\nfrom .wait import wait_exponential_jitter # noqa\\n\\n# Import all built-in before strategies for easier usage.\\nfrom .before import before_log # noqa\\nfrom .before import before_nothing # noqa\\n\\n# Import all built-in after strategies for easier usage.\\nfrom .after import after_log # noqa\\nfrom .after import after_nothing # noqa\\n\\n# Import all built-in before sleep strategies for easier usage.\\nfrom .before_sleep import before_sleep_log # noqa\\nfrom .before_sleep import before_sleep_nothing # noqa\\n\\ntry:\\n import tornado\\nexcept ImportError:\\n tornado = None\\n\\nif t.TYPE_CHECKING:\\n import types\\n\\n from typing_extensions import Self\\n\\n from . import asyncio as tasyncio\\n from .retry import RetryBaseT\\n from .stop import StopBaseT\\n from .wait import WaitBaseT\\n\\n\\nWrappedFnReturnT = t.TypeVar(\\\"WrappedFnReturnT\\\")\\nWrappedFn = t.TypeVar(\\\"WrappedFn\\\", bound=t.Callable[..., t.Any])\\n\\n\\ndataclass_kwargs = {}\\nif sys.version_info >= (3, 10):\\n dataclass_kwargs.update({\\\"slots\\\": True})\\n\\n\\n@dataclasses.dataclass(**dataclass_kwargs)\\nclass IterState:\\n actions: t.List[t.Callable[[\\\"RetryCallState\\\"], t.Any]] = dataclasses.field(\\n default_factory=list\\n )\\n retry_run_result: bool = False\\n delay_since_first_attempt: int = 0\\n stop_run_result: bool = False\\n is_explicit_retry: bool = False\\n\\n def reset(self) -> None:\\n self.actions = []\\n self.retry_run_result = False\\n self.delay_since_first_attempt = 0\\n self.stop_run_result = False\\n self.is_explicit_retry = False\\n\\n\\nclass TryAgain(Exception):\\n \\\"\\\"\\\"Always retry the executed function when raised.\\\"\\\"\\\"\\n\\n\\nNO_RESULT = object()\\n\\n\\nclass DoAttempt:\\n pass\\n\\n\\nclass DoSleep(float):\\n pass\\n\\n\\nclass BaseAction:\\n \\\"\\\"\\\"Base class for representing actions to take by retry object.\\n\\n Concrete implementations must define:\\n - __init__: to initialize all necessary fields\\n - REPR_FIELDS: class variable specifying attributes to include in repr(self)\\n - NAME: for identification in retry object methods and callbacks\\n \\\"\\\"\\\"\\n\\n REPR_FIELDS: t.Sequence[str] = ()\\n NAME: t.Optional[str] = None\\n\\n def __repr__(self) -> str:\\n state_str = \\\", \\\".join(\\n f\\\"{field}={getattr(self, field)!r}\\\" for field in self.REPR_FIELDS\\n )\\n return f\\\"{self.__class__.__name__}({state_str})\\\"\\n\\n def __str__(self) -> str:\\n return repr(self)\\n\\n\\nclass RetryAction(BaseAction):\\n REPR_FIELDS = (\\\"sleep\\\",)\\n NAME = \\\"retry\\\"\\n\\n def __init__(self, sleep: t.SupportsFloat) -> None:\\n self.sleep = float(sleep)\\n\\n\\n_unset = object()\\n\\n\\ndef _first_set(first: t.Union[t.Any, object], second: t.Any) -> t.Any:\\n return second if first is _unset else first\\n\\n\\nclass RetryError(Exception):\\n \\\"\\\"\\\"Encapsulates the last attempt instance right before giving up.\\\"\\\"\\\"\\n\\n def __init__(self, last_attempt: \\\"Future\\\") -> None:\\n self.last_attempt = last_attempt\\n super().__init__(last_attempt)\\n\\n def reraise(self) -> t.NoReturn:\\n if self.last_attempt.failed:\\n raise self.last_attempt.result()\\n raise self\\n\\n def __str__(self) -> str:\\n return f\\\"{self.__class__.__name__}[{self.last_attempt}]\\\"\\n\\n\\nclass AttemptManager:\\n \\\"\\\"\\\"Manage attempt context.\\\"\\\"\\\"\\n\\n def __init__(self, retry_state: \\\"RetryCallState\\\"):\\n self.retry_state = retry_state\\n\\n def __enter__(self) -> None:\\n pass\\n\\n def __exit__(\\n self,\\n exc_type: t.Optional[t.Type[BaseException]],\\n exc_value: t.Optional[BaseException],\\n traceback: t.Optional[\\\"types.TracebackType\\\"],\\n ) -> t.Optional[bool]:\\n if exc_type is not None and exc_value is not None:\\n self.retry_state.set_exception((exc_type, exc_value, traceback))\\n return True # Swallow exception.\\n else:\\n # We don't have the result, actually.\\n self.retry_state.set_result(None)\\n return None\\n\\n\\nclass BaseRetrying(ABC):\\n def __init__(\\n self,\\n sleep: t.Callable[[t.Union[int, float]], None] = sleep,\\n stop: \\\"StopBaseT\\\" = stop_never,\\n wait: \\\"WaitBaseT\\\" = wait_none(),\\n retry: \\\"RetryBaseT\\\" = retry_if_exception_type(),\\n before: t.Callable[[\\\"RetryCallState\\\"], None] = before_nothing,\\n after: t.Callable[[\\\"RetryCallState\\\"], None] = after_nothing,\\n before_sleep: t.Optional[t.Callable[[\\\"RetryCallState\\\"], None]] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[RetryError] = RetryError,\\n retry_error_callback: t.Optional[t.Callable[[\\\"RetryCallState\\\"], t.Any]] = None,\\n ):\\n self.sleep = sleep\\n self.stop = stop\\n self.wait = wait\\n self.retry = retry\\n self.before = before\\n self.after = after\\n self.before_sleep = before_sleep\\n self.reraise = reraise\\n self._local = threading.local()\\n self.retry_error_cls = retry_error_cls\\n self.retry_error_callback = retry_error_callback\\n\\n def copy(\\n self,\\n sleep: t.Union[t.Callable[[t.Union[int, float]], None], object] = _unset,\\n stop: t.Union[\\\"StopBaseT\\\", object] = _unset,\\n wait: t.Union[\\\"WaitBaseT\\\", object] = _unset,\\n retry: t.Union[retry_base, object] = _unset,\\n before: t.Union[t.Callable[[\\\"RetryCallState\\\"], None], object] = _unset,\\n after: t.Union[t.Callable[[\\\"RetryCallState\\\"], None], object] = _unset,\\n before_sleep: t.Union[\\n t.Optional[t.Callable[[\\\"RetryCallState\\\"], None]], object\\n ] = _unset,\\n reraise: t.Union[bool, object] = _unset,\\n retry_error_cls: t.Union[t.Type[RetryError], object] = _unset,\\n retry_error_callback: t.Union[\\n t.Optional[t.Callable[[\\\"RetryCallState\\\"], t.Any]], object\\n ] = _unset,\\n ) -> \\\"Self\\\":\\n \\\"\\\"\\\"Copy this object with some parameters changed if needed.\\\"\\\"\\\"\\n return self.__class__(\\n sleep=_first_set(sleep, self.sleep),\\n stop=_first_set(stop, self.stop),\\n wait=_first_set(wait, self.wait),\\n retry=_first_set(retry, self.retry),\\n before=_first_set(before, self.before),\\n after=_first_set(after, self.after),\\n before_sleep=_first_set(before_sleep, self.before_sleep),\\n reraise=_first_set(reraise, self.reraise),\\n retry_error_cls=_first_set(retry_error_cls, self.retry_error_cls),\\n retry_error_callback=_first_set(\\n retry_error_callback, self.retry_error_callback\\n ),\\n )\\n\\n def __repr__(self) -> str:\\n return (\\n f\\\"<{self.__class__.__name__} object at 0x{id(self):x} (\\\"\\n f\\\"stop={self.stop}, \\\"\\n f\\\"wait={self.wait}, \\\"\\n f\\\"sleep={self.sleep}, \\\"\\n f\\\"retry={self.retry}, \\\"\\n f\\\"before={self.before}, \\\"\\n f\\\"after={self.after})>\\\"\\n )\\n\\n @property\\n def statistics(self) -> t.Dict[str, t.Any]:\\n \\\"\\\"\\\"Return a dictionary of runtime statistics.\\n\\n This dictionary will be empty when the controller has never been\\n ran. When it is running or has ran previously it should have (but\\n may not) have useful and/or informational keys and values when\\n running is underway and/or completed.\\n\\n .. warning:: The keys in this dictionary **should** be some what\\n stable (not changing), but there existence **may**\\n change between major releases as new statistics are\\n gathered or removed so before accessing keys ensure that\\n they actually exist and handle when they do not.\\n\\n .. note:: The values in this dictionary are local to the thread\\n running call (so if multiple threads share the same retrying\\n object - either directly or indirectly) they will each have\\n there own view of statistics they have collected (in the\\n future we may provide a way to aggregate the various\\n statistics from each thread).\\n \\\"\\\"\\\"\\n try:\\n return self._local.statistics # type: ignore[no-any-return]\\n except AttributeError:\\n self._local.statistics = t.cast(t.Dict[str, t.Any], {})\\n return self._local.statistics\\n\\n @property\\n def iter_state(self) -> IterState:\\n try:\\n return self._local.iter_state # type: ignore[no-any-return]\\n except AttributeError:\\n self._local.iter_state = IterState()\\n return self._local.iter_state\\n\\n def wraps(self, f: WrappedFn) -> WrappedFn:\\n \\\"\\\"\\\"Wrap a function for retrying.\\n\\n :param f: A function to wraps for retrying.\\n \\\"\\\"\\\"\\n\\n @functools.wraps(\\n f, functools.WRAPPER_ASSIGNMENTS + (\\\"__defaults__\\\", \\\"__kwdefaults__\\\")\\n )\\n def wrapped_f(*args: t.Any, **kw: t.Any) -> t.Any:\\n # Always create a copy to prevent overwriting the local contexts when\\n # calling the same wrapped functions multiple times in the same stack\\n copy = self.copy()\\n wrapped_f.statistics = copy.statistics # type: ignore[attr-defined]\\n return copy(f, *args, **kw)\\n\\n def retry_with(*args: t.Any, **kwargs: t.Any) -> WrappedFn:\\n return self.copy(*args, **kwargs).wraps(f)\\n\\n # Preserve attributes\\n wrapped_f.retry = self # type: ignore[attr-defined]\\n wrapped_f.retry_with = retry_with # type: ignore[attr-defined]\\n wrapped_f.statistics = {} # type: ignore[attr-defined]\\n\\n return wrapped_f # type: ignore[return-value]\\n\\n def begin(self) -> None:\\n self.statistics.clear()\\n self.statistics[\\\"start_time\\\"] = time.monotonic()\\n self.statistics[\\\"attempt_number\\\"] = 1\\n self.statistics[\\\"idle_for\\\"] = 0\\n\\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\\n self.iter_state.actions.append(fn)\\n\\n def _run_retry(self, retry_state: \\\"RetryCallState\\\") -> None:\\n self.iter_state.retry_run_result = self.retry(retry_state)\\n\\n def _run_wait(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if self.wait:\\n sleep = self.wait(retry_state)\\n else:\\n sleep = 0.0\\n\\n retry_state.upcoming_sleep = sleep\\n\\n def _run_stop(self, retry_state: \\\"RetryCallState\\\") -> None:\\n self.statistics[\\\"delay_since_first_attempt\\\"] = retry_state.seconds_since_start\\n self.iter_state.stop_run_result = self.stop(retry_state)\\n\\n def iter(self, retry_state: \\\"RetryCallState\\\") -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa\\n self._begin_iter(retry_state)\\n result = None\\n for action in self.iter_state.actions:\\n result = action(retry_state)\\n return result\\n\\n def _begin_iter(self, retry_state: \\\"RetryCallState\\\") -> None: # noqa\\n self.iter_state.reset()\\n\\n fut = retry_state.outcome\\n if fut is None:\\n if self.before is not None:\\n self._add_action_func(self.before)\\n self._add_action_func(lambda rs: DoAttempt())\\n return\\n\\n self.iter_state.is_explicit_retry = fut.failed and isinstance(\\n fut.exception(), TryAgain\\n )\\n if not self.iter_state.is_explicit_retry:\\n self._add_action_func(self._run_retry)\\n self._add_action_func(self._post_retry_check_actions)\\n\\n def _post_retry_check_actions(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if not (self.iter_state.is_explicit_retry or self.iter_state.retry_run_result):\\n self._add_action_func(lambda rs: rs.outcome.result())\\n return\\n\\n if self.after is not None:\\n self._add_action_func(self.after)\\n\\n self._add_action_func(self._run_wait)\\n self._add_action_func(self._run_stop)\\n self._add_action_func(self._post_stop_check_actions)\\n\\n def _post_stop_check_actions(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if self.iter_state.stop_run_result:\\n if self.retry_error_callback:\\n self._add_action_func(self.retry_error_callback)\\n return\\n\\n def exc_check(rs: \\\"RetryCallState\\\") -> None:\\n fut = t.cast(Future, rs.outcome)\\n retry_exc = self.retry_error_cls(fut)\\n if self.reraise:\\n raise retry_exc.reraise()\\n raise retry_exc from fut.exception()\\n\\n self._add_action_func(exc_check)\\n return\\n\\n def next_action(rs: \\\"RetryCallState\\\") -> None:\\n sleep = rs.upcoming_sleep\\n rs.next_action = RetryAction(sleep)\\n rs.idle_for += sleep\\n self.statistics[\\\"idle_for\\\"] += sleep\\n self.statistics[\\\"attempt_number\\\"] += 1\\n\\n self._add_action_func(next_action)\\n\\n if self.before_sleep is not None:\\n self._add_action_func(self.before_sleep)\\n\\n self._add_action_func(lambda rs: DoSleep(rs.upcoming_sleep))\\n\\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\\n self.begin()\\n\\n retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n yield AttemptManager(retry_state=retry_state)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n self.sleep(do)\\n else:\\n break\\n\\n @abstractmethod\\n def __call__(\\n self,\\n fn: t.Callable[..., WrappedFnReturnT],\\n *args: t.Any,\\n **kwargs: t.Any,\\n ) -> WrappedFnReturnT:\\n pass\\n\\n\\nclass Retrying(BaseRetrying):\\n \\\"\\\"\\\"Retrying controller.\\\"\\\"\\\"\\n\\n def __call__(\\n self,\\n fn: t.Callable[..., WrappedFnReturnT],\\n *args: t.Any,\\n **kwargs: t.Any,\\n ) -> WrappedFnReturnT:\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n self.sleep(do)\\n else:\\n return do # type: ignore[no-any-return]\\n\\n\\nif sys.version_info >= (3, 9):\\n FutureGenericT = futures.Future[t.Any]\\nelse:\\n FutureGenericT = futures.Future\\n\\n\\nclass Future(FutureGenericT):\\n \\\"\\\"\\\"Encapsulates a (future or past) attempted call to a target function.\\\"\\\"\\\"\\n\\n def __init__(self, attempt_number: int) -> None:\\n super().__init__()\\n self.attempt_number = attempt_number\\n\\n @property\\n def failed(self) -> bool:\\n \\\"\\\"\\\"Return whether a exception is being held in this future.\\\"\\\"\\\"\\n return self.exception() is not None\\n\\n @classmethod\\n def construct(\\n cls, attempt_number: int, value: t.Any, has_exception: bool\\n ) -> \\\"Future\\\":\\n \\\"\\\"\\\"Construct a new Future object.\\\"\\\"\\\"\\n fut = cls(attempt_number)\\n if has_exception:\\n fut.set_exception(value)\\n else:\\n fut.set_result(value)\\n return fut\\n\\n\\nclass RetryCallState:\\n \\\"\\\"\\\"State related to a single call wrapped with Retrying.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n retry_object: BaseRetrying,\\n fn: t.Optional[WrappedFn],\\n args: t.Any,\\n kwargs: t.Any,\\n ) -> None:\\n #: Retry call start timestamp\\n self.start_time = time.monotonic()\\n #: Retry manager object\\n self.retry_object = retry_object\\n #: Function wrapped by this retry call\\n self.fn = fn\\n #: Arguments of the function wrapped by this retry call\\n self.args = args\\n #: Keyword arguments of the function wrapped by this retry call\\n self.kwargs = kwargs\\n\\n #: The number of the current attempt\\n self.attempt_number: int = 1\\n #: Last outcome (result or exception) produced by the function\\n self.outcome: t.Optional[Future] = None\\n #: Timestamp of the last outcome\\n self.outcome_timestamp: t.Optional[float] = None\\n #: Time spent sleeping in retries\\n self.idle_for: float = 0.0\\n #: Next action as decided by the retry manager\\n self.next_action: t.Optional[RetryAction] = None\\n #: Next sleep time as decided by the retry manager.\\n self.upcoming_sleep: float = 0.0\\n\\n @property\\n def seconds_since_start(self) -> t.Optional[float]:\\n if self.outcome_timestamp is None:\\n return None\\n return self.outcome_timestamp - self.start_time\\n\\n def prepare_for_next_attempt(self) -> None:\\n self.outcome = None\\n self.outcome_timestamp = None\\n self.attempt_number += 1\\n self.next_action = None\\n\\n def set_result(self, val: t.Any) -> None:\\n ts = time.monotonic()\\n fut = Future(self.attempt_number)\\n fut.set_result(val)\\n self.outcome, self.outcome_timestamp = fut, ts\\n\\n def set_exception(\\n self,\\n exc_info: t.Tuple[\\n t.Type[BaseException], BaseException, \\\"types.TracebackType| None\\\"\\n ],\\n ) -> None:\\n ts = time.monotonic()\\n fut = Future(self.attempt_number)\\n fut.set_exception(exc_info[1])\\n self.outcome, self.outcome_timestamp = fut, ts\\n\\n def __repr__(self) -> str:\\n if self.outcome is None:\\n result = \\\"none yet\\\"\\n elif self.outcome.failed:\\n exception = self.outcome.exception()\\n result = f\\\"failed ({exception.__class__.__name__} {exception})\\\"\\n else:\\n result = f\\\"returned {self.outcome.result()}\\\"\\n\\n slept = float(round(self.idle_for, 2))\\n clsname = self.__class__.__name__\\n return f\\\"<{clsname} {id(self)}: attempt #{self.attempt_number}; slept for {slept}; last result: {result}>\\\"\\n\\n\\n@t.overload\\ndef retry(func: WrappedFn) -> WrappedFn: ...\\n\\n\\n@t.overload\\ndef retry(\\n sleep: t.Callable[[t.Union[int, float]], t.Union[None, t.Awaitable[None]]] = sleep,\\n stop: \\\"StopBaseT\\\" = stop_never,\\n wait: \\\"WaitBaseT\\\" = wait_none(),\\n retry: \\\"t.Union[RetryBaseT, tasyncio.retry.RetryBaseT]\\\" = retry_if_exception_type(),\\n before: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = before_nothing,\\n after: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = after_nothing,\\n before_sleep: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]]\\n ] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[\\\"RetryError\\\"] = RetryError,\\n retry_error_callback: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[t.Any, t.Awaitable[t.Any]]]\\n ] = None,\\n) -> t.Callable[[WrappedFn], WrappedFn]: ...\\n\\n\\ndef retry(*dargs: t.Any, **dkw: t.Any) -> t.Any:\\n \\\"\\\"\\\"Wrap a function with a new `Retrying` object.\\n\\n :param dargs: positional arguments passed to Retrying object\\n :param dkw: keyword arguments passed to the Retrying object\\n \\\"\\\"\\\"\\n # support both @retry and @retry() as valid syntax\\n if len(dargs) == 1 and callable(dargs[0]):\\n return retry()(dargs[0])\\n else:\\n\\n def wrap(f: WrappedFn) -> WrappedFn:\\n if isinstance(f, retry_base):\\n warnings.warn(\\n f\\\"Got retry_base instance ({f.__class__.__name__}) as callable argument, \\\"\\n f\\\"this will probably hang indefinitely (did you mean retry={f.__class__.__name__}(...)?)\\\"\\n )\\n r: \\\"BaseRetrying\\\"\\n if _utils.is_coroutine_callable(f):\\n r = AsyncRetrying(*dargs, **dkw)\\n elif (\\n tornado\\n and hasattr(tornado.gen, \\\"is_coroutine_function\\\")\\n and tornado.gen.is_coroutine_function(f)\\n ):\\n r = TornadoRetrying(*dargs, **dkw)\\n else:\\n r = Retrying(*dargs, **dkw)\\n\\n return r.wraps(f)\\n\\n return wrap\\n\\n\\nfrom tenacity.asyncio import AsyncRetrying # noqa:E402,I100\\n\\nif tornado:\\n from tenacity.tornadoweb import TornadoRetrying\\n\\n\\n__all__ = [\\n \\\"retry_base\\\",\\n \\\"retry_all\\\",\\n \\\"retry_always\\\",\\n \\\"retry_any\\\",\\n \\\"retry_if_exception\\\",\\n \\\"retry_if_exception_type\\\",\\n \\\"retry_if_exception_cause_type\\\",\\n \\\"retry_if_not_exception_type\\\",\\n \\\"retry_if_not_result\\\",\\n \\\"retry_if_result\\\",\\n \\\"retry_never\\\",\\n \\\"retry_unless_exception_type\\\",\\n \\\"retry_if_exception_message\\\",\\n \\\"retry_if_not_exception_message\\\",\\n \\\"sleep\\\",\\n \\\"sleep_using_event\\\",\\n \\\"stop_after_attempt\\\",\\n \\\"stop_after_delay\\\",\\n \\\"stop_before_delay\\\",\\n \\\"stop_all\\\",\\n \\\"stop_any\\\",\\n \\\"stop_never\\\",\\n \\\"stop_when_event_set\\\",\\n \\\"wait_chain\\\",\\n \\\"wait_combine\\\",\\n \\\"wait_exponential\\\",\\n \\\"wait_fixed\\\",\\n \\\"wait_incrementing\\\",\\n \\\"wait_none\\\",\\n \\\"wait_random\\\",\\n \\\"wait_random_exponential\\\",\\n \\\"wait_full_jitter\\\",\\n \\\"wait_exponential_jitter\\\",\\n \\\"before_log\\\",\\n \\\"before_nothing\\\",\\n \\\"after_log\\\",\\n \\\"after_nothing\\\",\\n \\\"before_sleep_log\\\",\\n \\\"before_sleep_nothing\\\",\\n \\\"retry\\\",\\n \\\"WrappedFn\\\",\\n \\\"TryAgain\\\",\\n \\\"NO_RESULT\\\",\\n \\\"DoAttempt\\\",\\n \\\"DoSleep\\\",\\n \\\"BaseAction\\\",\\n \\\"RetryAction\\\",\\n \\\"RetryError\\\",\\n \\\"AttemptManager\\\",\\n \\\"BaseRetrying\\\",\\n \\\"Retrying\\\",\\n \\\"Future\\\",\\n \\\"RetryCallState\\\",\\n \\\"AsyncRetrying\\\",\\n]\\n\\n[end of tenacity/__init__.py]\",\n \"filename\": \"tenacity/__init__.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport time\\nimport typing\\n\\nif typing.TYPE_CHECKING:\\n import threading\\n\\n\\ndef sleep(seconds: float) -> None:\\n \\\"\\\"\\\"\\n Sleep strategy that delays execution for a given number of seconds.\\n\\n This is the default strategy, and may be mocked out for unit testing.\\n \\\"\\\"\\\"\\n time.sleep(seconds)\\n\\n\\nclass sleep_using_event:\\n \\\"\\\"\\\"Sleep strategy that waits on an event to be set.\\\"\\\"\\\"\\n\\n def __init__(self, event: \\\"threading.Event\\\") -> None:\\n self.event = event\\n\\n def __call__(self, timeout: typing.Optional[float]) -> None:\\n # NOTE(harlowja): this may *not* actually wait for timeout\\n # seconds if the event is set (ie this may eject out early).\\n self.event.wait(timeout=timeout)\\n\\n[end of tenacity/nap.py]\",\n \"filename\": \"tenacity/nap.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef after_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"After call strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef after_log(\\n logger: \\\"logging.Logger\\\",\\n log_level: int,\\n sec_format: str = \\\"%0.3f\\\",\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"After call strategy that logs to some logger the finished attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n logger.log(\\n log_level,\\n f\\\"Finished call to '{fn_name}' \\\"\\n f\\\"after {sec_format % retry_state.seconds_since_start}(s), \\\"\\n f\\\"this was the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\\\",\\n )\\n\\n return log_it\\n\\n[end of tenacity/after.py]\",\n \"filename\": \"tenacity/after.py\",\n \"id\": \"16\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport abc\\nimport re\\nimport typing\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass retry_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for retry strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n pass\\n\\n def __and__(self, other: \\\"retry_base\\\") -> \\\"retry_all\\\":\\n return other.__rand__(self)\\n\\n def __rand__(self, other: \\\"retry_base\\\") -> \\\"retry_all\\\":\\n return retry_all(other, self)\\n\\n def __or__(self, other: \\\"retry_base\\\") -> \\\"retry_any\\\":\\n return other.__ror__(self)\\n\\n def __ror__(self, other: \\\"retry_base\\\") -> \\\"retry_any\\\":\\n return retry_any(other, self)\\n\\n\\nRetryBaseT = typing.Union[retry_base, typing.Callable[[\\\"RetryCallState\\\"], bool]]\\n\\n\\nclass _retry_never(retry_base):\\n \\\"\\\"\\\"Retry strategy that never rejects any result.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return False\\n\\n\\nretry_never = _retry_never()\\n\\n\\nclass _retry_always(retry_base):\\n \\\"\\\"\\\"Retry strategy that always rejects any result.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return True\\n\\n\\nretry_always = _retry_always()\\n\\n\\nclass retry_if_exception(retry_base):\\n \\\"\\\"\\\"Retry strategy that retries if an exception verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[BaseException], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n else:\\n return False\\n\\n\\nclass retry_if_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries if an exception has been raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: isinstance(e, exception_types))\\n\\n\\nclass retry_if_not_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries except an exception has been raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: not isinstance(e, exception_types))\\n\\n\\nclass retry_unless_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries until an exception is raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: not isinstance(e, exception_types))\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n # always retry if no exception was raised\\n if not retry_state.outcome.failed:\\n return True\\n\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n\\n\\nclass retry_if_exception_cause_type(retry_base):\\n \\\"\\\"\\\"Retries if any of the causes of the raised exception is of one or more types.\\n\\n The check on the type of the cause of the exception is done recursively (until finding\\n an exception in the chain that has no `__cause__`)\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_cause_types = exception_types\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__ called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exc = retry_state.outcome.exception()\\n while exc is not None:\\n if isinstance(exc.__cause__, self.exception_cause_types):\\n return True\\n exc = exc.__cause__\\n\\n return False\\n\\n\\nclass retry_if_result(retry_base):\\n \\\"\\\"\\\"Retries if the result verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_if_not_result(retry_base):\\n \\\"\\\"\\\"Retries if the result refutes a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return not self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_if_exception_message(retry_if_exception):\\n \\\"\\\"\\\"Retries if an exception message equals or matches.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: typing.Optional[str] = None,\\n match: typing.Optional[str] = None,\\n ) -> None:\\n if message and match:\\n raise TypeError(\\n f\\\"{self.__class__.__name__}() takes either 'message' or 'match', not both\\\"\\n )\\n\\n # set predicate\\n if message:\\n\\n def message_fnc(exception: BaseException) -> bool:\\n return message == str(exception)\\n\\n predicate = message_fnc\\n elif match:\\n prog = re.compile(match)\\n\\n def match_fnc(exception: BaseException) -> bool:\\n return bool(prog.match(str(exception)))\\n\\n predicate = match_fnc\\n else:\\n raise TypeError(\\n f\\\"{self.__class__.__name__}() missing 1 required argument 'message' or 'match'\\\"\\n )\\n\\n super().__init__(predicate)\\n\\n\\nclass retry_if_not_exception_message(retry_if_exception_message):\\n \\\"\\\"\\\"Retries until an exception message equals or matches.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: typing.Optional[str] = None,\\n match: typing.Optional[str] = None,\\n ) -> None:\\n super().__init__(message, match)\\n # invert predicate\\n if_predicate = self.predicate\\n self.predicate = lambda *args_, **kwargs_: not if_predicate(*args_, **kwargs_)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return True\\n\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n\\n\\nclass retry_any(retry_base):\\n \\\"\\\"\\\"Retries if any of the retries condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: retry_base) -> None:\\n self.retries = retries\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return any(r(retry_state) for r in self.retries)\\n\\n\\nclass retry_all(retry_base):\\n \\\"\\\"\\\"Retries if all the retries condition are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: retry_base) -> None:\\n self.retries = retries\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return all(r(retry_state) for r in self.retries)\\n\\n[end of tenacity/retry.py]\",\n \"filename\": \"tenacity/retry.py\",\n \"id\": \"17\"\n },\n {\n \"content\": \"[end of tenacity/py.typed]\",\n \"filename\": \"tenacity/py.typed\",\n \"id\": \"18\"\n },\n {\n \"content\": \"# Copyright 2017 Elisey Zanko\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport sys\\nimport typing\\n\\nfrom tenacity import BaseRetrying\\nfrom tenacity import DoAttempt\\nfrom tenacity import DoSleep\\nfrom tenacity import RetryCallState\\n\\nfrom tornado import gen\\n\\nif typing.TYPE_CHECKING:\\n from tornado.concurrent import Future\\n\\n_RetValT = typing.TypeVar(\\\"_RetValT\\\")\\n\\n\\nclass TornadoRetrying(BaseRetrying):\\n def __init__(\\n self,\\n sleep: \\\"typing.Callable[[float], Future[None]]\\\" = gen.sleep,\\n **kwargs: typing.Any,\\n ) -> None:\\n super().__init__(**kwargs)\\n self.sleep = sleep\\n\\n @gen.coroutine # type: ignore[misc]\\n def __call__(\\n self,\\n fn: \\\"typing.Callable[..., typing.Union[typing.Generator[typing.Any, typing.Any, _RetValT], Future[_RetValT]]]\\\",\\n *args: typing.Any,\\n **kwargs: typing.Any,\\n ) -> \\\"typing.Generator[typing.Any, typing.Any, _RetValT]\\\":\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = yield fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n yield self.sleep(do)\\n else:\\n raise gen.Return(do)\\n\\n[end of tenacity/tornadoweb.py]\",\n \"filename\": \"tenacity/tornadoweb.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport functools\\nimport inspect\\nimport sys\\nimport typing\\nfrom datetime import timedelta\\n\\n\\n# sys.maxsize:\\n# An integer giving the maximum value a variable of type Py_ssize_t can take.\\nMAX_WAIT = sys.maxsize / 2\\n\\n\\ndef find_ordinal(pos_num: int) -> str:\\n # See: https://en.wikipedia.org/wiki/English_numerals#Ordinal_numbers\\n if pos_num == 0:\\n return \\\"th\\\"\\n elif pos_num == 1:\\n return \\\"st\\\"\\n elif pos_num == 2:\\n return \\\"nd\\\"\\n elif pos_num == 3:\\n return \\\"rd\\\"\\n elif 4 <= pos_num <= 20:\\n return \\\"th\\\"\\n else:\\n return find_ordinal(pos_num % 10)\\n\\n\\ndef to_ordinal(pos_num: int) -> str:\\n return f\\\"{pos_num}{find_ordinal(pos_num)}\\\"\\n\\n\\ndef get_callback_name(cb: typing.Callable[..., typing.Any]) -> str:\\n \\\"\\\"\\\"Get a callback fully-qualified name.\\n\\n If no name can be produced ``repr(cb)`` is called and returned.\\n \\\"\\\"\\\"\\n segments = []\\n try:\\n segments.append(cb.__qualname__)\\n except AttributeError:\\n try:\\n segments.append(cb.__name__)\\n except AttributeError:\\n pass\\n if not segments:\\n return repr(cb)\\n else:\\n try:\\n # When running under sphinx it appears this can be none?\\n if cb.__module__:\\n segments.insert(0, cb.__module__)\\n except AttributeError:\\n pass\\n return \\\".\\\".join(segments)\\n\\n\\ntime_unit_type = typing.Union[int, float, timedelta]\\n\\n\\ndef to_seconds(time_unit: time_unit_type) -> float:\\n return float(\\n time_unit.total_seconds() if isinstance(time_unit, timedelta) else time_unit\\n )\\n\\n\\ndef is_coroutine_callable(call: typing.Callable[..., typing.Any]) -> bool:\\n if inspect.isclass(call):\\n return False\\n if inspect.iscoroutinefunction(call):\\n return True\\n partial_call = isinstance(call, functools.partial) and call.func\\n dunder_call = partial_call or getattr(call, \\\"__call__\\\", None)\\n return inspect.iscoroutinefunction(dunder_call)\\n\\n\\ndef wrap_to_async_func(\\n call: typing.Callable[..., typing.Any],\\n) -> typing.Callable[..., typing.Awaitable[typing.Any]]:\\n if is_coroutine_callable(call):\\n return call\\n\\n async def inner(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:\\n return call(*args, **kwargs)\\n\\n return inner\\n\\n[end of tenacity/_utils.py]\",\n \"filename\": \"tenacity/_utils.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport functools\\nimport sys\\nimport typing as t\\n\\nimport tenacity\\nfrom tenacity import AttemptManager\\nfrom tenacity import BaseRetrying\\nfrom tenacity import DoAttempt\\nfrom tenacity import DoSleep\\nfrom tenacity import RetryCallState\\nfrom tenacity import RetryError\\nfrom tenacity import after_nothing\\nfrom tenacity import before_nothing\\nfrom tenacity import _utils\\n\\n# Import all built-in retry strategies for easier usage.\\nfrom .retry import RetryBaseT\\nfrom .retry import retry_all # noqa\\nfrom .retry import retry_any # noqa\\nfrom .retry import retry_if_exception # noqa\\nfrom .retry import retry_if_result # noqa\\nfrom ..retry import RetryBaseT as SyncRetryBaseT\\n\\nif t.TYPE_CHECKING:\\n from tenacity.stop import StopBaseT\\n from tenacity.wait import WaitBaseT\\n\\nWrappedFnReturnT = t.TypeVar(\\\"WrappedFnReturnT\\\")\\nWrappedFn = t.TypeVar(\\\"WrappedFn\\\", bound=t.Callable[..., t.Awaitable[t.Any]])\\n\\n\\ndef _portable_async_sleep(seconds: float) -> t.Awaitable[None]:\\n # If trio is already imported, then importing it is cheap.\\n # If trio isn't already imported, then it's definitely not running, so we\\n # can skip further checks.\\n if \\\"trio\\\" in sys.modules:\\n # If trio is available, then sniffio is too\\n import trio\\n import sniffio\\n\\n if sniffio.current_async_library() == \\\"trio\\\":\\n return trio.sleep(seconds)\\n # Otherwise, assume asyncio\\n # Lazy import asyncio as it's expensive (responsible for 25-50% of total import overhead).\\n import asyncio\\n\\n return asyncio.sleep(seconds)\\n\\n\\nclass AsyncRetrying(BaseRetrying):\\n def __init__(\\n self,\\n sleep: t.Callable[\\n [t.Union[int, float]], t.Union[None, t.Awaitable[None]]\\n ] = _portable_async_sleep,\\n stop: \\\"StopBaseT\\\" = tenacity.stop.stop_never,\\n wait: \\\"WaitBaseT\\\" = tenacity.wait.wait_none(),\\n retry: \\\"t.Union[SyncRetryBaseT, RetryBaseT]\\\" = tenacity.retry_if_exception_type(),\\n before: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = before_nothing,\\n after: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = after_nothing,\\n before_sleep: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]]\\n ] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[\\\"RetryError\\\"] = RetryError,\\n retry_error_callback: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[t.Any, t.Awaitable[t.Any]]]\\n ] = None,\\n ) -> None:\\n super().__init__(\\n sleep=sleep, # type: ignore[arg-type]\\n stop=stop,\\n wait=wait,\\n retry=retry, # type: ignore[arg-type]\\n before=before, # type: ignore[arg-type]\\n after=after, # type: ignore[arg-type]\\n before_sleep=before_sleep, # type: ignore[arg-type]\\n reraise=reraise,\\n retry_error_cls=retry_error_cls,\\n retry_error_callback=retry_error_callback,\\n )\\n\\n async def __call__( # type: ignore[override]\\n self, fn: WrappedFn, *args: t.Any, **kwargs: t.Any\\n ) -> WrappedFnReturnT:\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = await self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = await fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n await self.sleep(do) # type: ignore[misc]\\n else:\\n return do # type: ignore[no-any-return]\\n\\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\\n self.iter_state.actions.append(_utils.wrap_to_async_func(fn))\\n\\n async def _run_retry(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n self.iter_state.retry_run_result = await _utils.wrap_to_async_func(self.retry)(\\n retry_state\\n )\\n\\n async def _run_wait(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n if self.wait:\\n sleep = await _utils.wrap_to_async_func(self.wait)(retry_state)\\n else:\\n sleep = 0.0\\n\\n retry_state.upcoming_sleep = sleep\\n\\n async def _run_stop(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n self.statistics[\\\"delay_since_first_attempt\\\"] = retry_state.seconds_since_start\\n self.iter_state.stop_run_result = await _utils.wrap_to_async_func(self.stop)(\\n retry_state\\n )\\n\\n async def iter(\\n self, retry_state: \\\"RetryCallState\\\"\\n ) -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa: A003\\n self._begin_iter(retry_state)\\n result = None\\n for action in self.iter_state.actions:\\n result = await action(retry_state)\\n return result\\n\\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\\n raise TypeError(\\\"AsyncRetrying object is not iterable\\\")\\n\\n def __aiter__(self) -> \\\"AsyncRetrying\\\":\\n self.begin()\\n self._retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\\n return self\\n\\n async def __anext__(self) -> AttemptManager:\\n while True:\\n do = await self.iter(retry_state=self._retry_state)\\n if do is None:\\n raise StopAsyncIteration\\n elif isinstance(do, DoAttempt):\\n return AttemptManager(retry_state=self._retry_state)\\n elif isinstance(do, DoSleep):\\n self._retry_state.prepare_for_next_attempt()\\n await self.sleep(do) # type: ignore[misc]\\n else:\\n raise StopAsyncIteration\\n\\n def wraps(self, fn: WrappedFn) -> WrappedFn:\\n wrapped = super().wraps(fn)\\n # Ensure wrapper is recognized as a coroutine function.\\n\\n @functools.wraps(\\n fn, functools.WRAPPER_ASSIGNMENTS + (\\\"__defaults__\\\", \\\"__kwdefaults__\\\")\\n )\\n async def async_wrapped(*args: t.Any, **kwargs: t.Any) -> t.Any:\\n # Always create a copy to prevent overwriting the local contexts when\\n # calling the same wrapped functions multiple times in the same stack\\n copy = self.copy()\\n async_wrapped.statistics = copy.statistics # type: ignore[attr-defined]\\n return await copy(fn, *args, **kwargs)\\n\\n # Preserve attributes\\n async_wrapped.retry = self # type: ignore[attr-defined]\\n async_wrapped.retry_with = wrapped.retry_with # type: ignore[attr-defined]\\n async_wrapped.statistics = {} # type: ignore[attr-defined]\\n\\n return async_wrapped # type: ignore[return-value]\\n\\n\\n__all__ = [\\n \\\"retry_all\\\",\\n \\\"retry_any\\\",\\n \\\"retry_if_exception\\\",\\n \\\"retry_if_result\\\",\\n \\\"WrappedFn\\\",\\n \\\"AsyncRetrying\\\",\\n]\\n\\n[end of tenacity/asyncio/__init__.py]\",\n \"filename\": \"tenacity/asyncio/__init__.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport abc\\nimport typing\\n\\nfrom tenacity import _utils\\nfrom tenacity import retry_base\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass async_retry_base(retry_base):\\n \\\"\\\"\\\"Abstract base class for async retry strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n pass\\n\\n def __and__( # type: ignore[override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_all\\\":\\n return retry_all(self, other)\\n\\n def __rand__( # type: ignore[misc,override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_all\\\":\\n return retry_all(other, self)\\n\\n def __or__( # type: ignore[override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_any\\\":\\n return retry_any(self, other)\\n\\n def __ror__( # type: ignore[misc,override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_any\\\":\\n return retry_any(other, self)\\n\\n\\nRetryBaseT = typing.Union[\\n async_retry_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Awaitable[bool]]\\n]\\n\\n\\nclass retry_if_exception(async_retry_base):\\n \\\"\\\"\\\"Retry strategy that retries if an exception verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(\\n self, predicate: typing.Callable[[BaseException], typing.Awaitable[bool]]\\n ) -> None:\\n self.predicate = predicate\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return await self.predicate(exception)\\n else:\\n return False\\n\\n\\nclass retry_if_result(async_retry_base):\\n \\\"\\\"\\\"Retries if the result verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(\\n self, predicate: typing.Callable[[typing.Any], typing.Awaitable[bool]]\\n ) -> None:\\n self.predicate = predicate\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return await self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_any(async_retry_base):\\n \\\"\\\"\\\"Retries if any of the retries condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\\n self.retries = retries\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n result = False\\n for r in self.retries:\\n result = result or await _utils.wrap_to_async_func(r)(retry_state)\\n if result:\\n break\\n return result\\n\\n\\nclass retry_all(async_retry_base):\\n \\\"\\\"\\\"Retries if all the retries condition are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\\n self.retries = retries\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n result = True\\n for r in self.retries:\\n result = result and await _utils.wrap_to_async_func(r)(retry_state)\\n if not result:\\n break\\n return result\\n\\n[end of tenacity/asyncio/retry.py]\",\n \"filename\": \"tenacity/asyncio/retry.py\",\n \"id\": \"22\"\n },\n {\n \"content\": \"Tenacity\\n========\\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\\n :target: https://pypi.python.org/pypi/tenacity\\n\\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\\n :target: https://circleci.com/gh/jd/tenacity\\n\\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\\n :target: https://mergify.io\\n :alt: Mergify Status\\n\\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\\n\\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\\nPython, to simplify the task of adding retry behavior to just about anything.\\nIt originates from `a fork of retrying\\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\\napi compatible with retrying but adds significant new functionality and\\nfixes a number of longstanding bugs.\\n\\nThe simplest use case is retrying a flaky function whenever an `Exception`\\noccurs until a value is returned.\\n\\n.. testcode::\\n\\n import random\\n from tenacity import retry\\n\\n @retry\\n def do_something_unreliable():\\n if random.randint(0, 10) > 1:\\n raise IOError(\\\"Broken sauce, everything is hosed!!!111one\\\")\\n else:\\n return \\\"Awesome sauce!\\\"\\n\\n print(do_something_unreliable())\\n\\n.. testoutput::\\n :hide:\\n\\n Awesome sauce!\\n\\n\\n.. toctree::\\n :hidden:\\n :maxdepth: 2\\n\\n changelog\\n api\\n\\n\\nFeatures\\n--------\\n\\n- Generic Decorator API\\n- Specify stop condition (i.e. limit by number of attempts)\\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\\n- Customize retrying on Exceptions\\n- Customize retrying on expected returned result\\n- Retry on coroutines\\n- Retry code block with context manager\\n\\n\\nInstallation\\n------------\\n\\nTo install *tenacity*, simply:\\n\\n.. code-block:: bash\\n\\n $ pip install tenacity\\n\\n\\nExamples\\n----------\\n\\nBasic Retry\\n~~~~~~~~~~~\\n\\n.. testsetup::\\n\\n import logging\\n #\\n # Note the following import is used for demonstration convenience only.\\n # Production code should always explicitly import the names it needs.\\n #\\n from tenacity import *\\n\\n class MyException(Exception):\\n pass\\n\\nAs you saw above, the default behavior is to retry forever without waiting when\\nan exception is raised.\\n\\n.. testcode::\\n\\n @retry\\n def never_gonna_give_you_up():\\n print(\\\"Retry forever ignoring Exceptions, don't wait between retries\\\")\\n raise Exception\\n\\nStopping\\n~~~~~~~~\\n\\nLet's be a little less persistent and set some boundaries, such as the number\\nof attempts before giving up.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(7))\\n def stop_after_7_attempts():\\n print(\\\"Stopping after 7 attempts\\\")\\n raise Exception\\n\\nWe don't have all day, so let's set a boundary for how long we should be\\nretrying stuff.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_delay(10))\\n def stop_after_10_s():\\n print(\\\"Stopping after 10 seconds\\\")\\n raise Exception\\n\\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\\nthen you can give up on retries one attempt before you would exceed the delay.\\n\\n.. testcode::\\n\\n @retry(stop=stop_before_delay(10))\\n def stop_before_10_s():\\n print(\\\"Stopping 1 attempt before 10 seconds\\\")\\n raise Exception\\n\\nYou can combine several stop conditions by using the `|` operator:\\n\\n.. testcode::\\n\\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\\n def stop_after_10_s_or_5_retries():\\n print(\\\"Stopping after 10 seconds or 5 retries\\\")\\n raise Exception\\n\\nWaiting before retrying\\n~~~~~~~~~~~~~~~~~~~~~~~\\n\\nMost things don't like to be polled as fast as possible, so let's just wait 2\\nseconds between retries.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(2))\\n def wait_2_s():\\n print(\\\"Wait 2 second between retries\\\")\\n raise Exception\\n\\nSome things perform best with a bit of randomness injected.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random(min=1, max=2))\\n def wait_random_1_to_2_s():\\n print(\\\"Randomly wait 1 to 2 seconds between retries\\\")\\n raise Exception\\n\\nThen again, it's hard to beat exponential backoff when retrying distributed\\nservices and other remote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\\n def wait_exponential_1():\\n print(\\\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\\\")\\n raise Exception\\n\\n\\nThen again, it's also hard to beat combining fixed waits and jitter (to\\nhelp avoid thundering herds) when retrying distributed services and other\\nremote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\\n def wait_fixed_jitter():\\n print(\\\"Wait at least 3 seconds, and add up to 2 seconds of random delay\\\")\\n raise Exception\\n\\nWhen multiple processes are in contention for a shared resource, exponentially\\nincreasing jitter helps minimise collisions.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\\n def wait_exponential_jitter():\\n print(\\\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\\\")\\n raise Exception\\n\\n\\nSometimes it's necessary to build a chain of backoffs.\\n\\n.. testcode::\\n\\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\\n [wait_fixed(7) for i in range(2)] +\\n [wait_fixed(9)]))\\n def wait_fixed_chained():\\n print(\\\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\\\")\\n raise Exception\\n\\nWhether to retry\\n~~~~~~~~~~~~~~~~\\n\\nWe have a few options for dealing with retries that raise specific or general\\nexceptions, as in the cases here.\\n\\n.. testcode::\\n\\n class ClientError(Exception):\\n \\\"\\\"\\\"Some type of client error.\\\"\\\"\\\"\\n\\n @retry(retry=retry_if_exception_type(IOError))\\n def might_io_error():\\n print(\\\"Retry forever with no wait if an IOError occurs, raise any other errors\\\")\\n raise Exception\\n\\n @retry(retry=retry_if_not_exception_type(ClientError))\\n def might_client_error():\\n print(\\\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\\\")\\n raise Exception\\n\\nWe can also use the result of the function to alter the behavior of retrying.\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=retry_if_result(is_none_p))\\n def might_return_none():\\n print(\\\"Retry with no wait if return value is None\\\")\\n\\nSee also these methods:\\n\\n.. testcode::\\n\\n retry_if_exception\\n retry_if_exception_type\\n retry_if_not_exception_type\\n retry_unless_exception_type\\n retry_if_result\\n retry_if_not_result\\n retry_if_exception_message\\n retry_if_not_exception_message\\n retry_any\\n retry_all\\n\\nWe can also combine several conditions:\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\\n def might_return_none():\\n print(\\\"Retry forever ignoring Exceptions with no wait if return value is None\\\")\\n\\nAny combination of stop, wait, etc. is also supported to give you the freedom\\nto mix and match.\\n\\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\\nexception:\\n\\n.. testcode::\\n\\n @retry\\n def do_something():\\n result = something_else()\\n if result == 23:\\n raise TryAgain\\n\\nError Handling\\n~~~~~~~~~~~~~~\\n\\nNormally when your function fails its final time (and will not be retried again based on your settings),\\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\\nof the stack trace.\\n\\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\\nis most visible), you can set `reraise=True`.\\n\\n.. testcode::\\n\\n @retry(reraise=True, stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except MyException:\\n # timed out retrying\\n pass\\n\\nBefore and After Retry, and Logging\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's possible to execute an action before any attempt of calling the function\\nby using the before callback function:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIn the same spirit, It's possible to execute after a call that failed:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIt's also possible to only log failures that are going to be retried. Normally\\nretries happen after a wait interval, so the keyword argument is called\\n``before_sleep``:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3),\\n before_sleep=before_sleep_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n\\nStatistics\\n~~~~~~~~~~\\n\\nYou can access the statistics about the retry made over a function by using the\\n`statistics` attribute attached to the function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nCustom Callbacks\\n~~~~~~~~~~~~~~~~\\n\\nYou can also define your own callbacks. The callback should accept one\\nparameter called ``retry_state`` that contains all information about current\\nretry invocation.\\n\\nFor example, you can call a custom callback function after all retries failed,\\nwithout raising an exception (or you can re-raise or do anything really)\\n\\n.. testcode::\\n\\n def return_last_value(retry_state):\\n \\\"\\\"\\\"return the result of the last call attempt\\\"\\\"\\\"\\n return retry_state.outcome.result()\\n\\n def is_false(value):\\n \\\"\\\"\\\"Return True if value is False\\\"\\\"\\\"\\n return value is False\\n\\n # will return False after trying 3 times to get a different result\\n @retry(stop=stop_after_attempt(3),\\n retry_error_callback=return_last_value,\\n retry=retry_if_result(is_false))\\n def eventually_return_false():\\n return False\\n\\nRetryCallState\\n~~~~~~~~~~~~~~\\n\\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\\n\\nOther Custom Callbacks\\n~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's also possible to define custom callbacks for other keyword arguments.\\n\\n.. function:: my_stop(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should stop\\n :rtype: bool\\n\\n.. function:: my_wait(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: number of seconds to wait before next retry\\n :rtype: float\\n\\n.. function:: my_retry(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should continue\\n :rtype: bool\\n\\n.. function:: my_before(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_after(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_before_sleep(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\nHere's an example with a custom ``before_sleep`` function:\\n\\n.. testcode::\\n\\n import logging\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n def my_before_sleep(retry_state):\\n if retry_state.attempt_number < 1:\\n loglevel = logging.INFO\\n else:\\n loglevel = logging.WARNING\\n logger.log(\\n loglevel, 'Retrying %s: attempt %s ended with: %s',\\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\\n\\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except RetryError:\\n pass\\n\\n\\nChanging Arguments at Run Time\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nYou can change the arguments of a retry decorator as needed when calling it by\\nusing the `retry_with` function attached to the wrapped function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nIf you want to use variables to set up the retry parameters, you don't have\\nto use the `retry` decorator - you can instead use `Retrying` directly:\\n\\n.. testcode::\\n\\n def never_good_enough(arg1):\\n raise Exception('Invalid argument: {}'.format(arg1))\\n\\n def try_never_good_enough(max_attempts=3):\\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\\n retryer(never_good_enough, 'I really do try')\\n\\nYou may also want to change the behaviour of a decorated function temporarily,\\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\\nattribute attached to the function. Bear in mind this is a write-only attribute,\\nstatistics should be read from the function `statistics` attribute.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n from unittest import mock\\n\\n with mock.patch.object(raise_my_exception.retry, \\\"wait\\\", wait_fixed(0)):\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nRetrying code block\\n~~~~~~~~~~~~~~~~~~~\\n\\nTenacity allows you to retry a code block without the need to wraps it in an\\nisolated function. This makes it easy to isolate failing block while sharing\\ncontext. The trick is to combine a for loop and a context manager.\\n\\n.. testcode::\\n\\n from tenacity import Retrying, RetryError, stop_after_attempt\\n\\n try:\\n for attempt in Retrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nYou can configure every details of retry policy by configuring the Retrying\\nobject.\\n\\nWith async code you can use AsyncRetrying.\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\\n\\n async def function():\\n try:\\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nIn both cases, you may want to set the result to the attempt so it's available\\nin retry strategies like ``retry_if_result``. This can be done accessing the\\n``retry_state`` property:\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, retry_if_result\\n\\n async def function():\\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\\n with attempt:\\n result = 1 # Some complex calculation, function call, etc.\\n if not attempt.retry_state.outcome.failed:\\n attempt.retry_state.set_result(result)\\n return result\\n\\nAsync and retry\\n~~~~~~~~~~~~~~~\\n\\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\\nSleeps are done asynchronously too.\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_asyncio_function(loop):\\n await loop.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_async_trio_function():\\n await trio.socket.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n @tornado.gen.coroutine\\n def my_async_tornado_function(http_client, url):\\n yield http_client.fetch(url)\\n\\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\\n\\n.. code-block:: python\\n\\n @retry(sleep=curio.sleep)\\n async def my_async_curio_function():\\n await asks.get('https://example.org')\\n\\nContribute\\n----------\\n\\n#. Check for open issues or open a fresh issue to start a discussion around a\\n feature idea or a bug.\\n#. Fork `the repository`_ on GitHub to start making your changes to the\\n **main** branch (or branch off of it).\\n#. Write a test which shows that the bug was fixed or that the feature works as\\n expected.\\n#. Add a `changelog <#Changelogs>`_\\n#. Make the docs better (or more detailed, or more easier to read, or ...)\\n\\n.. _`the repository`: https://github.com/jd/tenacity\\n\\nChangelogs\\n~~~~~~~~~~\\n\\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\\n\\nThe doc generation will automatically compile the changelogs. You just need to add them.\\n\\n.. code-block:: sh\\n\\n # Opens a template file in an editor\\n tox -e reno -- new some-slug-for-my-change --edit\\n\\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\\n\\n[end of doc/source/index.rst]\",\n \"filename\": \"doc/source/index.rst\",\n \"id\": \"23\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport os\\nimport sys\\n\\nmaster_doc = \\\"index\\\"\\nproject = \\\"Tenacity\\\"\\n\\n# Add tenacity to the path, so sphinx can find the functions for autodoc.\\nsys.path.insert(0, os.path.abspath(\\\"../..\\\"))\\n\\nextensions = [\\n \\\"sphinx.ext.doctest\\\",\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"reno.sphinxext\\\",\\n]\\n\\n# -- Options for sphinx.ext.doctest -----------------------------------------\\n\\n# doctest_default_flags =\\ncwd = os.path.abspath(os.path.dirname(__file__))\\ntenacity_path = os.path.join(cwd, os.pardir, os.pardir)\\ndoctest_path = [tenacity_path]\\n# doctest_global_setup =\\n# doctest_global_cleanup =\\n# doctest_test_doctest_blocks =\\n\\n[end of doc/source/conf.py]\",\n \"filename\": \"doc/source/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"Changelog\\n=========\\n\\n.. release-notes::\\n\\n[end of doc/source/changelog.rst]\",\n \"filename\": \"doc/source/changelog.rst\",\n \"id\": \"25\"\n },\n {\n \"content\": \"===============\\n API Reference\\n===============\\n\\nRetry Main API\\n--------------\\n\\n.. autofunction:: tenacity.retry\\n :noindex:\\n\\n.. autoclass:: tenacity.Retrying\\n :members:\\n\\n.. autoclass:: tenacity.AsyncRetrying\\n :members:\\n\\n.. autoclass:: tenacity.tornadoweb.TornadoRetrying\\n :members:\\n\\n.. autoclass:: tenacity.RetryCallState\\n :members:\\n\\nAfter Functions\\n---------------\\n\\nThose functions can be used as the `after` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.after\\n :members:\\n\\nBefore Functions\\n----------------\\n\\nThose functions can be used as the `before` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.before\\n :members:\\n\\nBefore Sleep Functions\\n----------------------\\n\\nThose functions can be used as the `before_sleep` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.before_sleep\\n :members:\\n\\nNap Functions\\n-------------\\n\\nThose functions can be used as the `sleep` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.nap\\n :members:\\n\\nRetry Functions\\n---------------\\n\\nThose functions can be used as the `retry` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.retry\\n :members:\\n\\nStop Functions\\n--------------\\n\\nThose functions can be used as the `stop` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.stop\\n :members:\\n\\nWait Functions\\n--------------\\n\\nThose functions can be used as the `wait` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.wait\\n :members:\\n\\n[end of doc/source/api.rst]\",\n \"filename\": \"doc/source/api.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"---\\nupgrade:\\n - |\\n Support for Python 3.6 has been removed.\\n\\n[end of releasenotes/notes/remove-py36-876c0416cf279d15.yaml]\",\n \"filename\": \"releasenotes/notes/remove-py36-876c0416cf279d15.yaml\",\n \"id\": \"27\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Fix async loop with retrying code block when result is available.\\n\\n[end of releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml]\",\n \"filename\": \"releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml\",\n \"id\": \"28\"\n },\n {\n \"content\": \"---\\nupgrade:\\n - \\\"Removed `BaseRetrying.call`: was long time deprecated and produced `DeprecationWarning`\\\"\\n - \\\"Removed `BaseRetrying.fn`: was noted as deprecated\\\"\\n - \\\"API change: `BaseRetrying.begin()` do not require arguments anymore as it not setting `BaseRetrying.fn`\\\"\\n\\n[end of releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml]\",\n \"filename\": \"releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml\",\n \"id\": \"29\"\n },\n {\n \"content\": \"---\\nfixes:\\n - Fix setuptools config to include tenacity.asyncio package in release distributions.\\n\\n[end of releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml]\",\n \"filename\": \"releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml\",\n \"id\": \"30\"\n },\n {\n \"content\": \"---\\nother:\\n - Add a \\\\\\\"test\\\\\\\" extra\\n\\n[end of releasenotes/notes/add-test-extra-55e869261b03e56d.yaml]\",\n \"filename\": \"releasenotes/notes/add-test-extra-55e869261b03e56d.yaml\",\n \"id\": \"31\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Use str.format to format the logs internally to make logging compatible with other logger such as loguru.\\n\\n[end of releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml]\",\n \"filename\": \"releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml\",\n \"id\": \"32\"\n },\n {\n \"content\": \"---\\nother:\\n - Unit tests can now mock ``nap.sleep()`` for testing in all tenacity usage styles\\n[end of releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml]\",\n \"filename\": \"releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml\",\n \"id\": \"33\"\n },\n {\n \"content\": \"---\\nfixes:\\n - \\\"Fix after_log logger format: function name was used with delay formatting.\\\"\\n\\n[end of releasenotes/notes/after_log-50f4d73b24ce9203.yaml]\",\n \"filename\": \"releasenotes/notes/after_log-50f4d73b24ce9203.yaml\",\n \"id\": \"34\"\n },\n {\n \"content\": \"---\\nother:\\n - \\\"Use `black` for code formatting and validate using `black --check`. Code compatibility: py26-py39.\\\"\\n - \\\"Enforce maximal line length to 120 symbols\\\"\\n\\n[end of releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml]\",\n \"filename\": \"releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml\",\n \"id\": \"35\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Preserve __defaults__ and __kwdefaults__ through retry decorator\\n\\n[end of releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml]\",\n \"filename\": \"releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml\",\n \"id\": \"36\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add ``retry_if_not_exception_type()`` that allows to retry if a raised exception doesn't match given exceptions.\\n\\n[end of releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml]\",\n \"filename\": \"releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml\",\n \"id\": \"37\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Argument `wait` was improperly annotated, making mypy checks fail.\\n Now it's annotated as `typing.Union[wait_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Union[float, int]]]`\\n\\n[end of releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml]\",\n \"filename\": \"releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml\",\n \"id\": \"38\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Explicitly export convenience symbols from tenacity root module\\n\\n[end of releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml]\",\n \"filename\": \"releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml\",\n \"id\": \"39\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add ``datetime.timedelta`` as accepted wait unit type.\\n\\n[end of releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml]\",\n \"filename\": \"releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml\",\n \"id\": \"40\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Add a Dependabot configuration submit PRs monthly (as needed)\\n to keep GitHub action versions updated.\\n\\n[end of releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml]\",\n \"filename\": \"releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml\",\n \"id\": \"41\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Add a new `retry_base` class called `retry_if_exception_cause_type` that\\n checks, recursively, if any of the causes of the raised exception is of a certain type.\\n\\n[end of releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml]\",\n \"filename\": \"releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml\",\n \"id\": \"42\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Added the ability to use async functions for retries. This way, you can now use\\n asyncio coroutines for retry strategy predicates.\\n\\n[end of releasenotes/notes/add-async-actions-b249c527d99723bb.yaml]\",\n \"filename\": \"releasenotes/notes/add-async-actions-b249c527d99723bb.yaml\",\n \"id\": \"43\"\n },\n {\n \"content\": \"---\\nprelude: >\\n Clarify usage of `reraise` keyword argument\\n\\n[end of releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml]\",\n \"filename\": \"releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml\",\n \"id\": \"44\"\n },\n {\n \"content\": \"---\\nfixes: Sphinx build error where Sphinx complains about an undefined class.\\n\\n[end of releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml]\",\n \"filename\": \"releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml\",\n \"id\": \"45\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add reno (changelog system)\\n\\n[end of releasenotes/notes/add-reno-d1ab5710f272650a.yaml]\",\n \"filename\": \"releasenotes/notes/add-reno-d1ab5710f272650a.yaml\",\n \"id\": \"46\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Avoid overwriting local contexts when applying the retry decorator.\\n\\n[end of releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml]\",\n \"filename\": \"releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml\",\n \"id\": \"47\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Most part of the code is type annotated.\\n - Python 3.10 support has been added.\\n\\n[end of releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml]\",\n \"filename\": \"releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml\",\n \"id\": \"48\"\n },\n {\n \"content\": \"---\\nother:\\n - Add type annotations to cover all public API.\\n\\n[end of releasenotes/notes/annotate_code-197b93130df14042.yaml]\",\n \"filename\": \"releasenotes/notes/annotate_code-197b93130df14042.yaml\",\n \"id\": \"49\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n `AsyncRetrying` was erroneously implementing `__iter__()`, making tenacity\\n retrying mechanism working but in a synchronous fashion and not waiting as\\n expected. This interface has been removed, `__aiter__()` should be used\\n instead.\\n\\n[end of releasenotes/notes/no-async-iter-6132a42e52348a75.yaml]\",\n \"filename\": \"releasenotes/notes/no-async-iter-6132a42e52348a75.yaml\",\n \"id\": \"50\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Added a new stop function: stop_before_delay, which will stop execution\\n if the next sleep time would cause overall delay to exceed the specified delay. \\n Useful for use cases where you have some upper bound on retry times that you must\\n not exceed, so returning before that timeout is preferable than returning after that timeout.\\n[end of releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml]\",\n \"filename\": \"releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml\",\n \"id\": \"51\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n If you're using `Trio <https://trio.readthedocs.io>`__, then\\n ``@retry`` now works automatically. It's no longer necessary to\\n pass ``sleep=trio.sleep``.\\n\\n[end of releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml]\",\n \"filename\": \"releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml\",\n \"id\": \"52\"\n },\n {\n \"content\": \"---\\nother: >-\\n Corrected the PyPI-published wheel tag to match the\\n metadata saying that the release is Python 3 only.\\n...\\n\\n[end of releasenotes/notes/pr320-py3-only-wheel-tag.yaml]\",\n \"filename\": \"releasenotes/notes/pr320-py3-only-wheel-tag.yaml\",\n \"id\": \"53\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n - accept ``datetime.timedelta`` instances as argument to ``tenacity.stop.stop_after_delay``\\n\\n[end of releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml]\",\n \"filename\": \"releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml\",\n \"id\": \"54\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Restore the value of the `retry` attribute for wrapped functions. Also,\\n clarify that those attributes are write-only and statistics should be\\n read from the function attribute directly.\\n\\n[end of releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml]\",\n \"filename\": \"releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml\",\n \"id\": \"55\"\n },\n {\n \"content\": \"---\\nfixes:\\n - \\\"Fix issue #288 : __name__ and other attributes for async functions\\\"\\n\\n[end of releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml]\",\n \"filename\": \"releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml\",\n \"id\": \"56\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Added a link to the documentation, as code snippets are not being rendered properly\\n Changed branch name to main in index.rst\\n\\n[end of releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml]\",\n \"filename\": \"releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml\",\n \"id\": \"57\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Respects `min` arg for `wait_random_exponential`\\n\\n[end of releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml]\",\n \"filename\": \"releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml\",\n \"id\": \"58\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add a ``__repr__`` method to ``RetryCallState`` objects for easier debugging.\\n\\n[end of releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml]\",\n \"filename\": \"releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml\",\n \"id\": \"59\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Drop support for deprecated Python versions (2.7 and 3.5)\\n\\n[end of releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml]\",\n \"filename\": \"releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml\",\n \"id\": \"60\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add an ``exc_info`` option to the ``before_sleep_log()`` strategy.\\n[end of releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml]\",\n \"filename\": \"releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml\",\n \"id\": \"61\"\n },\n {\n \"content\": \"---\\nother:\\n - Add `retry_if_exception_cause_type`and `wait_exponential_jitter` to __all__ of init.py\\n[end of releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml]\",\n \"filename\": \"releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml\",\n \"id\": \"62\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Implement a wait.wait_exponential_jitter per Google's storage retry guide.\\n See https://cloud.google.com/storage/docs/retry-strategy\\n\\n[end of releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml]\",\n \"filename\": \"releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml\",\n \"id\": \"63\"\n }\n]","isConversational":false}}},{"rowIdx":68,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 68,\n \"num_files\": 64,\n \"repo_id\": \"repo_0068\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"queue_rules:\n - name: default\n merge_method: squash\n queue_conditions:\n - or:\n - author = jd\n - \"#approved-reviews-by >= 1\"\n - author = dependabot[bot]\n - or:\n - files ~= ^releasenotes/notes/\n - label = no-changelog\n - author = dependabot[bot]\n - \"check-success=test (3.9, py39)\"\n - \"check-success=test (3.10, py310)\"\n - \"check-success=test (3.11, py311)\"\n - \"check-success=test (3.12, py312)\"\n - \"check-success=test (3.13, py313,py313-trio)\"\n - \"check-success=test (3.12, pep8)\"\n\npull_request_rules:\n - name: warn on no changelog\n conditions:\n - -files~=^releasenotes/notes/\n - label!=no-changelog\n - -closed\n actions:\n comment:\n message: >\n ⚠️ No release notes detected. Please make sure to use\n [reno](https://docs.openstack.org/reno/latest/user/usage.html) to add\n a changelog entry.\n\n - name: automatic queue\n conditions: []\n actions:\n queue:\n\n - name: dismiss reviews\n conditions: []\n actions:\n dismiss_reviews: {}\n\n[end of .mergify.yml]","filename":".mergify.yml","id":"0"},{"content":"---\nunreleased_version_title: Unreleased\n\n[end of reno.yaml]","filename":"reno.yaml","id":"1"},{"content":"Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\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[end of LICENSE]","filename":"LICENSE","id":"2"},{"content":"[build-system]\n# Minimum requirements for the build system to execute.\n# PEP 508 specifications for PEP 518.\n# Banned setuptools versions have well-known issues\nrequires = [\n \"setuptools >= 21.0.0,!=24.0.0,!=34.0.0,!=34.0.1,!=34.0.2,!=34.0.3,!=34.1.0,!=34.1.1,!=34.2.0,!=34.3.0,!=34.3.1,!=34.3.2,!=36.2.0\", # PSF/ZPL\n \"setuptools_scm[toml]>=3.4\",\n]\nbuild-backend=\"setuptools.build_meta\"\n\n[tool.ruff]\nline-length = 88\nindent-width = 4\ntarget-version = \"py39\"\n\n[tool.mypy]\nstrict = true\nfiles = [\"tenacity\", \"tests\"]\nshow_error_codes = true\n\n[[tool.mypy.overrides]]\nmodule = \"tornado.*\"\nignore_missing_imports = true\n\n[tool.setuptools_scm]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"version: 2\npython:\n install:\n - method: pip\n path: .\n extra_requirements:\n - doc\n\n[end of .readthedocs.yml]","filename":".readthedocs.yml","id":"4"},{"content":"root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\nindent_size = 2\nindent_style = space\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.{py,pyx,pxd,pyi}]\nindent_size = 4\nmax_line_length = 120\n\n[*.ini]\nindent_size = 4\n\n[*.rst]\nmax_line_length = 150\n\n[Makefile]\nindent_style = tab\n\n[end of .editorconfig]","filename":".editorconfig","id":"5"},{"content":"#!/usr/bin/env python\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\n# implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport setuptools\n\nsetuptools.setup(\n setup_requires=[\"setuptools_scm\"],\n use_scm_version=True,\n)\n\n[end of setup.py]","filename":"setup.py","id":"6"},{"content":"[tox]\n# we only test trio on latest python version\nenvlist = py3{9,10,11,12,13,13-trio}, pep8, pypy3\nskip_missing_interpreters = True\n\n[testenv]\nusedevelop = True\nsitepackages = False\ndeps =\n .[test]\n .[doc]\n trio: trio\ncommands =\n py3{8,9,10,11,12,13},pypy3: pytest {posargs}\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b doctest doc/source doc/build\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b html doc/source doc/build\n\n[testenv:pep8]\nbasepython = python3\ndeps = ruff\ncommands =\n ruff check . {posargs}\n ruff format --check . {posargs}\n\n[testenv:mypy]\ndeps =\n mypy>=1.0.0\n pytest # for stubs\n trio\ncommands =\n mypy {posargs}\n\n[testenv:reno]\nbasepython = python3\ndeps = reno\ncommands = reno {posargs}\n\n[end of tox.ini]","filename":"tox.ini","id":"7"},{"content":"[metadata]\nname = tenacity\nlicense = Apache 2.0\nurl = https://github.com/jd/tenacity\nsummary = Retry code until it succeeds\nlong_description = Tenacity is a general-purpose retrying library to simplify the task of adding retry behavior to just about anything.\nauthor = Julien Danjou\nauthor_email = julien@danjou.info\nhome_page = https://github.com/jd/tenacity\nclassifier =\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 :: Only\n Programming Language :: Python :: 3.9\n Programming Language :: Python :: 3.10\n Programming Language :: Python :: 3.11\n Programming Language :: Python :: 3.12\n Programming Language :: Python :: 3.13\n Topic :: Utilities\n\n[options]\ninstall_requires =\npython_requires = >=3.9\npackages = find:\n\n[options.packages.find]\ninclude = tenacity*\nexclude = tests\n\n[options.package_data]\ntenacity = py.typed\n\n[options.extras_require]\ndoc =\n reno\n sphinx\ntest =\n pytest\n tornado>=4.5\n typeguard\n\n[tool:pytest]\nfilterwarnings =\n # Show any DeprecationWarnings once\n once::DeprecationWarning\n\n[end of setup.cfg]","filename":"setup.cfg","id":"8"},{"content":"Tenacity\n========\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\n :target: https://pypi.python.org/pypi/tenacity\n\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\n :target: https://circleci.com/gh/jd/tenacity\n\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\n :target: https://mergify.io\n :alt: Mergify Status\n\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\n\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\nPython, to simplify the task of adding retry behavior to just about anything.\nIt originates from `a fork of retrying\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\napi compatible with retrying but adds significant new functionality and\nfixes a number of longstanding bugs.\n\nThe simplest use case is retrying a flaky function whenever an `Exception`\noccurs until a value is returned.\n\n.. testcode::\n\n import random\n from tenacity import retry\n\n @retry\n def do_something_unreliable():\n if random.randint(0, 10) > 1:\n raise IOError(\"Broken sauce, everything is hosed!!!111one\")\n else:\n return \"Awesome sauce!\"\n\n print(do_something_unreliable())\n\n.. testoutput::\n :hide:\n\n Awesome sauce!\n\n\n.. toctree::\n :hidden:\n :maxdepth: 2\n\n changelog\n api\n\n\nFeatures\n--------\n\n- Generic Decorator API\n- Specify stop condition (i.e. limit by number of attempts)\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\n- Customize retrying on Exceptions\n- Customize retrying on expected returned result\n- Retry on coroutines\n- Retry code block with context manager\n\n\nInstallation\n------------\n\nTo install *tenacity*, simply:\n\n.. code-block:: bash\n\n $ pip install tenacity\n\n\nExamples\n----------\n\nBasic Retry\n~~~~~~~~~~~\n\n.. testsetup::\n\n import logging\n #\n # Note the following import is used for demonstration convenience only.\n # Production code should always explicitly import the names it needs.\n #\n from tenacity import *\n\n class MyException(Exception):\n pass\n\nAs you saw above, the default behavior is to retry forever without waiting when\nan exception is raised.\n\n.. testcode::\n\n @retry\n def never_gonna_give_you_up():\n print(\"Retry forever ignoring Exceptions, don't wait between retries\")\n raise Exception\n\nStopping\n~~~~~~~~\n\nLet's be a little less persistent and set some boundaries, such as the number\nof attempts before giving up.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(7))\n def stop_after_7_attempts():\n print(\"Stopping after 7 attempts\")\n raise Exception\n\nWe don't have all day, so let's set a boundary for how long we should be\nretrying stuff.\n\n.. testcode::\n\n @retry(stop=stop_after_delay(10))\n def stop_after_10_s():\n print(\"Stopping after 10 seconds\")\n raise Exception\n\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\nthen you can give up on retries one attempt before you would exceed the delay.\n\n.. testcode::\n\n @retry(stop=stop_before_delay(10))\n def stop_before_10_s():\n print(\"Stopping 1 attempt before 10 seconds\")\n raise Exception\n\nYou can combine several stop conditions by using the `|` operator:\n\n.. testcode::\n\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\n def stop_after_10_s_or_5_retries():\n print(\"Stopping after 10 seconds or 5 retries\")\n raise Exception\n\nWaiting before retrying\n~~~~~~~~~~~~~~~~~~~~~~~\n\nMost things don't like to be polled as fast as possible, so let's just wait 2\nseconds between retries.\n\n.. testcode::\n\n @retry(wait=wait_fixed(2))\n def wait_2_s():\n print(\"Wait 2 second between retries\")\n raise Exception\n\nSome things perform best with a bit of randomness injected.\n\n.. testcode::\n\n @retry(wait=wait_random(min=1, max=2))\n def wait_random_1_to_2_s():\n print(\"Randomly wait 1 to 2 seconds between retries\")\n raise Exception\n\nThen again, it's hard to beat exponential backoff when retrying distributed\nservices and other remote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\n def wait_exponential_1():\n print(\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\")\n raise Exception\n\n\nThen again, it's also hard to beat combining fixed waits and jitter (to\nhelp avoid thundering herds) when retrying distributed services and other\nremote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\n def wait_fixed_jitter():\n print(\"Wait at least 3 seconds, and add up to 2 seconds of random delay\")\n raise Exception\n\nWhen multiple processes are in contention for a shared resource, exponentially\nincreasing jitter helps minimise collisions.\n\n.. testcode::\n\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\n def wait_exponential_jitter():\n print(\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\")\n raise Exception\n\n\nSometimes it's necessary to build a chain of backoffs.\n\n.. testcode::\n\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\n [wait_fixed(7) for i in range(2)] +\n [wait_fixed(9)]))\n def wait_fixed_chained():\n print(\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\")\n raise Exception\n\nWhether to retry\n~~~~~~~~~~~~~~~~\n\nWe have a few options for dealing with retries that raise specific or general\nexceptions, as in the cases here.\n\n.. testcode::\n\n class ClientError(Exception):\n \"\"\"Some type of client error.\"\"\"\n\n @retry(retry=retry_if_exception_type(IOError))\n def might_io_error():\n print(\"Retry forever with no wait if an IOError occurs, raise any other errors\")\n raise Exception\n\n @retry(retry=retry_if_not_exception_type(ClientError))\n def might_client_error():\n print(\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\")\n raise Exception\n\nWe can also use the result of the function to alter the behavior of retrying.\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=retry_if_result(is_none_p))\n def might_return_none():\n print(\"Retry with no wait if return value is None\")\n\nSee also these methods:\n\n.. testcode::\n\n retry_if_exception\n retry_if_exception_type\n retry_if_not_exception_type\n retry_unless_exception_type\n retry_if_result\n retry_if_not_result\n retry_if_exception_message\n retry_if_not_exception_message\n retry_any\n retry_all\n\nWe can also combine several conditions:\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\n def might_return_none():\n print(\"Retry forever ignoring Exceptions with no wait if return value is None\")\n\nAny combination of stop, wait, etc. is also supported to give you the freedom\nto mix and match.\n\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\nexception:\n\n.. testcode::\n\n @retry\n def do_something():\n result = something_else()\n if result == 23:\n raise TryAgain\n\nError Handling\n~~~~~~~~~~~~~~\n\nNormally when your function fails its final time (and will not be retried again based on your settings),\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\nof the stack trace.\n\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\nis most visible), you can set `reraise=True`.\n\n.. testcode::\n\n @retry(reraise=True, stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except MyException:\n # timed out retrying\n pass\n\nBefore and After Retry, and Logging\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIt's possible to execute an action before any attempt of calling the function\nby using the before callback function:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIn the same spirit, It's possible to execute after a call that failed:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIt's also possible to only log failures that are going to be retried. Normally\nretries happen after a wait interval, so the keyword argument is called\n``before_sleep``:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3),\n before_sleep=before_sleep_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n\nStatistics\n~~~~~~~~~~\n\nYou can access the statistics about the retry made over a function by using the\n`statistics` attribute attached to the function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nCustom Callbacks\n~~~~~~~~~~~~~~~~\n\nYou can also define your own callbacks. The callback should accept one\nparameter called ``retry_state`` that contains all information about current\nretry invocation.\n\nFor example, you can call a custom callback function after all retries failed,\nwithout raising an exception (or you can re-raise or do anything really)\n\n.. testcode::\n\n def return_last_value(retry_state):\n \"\"\"return the result of the last call attempt\"\"\"\n return retry_state.outcome.result()\n\n def is_false(value):\n \"\"\"Return True if value is False\"\"\"\n return value is False\n\n # will return False after trying 3 times to get a different result\n @retry(stop=stop_after_attempt(3),\n retry_error_callback=return_last_value,\n retry=retry_if_result(is_false))\n def eventually_return_false():\n return False\n\nRetryCallState\n~~~~~~~~~~~~~~\n\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\n\nOther Custom Callbacks\n~~~~~~~~~~~~~~~~~~~~~~\n\nIt's also possible to define custom callbacks for other keyword arguments.\n\n.. function:: my_stop(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should stop\n :rtype: bool\n\n.. function:: my_wait(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: number of seconds to wait before next retry\n :rtype: float\n\n.. function:: my_retry(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should continue\n :rtype: bool\n\n.. function:: my_before(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_after(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_before_sleep(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\nHere's an example with a custom ``before_sleep`` function:\n\n.. testcode::\n\n import logging\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n def my_before_sleep(retry_state):\n if retry_state.attempt_number < 1:\n loglevel = logging.INFO\n else:\n loglevel = logging.WARNING\n logger.log(\n loglevel, 'Retrying %s: attempt %s ended with: %s',\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\n\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except RetryError:\n pass\n\n\nChanging Arguments at Run Time\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can change the arguments of a retry decorator as needed when calling it by\nusing the `retry_with` function attached to the wrapped function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nIf you want to use variables to set up the retry parameters, you don't have\nto use the `retry` decorator - you can instead use `Retrying` directly:\n\n.. testcode::\n\n def never_good_enough(arg1):\n raise Exception('Invalid argument: {}'.format(arg1))\n\n def try_never_good_enough(max_attempts=3):\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\n retryer(never_good_enough, 'I really do try')\n\nYou may also want to change the behaviour of a decorated function temporarily,\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\nattribute attached to the function. Bear in mind this is a write-only attribute,\nstatistics should be read from the function `statistics` attribute.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n from unittest import mock\n\n with mock.patch.object(raise_my_exception.retry, \"wait\", wait_fixed(0)):\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nRetrying code block\n~~~~~~~~~~~~~~~~~~~\n\nTenacity allows you to retry a code block without the need to wraps it in an\nisolated function. This makes it easy to isolate failing block while sharing\ncontext. The trick is to combine a for loop and a context manager.\n\n.. testcode::\n\n from tenacity import Retrying, RetryError, stop_after_attempt\n\n try:\n for attempt in Retrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nYou can configure every details of retry policy by configuring the Retrying\nobject.\n\nWith async code you can use AsyncRetrying.\n\n.. testcode::\n\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\n\n async def function():\n try:\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nIn both cases, you may want to set the result to the attempt so it's available\nin retry strategies like ``retry_if_result``. This can be done accessing the\n``retry_state`` property:\n\n.. testcode::\n\n from tenacity import AsyncRetrying, retry_if_result\n\n async def function():\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\n with attempt:\n result = 1 # Some complex calculation, function call, etc.\n if not attempt.retry_state.outcome.failed:\n attempt.retry_state.set_result(result)\n return result\n\nAsync and retry\n~~~~~~~~~~~~~~~\n\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\nSleeps are done asynchronously too.\n\n.. code-block:: python\n\n @retry\n async def my_asyncio_function(loop):\n await loop.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n async def my_async_trio_function():\n await trio.socket.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n @tornado.gen.coroutine\n def my_async_tornado_function(http_client, url):\n yield http_client.fetch(url)\n\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\n\n.. code-block:: python\n\n @retry(sleep=curio.sleep)\n async def my_async_curio_function():\n await asks.get('https://example.org')\n\nContribute\n----------\n\n#. Check for open issues or open a fresh issue to start a discussion around a\n feature idea or a bug.\n#. Fork `the repository`_ on GitHub to start making your changes to the\n **main** branch (or branch off of it).\n#. Write a test which shows that the bug was fixed or that the feature works as\n expected.\n#. Add a `changelog <#Changelogs>`_\n#. Make the docs better (or more detailed, or more easier to read, or ...)\n\n.. _`the repository`: https://github.com/jd/tenacity\n\nChangelogs\n~~~~~~~~~~\n\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\n\nThe doc generation will automatically compile the changelogs. You just need to add them.\n\n.. code-block:: sh\n\n # Opens a template file in an editor\n tox -e reno -- new some-slug-for-my-change --edit\n\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\n\n[end of README.rst]","filename":"README.rst","id":"9"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef before_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"Before call strategy that does nothing.\"\"\"\n\n\ndef before_log(\n logger: \"logging.Logger\", log_level: int\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"Before call strategy that logs to some logger the attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n logger.log(\n log_level,\n f\"Starting call to '{fn_name}', \"\n f\"this is the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\",\n )\n\n return log_it\n\n[end of tenacity/before.py]","filename":"tenacity/before.py","id":"10"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef before_sleep_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"Before sleep strategy that does nothing.\"\"\"\n\n\ndef before_sleep_log(\n logger: \"logging.Logger\",\n log_level: int,\n exc_info: bool = False,\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"Before sleep strategy that logs to some logger the attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n local_exc_info: BaseException | bool | None\n\n if retry_state.outcome is None:\n raise RuntimeError(\"log_it() called before outcome was set\")\n\n if retry_state.next_action is None:\n raise RuntimeError(\"log_it() called before next_action was set\")\n\n if retry_state.outcome.failed:\n ex = retry_state.outcome.exception()\n verb, value = \"raised\", f\"{ex.__class__.__name__}: {ex}\"\n\n if exc_info:\n local_exc_info = retry_state.outcome.exception()\n else:\n local_exc_info = False\n else:\n verb, value = \"returned\", retry_state.outcome.result()\n local_exc_info = False # exc_info does not apply when no exception\n\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n\n logger.log(\n log_level,\n f\"Retrying {fn_name} \"\n f\"in {retry_state.next_action.sleep} seconds as it {verb} {value}.\",\n exc_info=local_exc_info,\n )\n\n return log_it\n\n[end of tenacity/before_sleep.py]","filename":"tenacity/before_sleep.py","id":"11"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport abc\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import threading\n\n from tenacity import RetryCallState\n\n\nclass stop_base(abc.ABC):\n \"\"\"Abstract base class for stop strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n pass\n\n def __and__(self, other: \"stop_base\") -> \"stop_all\":\n return stop_all(self, other)\n\n def __or__(self, other: \"stop_base\") -> \"stop_any\":\n return stop_any(self, other)\n\n\nStopBaseT = typing.Union[stop_base, typing.Callable[[\"RetryCallState\"], bool]]\n\n\nclass stop_any(stop_base):\n \"\"\"Stop if any of the stop condition is valid.\"\"\"\n\n def __init__(self, *stops: stop_base) -> None:\n self.stops = stops\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return any(x(retry_state) for x in self.stops)\n\n\nclass stop_all(stop_base):\n \"\"\"Stop if all the stop conditions are valid.\"\"\"\n\n def __init__(self, *stops: stop_base) -> None:\n self.stops = stops\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return all(x(retry_state) for x in self.stops)\n\n\nclass _stop_never(stop_base):\n \"\"\"Never stop.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return False\n\n\nstop_never = _stop_never()\n\n\nclass stop_when_event_set(stop_base):\n \"\"\"Stop when the given event is set.\"\"\"\n\n def __init__(self, event: \"threading.Event\") -> None:\n self.event = event\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return self.event.is_set()\n\n\nclass stop_after_attempt(stop_base):\n \"\"\"Stop when the previous attempt >= max_attempt.\"\"\"\n\n def __init__(self, max_attempt_number: int) -> None:\n self.max_attempt_number = max_attempt_number\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return retry_state.attempt_number >= self.max_attempt_number\n\n\nclass stop_after_delay(stop_base):\n \"\"\"\n Stop when the time from the first attempt >= limit.\n\n Note: `max_delay` will be exceeded, so when used with a `wait`, the actual total delay will be greater\n than `max_delay` by some of the final sleep period before `max_delay` is exceeded.\n\n If you need stricter timing with waits, consider `stop_before_delay` instead.\n \"\"\"\n\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\n self.max_delay = _utils.to_seconds(max_delay)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.seconds_since_start is None:\n raise RuntimeError(\"__call__() called but seconds_since_start is not set\")\n return retry_state.seconds_since_start >= self.max_delay\n\n\nclass stop_before_delay(stop_base):\n \"\"\"\n Stop right before the next attempt would take place after the time from the first attempt >= limit.\n\n Most useful when you are using with a `wait` function like wait_random_exponential, but need to make\n sure that the max_delay is not exceeded.\n \"\"\"\n\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\n self.max_delay = _utils.to_seconds(max_delay)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.seconds_since_start is None:\n raise RuntimeError(\"__call__() called but seconds_since_start is not set\")\n return (\n retry_state.seconds_since_start + retry_state.upcoming_sleep\n >= self.max_delay\n )\n\n[end of tenacity/stop.py]","filename":"tenacity/stop.py","id":"12"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport abc\nimport random\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass wait_base(abc.ABC):\n \"\"\"Abstract base class for wait strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n pass\n\n def __add__(self, other: \"wait_base\") -> \"wait_combine\":\n return wait_combine(self, other)\n\n def __radd__(self, other: \"wait_base\") -> typing.Union[\"wait_combine\", \"wait_base\"]:\n # make it possible to use multiple waits with the built-in sum function\n if other == 0: # type: ignore[comparison-overlap]\n return self\n return self.__add__(other)\n\n\nWaitBaseT = typing.Union[\n wait_base, typing.Callable[[\"RetryCallState\"], typing.Union[float, int]]\n]\n\n\nclass wait_fixed(wait_base):\n \"\"\"Wait strategy that waits a fixed amount of time between each retry.\"\"\"\n\n def __init__(self, wait: _utils.time_unit_type) -> None:\n self.wait_fixed = _utils.to_seconds(wait)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return self.wait_fixed\n\n\nclass wait_none(wait_fixed):\n \"\"\"Wait strategy that doesn't wait at all before retrying.\"\"\"\n\n def __init__(self) -> None:\n super().__init__(0)\n\n\nclass wait_random(wait_base):\n \"\"\"Wait strategy that waits a random amount of time between min/max.\"\"\"\n\n def __init__(\n self, min: _utils.time_unit_type = 0, max: _utils.time_unit_type = 1\n ) -> None: # noqa\n self.wait_random_min = _utils.to_seconds(min)\n self.wait_random_max = _utils.to_seconds(max)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return self.wait_random_min + (\n random.random() * (self.wait_random_max - self.wait_random_min)\n )\n\n\nclass wait_combine(wait_base):\n \"\"\"Combine several waiting strategies.\"\"\"\n\n def __init__(self, *strategies: wait_base) -> None:\n self.wait_funcs = strategies\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n return sum(x(retry_state=retry_state) for x in self.wait_funcs)\n\n\nclass wait_chain(wait_base):\n \"\"\"Chain two or more waiting strategies.\n\n If all strategies are exhausted, the very last strategy is used\n thereafter.\n\n For example::\n\n @retry(wait=wait_chain(*[wait_fixed(1) for i in range(3)] +\n [wait_fixed(2) for j in range(5)] +\n [wait_fixed(5) for k in range(4)))\n def wait_chained():\n print(\"Wait 1s for 3 attempts, 2s for 5 attempts and 5s\n thereafter.\")\n \"\"\"\n\n def __init__(self, *strategies: wait_base) -> None:\n self.strategies = strategies\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n wait_func_no = min(max(retry_state.attempt_number, 1), len(self.strategies))\n wait_func = self.strategies[wait_func_no - 1]\n return wait_func(retry_state=retry_state)\n\n\nclass wait_incrementing(wait_base):\n \"\"\"Wait an incremental amount of time after each attempt.\n\n Starting at a starting value and incrementing by a value for each attempt\n (and restricting the upper limit to some maximum value).\n \"\"\"\n\n def __init__(\n self,\n start: _utils.time_unit_type = 0,\n increment: _utils.time_unit_type = 100,\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\n ) -> None:\n self.start = _utils.to_seconds(start)\n self.increment = _utils.to_seconds(increment)\n self.max = _utils.to_seconds(max)\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n result = self.start + (self.increment * (retry_state.attempt_number - 1))\n return max(0, min(result, self.max))\n\n\nclass wait_exponential(wait_base):\n \"\"\"Wait strategy that applies exponential backoff.\n\n It allows for a customized multiplier and an ability to restrict the\n upper and lower limits to some maximum and minimum value.\n\n The intervals are fixed (i.e. there is no jitter), so this strategy is\n suitable for balancing retries against latency when a required resource is\n unavailable for an unknown duration, but *not* suitable for resolving\n contention between multiple processes for a shared resource. Use\n wait_random_exponential for the latter case.\n \"\"\"\n\n def __init__(\n self,\n multiplier: typing.Union[int, float] = 1,\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\n exp_base: typing.Union[int, float] = 2,\n min: _utils.time_unit_type = 0, # noqa\n ) -> None:\n self.multiplier = multiplier\n self.min = _utils.to_seconds(min)\n self.max = _utils.to_seconds(max)\n self.exp_base = exp_base\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n try:\n exp = self.exp_base ** (retry_state.attempt_number - 1)\n result = self.multiplier * exp\n except OverflowError:\n return self.max\n return max(max(0, self.min), min(result, self.max))\n\n\nclass wait_random_exponential(wait_exponential):\n \"\"\"Random wait with exponentially widening window.\n\n An exponential backoff strategy used to mediate contention between multiple\n uncoordinated processes for a shared resource in distributed systems. This\n is the sense in which \"exponential backoff\" is meant in e.g. Ethernet\n networking, and corresponds to the \"Full Jitter\" algorithm described in\n this blog post:\n\n https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/\n\n Each retry occurs at a random time in a geometrically expanding interval.\n It allows for a custom multiplier and an ability to restrict the upper\n limit of the random interval to some maximum value.\n\n Example::\n\n wait_random_exponential(multiplier=0.5, # initial window 0.5s\n max=60) # max 60s timeout\n\n When waiting for an unavailable resource to become available again, as\n opposed to trying to resolve contention for a shared resource, the\n wait_exponential strategy (which uses a fixed interval) may be preferable.\n\n \"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n high = super().__call__(retry_state=retry_state)\n return random.uniform(self.min, high)\n\n\nclass wait_exponential_jitter(wait_base):\n \"\"\"Wait strategy that applies exponential backoff and jitter.\n\n It allows for a customized initial wait, maximum wait and jitter.\n\n This implements the strategy described here:\n https://cloud.google.com/storage/docs/retry-strategy\n\n The wait time is min(initial * 2**n + random.uniform(0, jitter), maximum)\n where n is the retry count.\n \"\"\"\n\n def __init__(\n self,\n initial: float = 1,\n max: float = _utils.MAX_WAIT, # noqa\n exp_base: float = 2,\n jitter: float = 1,\n ) -> None:\n self.initial = initial\n self.max = max\n self.exp_base = exp_base\n self.jitter = jitter\n\n def __call__(self, retry_state: \"RetryCallState\") -> float:\n jitter = random.uniform(0, self.jitter)\n try:\n exp = self.exp_base ** (retry_state.attempt_number - 1)\n result = self.initial * exp + jitter\n except OverflowError:\n result = self.max\n return max(0, min(result, self.max))\n\n[end of tenacity/wait.py]","filename":"tenacity/wait.py","id":"13"},{"content":"# Copyright 2016-2018 Julien Danjou\n# Copyright 2017 Elisey Zanko\n# Copyright 2016 Étienne Bersac\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport dataclasses\nimport functools\nimport sys\nimport threading\nimport time\nimport typing as t\nimport warnings\nfrom abc import ABC, abstractmethod\nfrom concurrent import futures\n\nfrom . import _utils\n\n# Import all built-in retry strategies for easier usage.\nfrom .retry import retry_base # noqa\nfrom .retry import retry_all # noqa\nfrom .retry import retry_always # noqa\nfrom .retry import retry_any # noqa\nfrom .retry import retry_if_exception # noqa\nfrom .retry import retry_if_exception_type # noqa\nfrom .retry import retry_if_exception_cause_type # noqa\nfrom .retry import retry_if_not_exception_type # noqa\nfrom .retry import retry_if_not_result # noqa\nfrom .retry import retry_if_result # noqa\nfrom .retry import retry_never # noqa\nfrom .retry import retry_unless_exception_type # noqa\nfrom .retry import retry_if_exception_message # noqa\nfrom .retry import retry_if_not_exception_message # noqa\n\n# Import all nap strategies for easier usage.\nfrom .nap import sleep # noqa\nfrom .nap import sleep_using_event # noqa\n\n# Import all built-in stop strategies for easier usage.\nfrom .stop import stop_after_attempt # noqa\nfrom .stop import stop_after_delay # noqa\nfrom .stop import stop_before_delay # noqa\nfrom .stop import stop_all # noqa\nfrom .stop import stop_any # noqa\nfrom .stop import stop_never # noqa\nfrom .stop import stop_when_event_set # noqa\n\n# Import all built-in wait strategies for easier usage.\nfrom .wait import wait_chain # noqa\nfrom .wait import wait_combine # noqa\nfrom .wait import wait_exponential # noqa\nfrom .wait import wait_fixed # noqa\nfrom .wait import wait_incrementing # noqa\nfrom .wait import wait_none # noqa\nfrom .wait import wait_random # noqa\nfrom .wait import wait_random_exponential # noqa\nfrom .wait import wait_random_exponential as wait_full_jitter # noqa\nfrom .wait import wait_exponential_jitter # noqa\n\n# Import all built-in before strategies for easier usage.\nfrom .before import before_log # noqa\nfrom .before import before_nothing # noqa\n\n# Import all built-in after strategies for easier usage.\nfrom .after import after_log # noqa\nfrom .after import after_nothing # noqa\n\n# Import all built-in before sleep strategies for easier usage.\nfrom .before_sleep import before_sleep_log # noqa\nfrom .before_sleep import before_sleep_nothing # noqa\n\ntry:\n import tornado\nexcept ImportError:\n tornado = None\n\nif t.TYPE_CHECKING:\n import types\n\n from typing_extensions import Self\n\n from . import asyncio as tasyncio\n from .retry import RetryBaseT\n from .stop import StopBaseT\n from .wait import WaitBaseT\n\n\nWrappedFnReturnT = t.TypeVar(\"WrappedFnReturnT\")\nWrappedFn = t.TypeVar(\"WrappedFn\", bound=t.Callable[..., t.Any])\n\n\ndataclass_kwargs = {}\nif sys.version_info >= (3, 10):\n dataclass_kwargs.update({\"slots\": True})\n\n\n@dataclasses.dataclass(**dataclass_kwargs)\nclass IterState:\n actions: t.List[t.Callable[[\"RetryCallState\"], t.Any]] = dataclasses.field(\n default_factory=list\n )\n retry_run_result: bool = False\n delay_since_first_attempt: int = 0\n stop_run_result: bool = False\n is_explicit_retry: bool = False\n\n def reset(self) -> None:\n self.actions = []\n self.retry_run_result = False\n self.delay_since_first_attempt = 0\n self.stop_run_result = False\n self.is_explicit_retry = False\n\n\nclass TryAgain(Exception):\n \"\"\"Always retry the executed function when raised.\"\"\"\n\n\nNO_RESULT = object()\n\n\nclass DoAttempt:\n pass\n\n\nclass DoSleep(float):\n pass\n\n\nclass BaseAction:\n \"\"\"Base class for representing actions to take by retry object.\n\n Concrete implementations must define:\n - __init__: to initialize all necessary fields\n - REPR_FIELDS: class variable specifying attributes to include in repr(self)\n - NAME: for identification in retry object methods and callbacks\n \"\"\"\n\n REPR_FIELDS: t.Sequence[str] = ()\n NAME: t.Optional[str] = None\n\n def __repr__(self) -> str:\n state_str = \", \".join(\n f\"{field}={getattr(self, field)!r}\" for field in self.REPR_FIELDS\n )\n return f\"{self.__class__.__name__}({state_str})\"\n\n def __str__(self) -> str:\n return repr(self)\n\n\nclass RetryAction(BaseAction):\n REPR_FIELDS = (\"sleep\",)\n NAME = \"retry\"\n\n def __init__(self, sleep: t.SupportsFloat) -> None:\n self.sleep = float(sleep)\n\n\n_unset = object()\n\n\ndef _first_set(first: t.Union[t.Any, object], second: t.Any) -> t.Any:\n return second if first is _unset else first\n\n\nclass RetryError(Exception):\n \"\"\"Encapsulates the last attempt instance right before giving up.\"\"\"\n\n def __init__(self, last_attempt: \"Future\") -> None:\n self.last_attempt = last_attempt\n super().__init__(last_attempt)\n\n def reraise(self) -> t.NoReturn:\n if self.last_attempt.failed:\n raise self.last_attempt.result()\n raise self\n\n def __str__(self) -> str:\n return f\"{self.__class__.__name__}[{self.last_attempt}]\"\n\n\nclass AttemptManager:\n \"\"\"Manage attempt context.\"\"\"\n\n def __init__(self, retry_state: \"RetryCallState\"):\n self.retry_state = retry_state\n\n def __enter__(self) -> None:\n pass\n\n def __exit__(\n self,\n exc_type: t.Optional[t.Type[BaseException]],\n exc_value: t.Optional[BaseException],\n traceback: t.Optional[\"types.TracebackType\"],\n ) -> t.Optional[bool]:\n if exc_type is not None and exc_value is not None:\n self.retry_state.set_exception((exc_type, exc_value, traceback))\n return True # Swallow exception.\n else:\n # We don't have the result, actually.\n self.retry_state.set_result(None)\n return None\n\n\nclass BaseRetrying(ABC):\n def __init__(\n self,\n sleep: t.Callable[[t.Union[int, float]], None] = sleep,\n stop: \"StopBaseT\" = stop_never,\n wait: \"WaitBaseT\" = wait_none(),\n retry: \"RetryBaseT\" = retry_if_exception_type(),\n before: t.Callable[[\"RetryCallState\"], None] = before_nothing,\n after: t.Callable[[\"RetryCallState\"], None] = after_nothing,\n before_sleep: t.Optional[t.Callable[[\"RetryCallState\"], None]] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[RetryError] = RetryError,\n retry_error_callback: t.Optional[t.Callable[[\"RetryCallState\"], t.Any]] = None,\n ):\n self.sleep = sleep\n self.stop = stop\n self.wait = wait\n self.retry = retry\n self.before = before\n self.after = after\n self.before_sleep = before_sleep\n self.reraise = reraise\n self._local = threading.local()\n self.retry_error_cls = retry_error_cls\n self.retry_error_callback = retry_error_callback\n\n def copy(\n self,\n sleep: t.Union[t.Callable[[t.Union[int, float]], None], object] = _unset,\n stop: t.Union[\"StopBaseT\", object] = _unset,\n wait: t.Union[\"WaitBaseT\", object] = _unset,\n retry: t.Union[retry_base, object] = _unset,\n before: t.Union[t.Callable[[\"RetryCallState\"], None], object] = _unset,\n after: t.Union[t.Callable[[\"RetryCallState\"], None], object] = _unset,\n before_sleep: t.Union[\n t.Optional[t.Callable[[\"RetryCallState\"], None]], object\n ] = _unset,\n reraise: t.Union[bool, object] = _unset,\n retry_error_cls: t.Union[t.Type[RetryError], object] = _unset,\n retry_error_callback: t.Union[\n t.Optional[t.Callable[[\"RetryCallState\"], t.Any]], object\n ] = _unset,\n ) -> \"Self\":\n \"\"\"Copy this object with some parameters changed if needed.\"\"\"\n return self.__class__(\n sleep=_first_set(sleep, self.sleep),\n stop=_first_set(stop, self.stop),\n wait=_first_set(wait, self.wait),\n retry=_first_set(retry, self.retry),\n before=_first_set(before, self.before),\n after=_first_set(after, self.after),\n before_sleep=_first_set(before_sleep, self.before_sleep),\n reraise=_first_set(reraise, self.reraise),\n retry_error_cls=_first_set(retry_error_cls, self.retry_error_cls),\n retry_error_callback=_first_set(\n retry_error_callback, self.retry_error_callback\n ),\n )\n\n def __repr__(self) -> str:\n return (\n f\"<{self.__class__.__name__} object at 0x{id(self):x} (\"\n f\"stop={self.stop}, \"\n f\"wait={self.wait}, \"\n f\"sleep={self.sleep}, \"\n f\"retry={self.retry}, \"\n f\"before={self.before}, \"\n f\"after={self.after})>\"\n )\n\n @property\n def statistics(self) -> t.Dict[str, t.Any]:\n \"\"\"Return a dictionary of runtime statistics.\n\n This dictionary will be empty when the controller has never been\n ran. When it is running or has ran previously it should have (but\n may not) have useful and/or informational keys and values when\n running is underway and/or completed.\n\n .. warning:: The keys in this dictionary **should** be some what\n stable (not changing), but there existence **may**\n change between major releases as new statistics are\n gathered or removed so before accessing keys ensure that\n they actually exist and handle when they do not.\n\n .. note:: The values in this dictionary are local to the thread\n running call (so if multiple threads share the same retrying\n object - either directly or indirectly) they will each have\n there own view of statistics they have collected (in the\n future we may provide a way to aggregate the various\n statistics from each thread).\n \"\"\"\n try:\n return self._local.statistics # type: ignore[no-any-return]\n except AttributeError:\n self._local.statistics = t.cast(t.Dict[str, t.Any], {})\n return self._local.statistics\n\n @property\n def iter_state(self) -> IterState:\n try:\n return self._local.iter_state # type: ignore[no-any-return]\n except AttributeError:\n self._local.iter_state = IterState()\n return self._local.iter_state\n\n def wraps(self, f: WrappedFn) -> WrappedFn:\n \"\"\"Wrap a function for retrying.\n\n :param f: A function to wraps for retrying.\n \"\"\"\n\n @functools.wraps(\n f, functools.WRAPPER_ASSIGNMENTS + (\"__defaults__\", \"__kwdefaults__\")\n )\n def wrapped_f(*args: t.Any, **kw: t.Any) -> t.Any:\n # Always create a copy to prevent overwriting the local contexts when\n # calling the same wrapped functions multiple times in the same stack\n copy = self.copy()\n wrapped_f.statistics = copy.statistics # type: ignore[attr-defined]\n return copy(f, *args, **kw)\n\n def retry_with(*args: t.Any, **kwargs: t.Any) -> WrappedFn:\n return self.copy(*args, **kwargs).wraps(f)\n\n # Preserve attributes\n wrapped_f.retry = self # type: ignore[attr-defined]\n wrapped_f.retry_with = retry_with # type: ignore[attr-defined]\n wrapped_f.statistics = {} # type: ignore[attr-defined]\n\n return wrapped_f # type: ignore[return-value]\n\n def begin(self) -> None:\n self.statistics.clear()\n self.statistics[\"start_time\"] = time.monotonic()\n self.statistics[\"attempt_number\"] = 1\n self.statistics[\"idle_for\"] = 0\n\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\n self.iter_state.actions.append(fn)\n\n def _run_retry(self, retry_state: \"RetryCallState\") -> None:\n self.iter_state.retry_run_result = self.retry(retry_state)\n\n def _run_wait(self, retry_state: \"RetryCallState\") -> None:\n if self.wait:\n sleep = self.wait(retry_state)\n else:\n sleep = 0.0\n\n retry_state.upcoming_sleep = sleep\n\n def _run_stop(self, retry_state: \"RetryCallState\") -> None:\n self.statistics[\"delay_since_first_attempt\"] = retry_state.seconds_since_start\n self.iter_state.stop_run_result = self.stop(retry_state)\n\n def iter(self, retry_state: \"RetryCallState\") -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa\n self._begin_iter(retry_state)\n result = None\n for action in self.iter_state.actions:\n result = action(retry_state)\n return result\n\n def _begin_iter(self, retry_state: \"RetryCallState\") -> None: # noqa\n self.iter_state.reset()\n\n fut = retry_state.outcome\n if fut is None:\n if self.before is not None:\n self._add_action_func(self.before)\n self._add_action_func(lambda rs: DoAttempt())\n return\n\n self.iter_state.is_explicit_retry = fut.failed and isinstance(\n fut.exception(), TryAgain\n )\n if not self.iter_state.is_explicit_retry:\n self._add_action_func(self._run_retry)\n self._add_action_func(self._post_retry_check_actions)\n\n def _post_retry_check_actions(self, retry_state: \"RetryCallState\") -> None:\n if not (self.iter_state.is_explicit_retry or self.iter_state.retry_run_result):\n self._add_action_func(lambda rs: rs.outcome.result())\n return\n\n if self.after is not None:\n self._add_action_func(self.after)\n\n self._add_action_func(self._run_wait)\n self._add_action_func(self._run_stop)\n self._add_action_func(self._post_stop_check_actions)\n\n def _post_stop_check_actions(self, retry_state: \"RetryCallState\") -> None:\n if self.iter_state.stop_run_result:\n if self.retry_error_callback:\n self._add_action_func(self.retry_error_callback)\n return\n\n def exc_check(rs: \"RetryCallState\") -> None:\n fut = t.cast(Future, rs.outcome)\n retry_exc = self.retry_error_cls(fut)\n if self.reraise:\n raise retry_exc.reraise()\n raise retry_exc from fut.exception()\n\n self._add_action_func(exc_check)\n return\n\n def next_action(rs: \"RetryCallState\") -> None:\n sleep = rs.upcoming_sleep\n rs.next_action = RetryAction(sleep)\n rs.idle_for += sleep\n self.statistics[\"idle_for\"] += sleep\n self.statistics[\"attempt_number\"] += 1\n\n self._add_action_func(next_action)\n\n if self.before_sleep is not None:\n self._add_action_func(self.before_sleep)\n\n self._add_action_func(lambda rs: DoSleep(rs.upcoming_sleep))\n\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\n self.begin()\n\n retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n yield AttemptManager(retry_state=retry_state)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n self.sleep(do)\n else:\n break\n\n @abstractmethod\n def __call__(\n self,\n fn: t.Callable[..., WrappedFnReturnT],\n *args: t.Any,\n **kwargs: t.Any,\n ) -> WrappedFnReturnT:\n pass\n\n\nclass Retrying(BaseRetrying):\n \"\"\"Retrying controller.\"\"\"\n\n def __call__(\n self,\n fn: t.Callable[..., WrappedFnReturnT],\n *args: t.Any,\n **kwargs: t.Any,\n ) -> WrappedFnReturnT:\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n self.sleep(do)\n else:\n return do # type: ignore[no-any-return]\n\n\nif sys.version_info >= (3, 9):\n FutureGenericT = futures.Future[t.Any]\nelse:\n FutureGenericT = futures.Future\n\n\nclass Future(FutureGenericT):\n \"\"\"Encapsulates a (future or past) attempted call to a target function.\"\"\"\n\n def __init__(self, attempt_number: int) -> None:\n super().__init__()\n self.attempt_number = attempt_number\n\n @property\n def failed(self) -> bool:\n \"\"\"Return whether a exception is being held in this future.\"\"\"\n return self.exception() is not None\n\n @classmethod\n def construct(\n cls, attempt_number: int, value: t.Any, has_exception: bool\n ) -> \"Future\":\n \"\"\"Construct a new Future object.\"\"\"\n fut = cls(attempt_number)\n if has_exception:\n fut.set_exception(value)\n else:\n fut.set_result(value)\n return fut\n\n\nclass RetryCallState:\n \"\"\"State related to a single call wrapped with Retrying.\"\"\"\n\n def __init__(\n self,\n retry_object: BaseRetrying,\n fn: t.Optional[WrappedFn],\n args: t.Any,\n kwargs: t.Any,\n ) -> None:\n #: Retry call start timestamp\n self.start_time = time.monotonic()\n #: Retry manager object\n self.retry_object = retry_object\n #: Function wrapped by this retry call\n self.fn = fn\n #: Arguments of the function wrapped by this retry call\n self.args = args\n #: Keyword arguments of the function wrapped by this retry call\n self.kwargs = kwargs\n\n #: The number of the current attempt\n self.attempt_number: int = 1\n #: Last outcome (result or exception) produced by the function\n self.outcome: t.Optional[Future] = None\n #: Timestamp of the last outcome\n self.outcome_timestamp: t.Optional[float] = None\n #: Time spent sleeping in retries\n self.idle_for: float = 0.0\n #: Next action as decided by the retry manager\n self.next_action: t.Optional[RetryAction] = None\n #: Next sleep time as decided by the retry manager.\n self.upcoming_sleep: float = 0.0\n\n @property\n def seconds_since_start(self) -> t.Optional[float]:\n if self.outcome_timestamp is None:\n return None\n return self.outcome_timestamp - self.start_time\n\n def prepare_for_next_attempt(self) -> None:\n self.outcome = None\n self.outcome_timestamp = None\n self.attempt_number += 1\n self.next_action = None\n\n def set_result(self, val: t.Any) -> None:\n ts = time.monotonic()\n fut = Future(self.attempt_number)\n fut.set_result(val)\n self.outcome, self.outcome_timestamp = fut, ts\n\n def set_exception(\n self,\n exc_info: t.Tuple[\n t.Type[BaseException], BaseException, \"types.TracebackType| None\"\n ],\n ) -> None:\n ts = time.monotonic()\n fut = Future(self.attempt_number)\n fut.set_exception(exc_info[1])\n self.outcome, self.outcome_timestamp = fut, ts\n\n def __repr__(self) -> str:\n if self.outcome is None:\n result = \"none yet\"\n elif self.outcome.failed:\n exception = self.outcome.exception()\n result = f\"failed ({exception.__class__.__name__} {exception})\"\n else:\n result = f\"returned {self.outcome.result()}\"\n\n slept = float(round(self.idle_for, 2))\n clsname = self.__class__.__name__\n return f\"<{clsname} {id(self)}: attempt #{self.attempt_number}; slept for {slept}; last result: {result}>\"\n\n\n@t.overload\ndef retry(func: WrappedFn) -> WrappedFn: ...\n\n\n@t.overload\ndef retry(\n sleep: t.Callable[[t.Union[int, float]], t.Union[None, t.Awaitable[None]]] = sleep,\n stop: \"StopBaseT\" = stop_never,\n wait: \"WaitBaseT\" = wait_none(),\n retry: \"t.Union[RetryBaseT, tasyncio.retry.RetryBaseT]\" = retry_if_exception_type(),\n before: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = before_nothing,\n after: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = after_nothing,\n before_sleep: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[None, t.Awaitable[None]]]\n ] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[\"RetryError\"] = RetryError,\n retry_error_callback: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[t.Any, t.Awaitable[t.Any]]]\n ] = None,\n) -> t.Callable[[WrappedFn], WrappedFn]: ...\n\n\ndef retry(*dargs: t.Any, **dkw: t.Any) -> t.Any:\n \"\"\"Wrap a function with a new `Retrying` object.\n\n :param dargs: positional arguments passed to Retrying object\n :param dkw: keyword arguments passed to the Retrying object\n \"\"\"\n # support both @retry and @retry() as valid syntax\n if len(dargs) == 1 and callable(dargs[0]):\n return retry()(dargs[0])\n else:\n\n def wrap(f: WrappedFn) -> WrappedFn:\n if isinstance(f, retry_base):\n warnings.warn(\n f\"Got retry_base instance ({f.__class__.__name__}) as callable argument, \"\n f\"this will probably hang indefinitely (did you mean retry={f.__class__.__name__}(...)?)\"\n )\n r: \"BaseRetrying\"\n if _utils.is_coroutine_callable(f):\n r = AsyncRetrying(*dargs, **dkw)\n elif (\n tornado\n and hasattr(tornado.gen, \"is_coroutine_function\")\n and tornado.gen.is_coroutine_function(f)\n ):\n r = TornadoRetrying(*dargs, **dkw)\n else:\n r = Retrying(*dargs, **dkw)\n\n return r.wraps(f)\n\n return wrap\n\n\nfrom tenacity.asyncio import AsyncRetrying # noqa:E402,I100\n\nif tornado:\n from tenacity.tornadoweb import TornadoRetrying\n\n\n__all__ = [\n \"retry_base\",\n \"retry_all\",\n \"retry_always\",\n \"retry_any\",\n \"retry_if_exception\",\n \"retry_if_exception_type\",\n \"retry_if_exception_cause_type\",\n \"retry_if_not_exception_type\",\n \"retry_if_not_result\",\n \"retry_if_result\",\n \"retry_never\",\n \"retry_unless_exception_type\",\n \"retry_if_exception_message\",\n \"retry_if_not_exception_message\",\n \"sleep\",\n \"sleep_using_event\",\n \"stop_after_attempt\",\n \"stop_after_delay\",\n \"stop_before_delay\",\n \"stop_all\",\n \"stop_any\",\n \"stop_never\",\n \"stop_when_event_set\",\n \"wait_chain\",\n \"wait_combine\",\n \"wait_exponential\",\n \"wait_fixed\",\n \"wait_incrementing\",\n \"wait_none\",\n \"wait_random\",\n \"wait_random_exponential\",\n \"wait_full_jitter\",\n \"wait_exponential_jitter\",\n \"before_log\",\n \"before_nothing\",\n \"after_log\",\n \"after_nothing\",\n \"before_sleep_log\",\n \"before_sleep_nothing\",\n \"retry\",\n \"WrappedFn\",\n \"TryAgain\",\n \"NO_RESULT\",\n \"DoAttempt\",\n \"DoSleep\",\n \"BaseAction\",\n \"RetryAction\",\n \"RetryError\",\n \"AttemptManager\",\n \"BaseRetrying\",\n \"Retrying\",\n \"Future\",\n \"RetryCallState\",\n \"AsyncRetrying\",\n]\n\n[end of tenacity/__init__.py]","filename":"tenacity/__init__.py","id":"14"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport time\nimport typing\n\nif typing.TYPE_CHECKING:\n import threading\n\n\ndef sleep(seconds: float) -> None:\n \"\"\"\n Sleep strategy that delays execution for a given number of seconds.\n\n This is the default strategy, and may be mocked out for unit testing.\n \"\"\"\n time.sleep(seconds)\n\n\nclass sleep_using_event:\n \"\"\"Sleep strategy that waits on an event to be set.\"\"\"\n\n def __init__(self, event: \"threading.Event\") -> None:\n self.event = event\n\n def __call__(self, timeout: typing.Optional[float]) -> None:\n # NOTE(harlowja): this may *not* actually wait for timeout\n # seconds if the event is set (ie this may eject out early).\n self.event.wait(timeout=timeout)\n\n[end of tenacity/nap.py]","filename":"tenacity/nap.py","id":"15"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport typing\n\nfrom tenacity import _utils\n\nif typing.TYPE_CHECKING:\n import logging\n\n from tenacity import RetryCallState\n\n\ndef after_nothing(retry_state: \"RetryCallState\") -> None:\n \"\"\"After call strategy that does nothing.\"\"\"\n\n\ndef after_log(\n logger: \"logging.Logger\",\n log_level: int,\n sec_format: str = \"%0.3f\",\n) -> typing.Callable[[\"RetryCallState\"], None]:\n \"\"\"After call strategy that logs to some logger the finished attempt.\"\"\"\n\n def log_it(retry_state: \"RetryCallState\") -> None:\n if retry_state.fn is None:\n # NOTE(sileht): can't really happen, but we must please mypy\n fn_name = \"<unknown>\"\n else:\n fn_name = _utils.get_callback_name(retry_state.fn)\n logger.log(\n log_level,\n f\"Finished call to '{fn_name}' \"\n f\"after {sec_format % retry_state.seconds_since_start}(s), \"\n f\"this was the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\",\n )\n\n return log_it\n\n[end of tenacity/after.py]","filename":"tenacity/after.py","id":"16"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport abc\nimport re\nimport typing\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass retry_base(abc.ABC):\n \"\"\"Abstract base class for retry strategies.\"\"\"\n\n @abc.abstractmethod\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n pass\n\n def __and__(self, other: \"retry_base\") -> \"retry_all\":\n return other.__rand__(self)\n\n def __rand__(self, other: \"retry_base\") -> \"retry_all\":\n return retry_all(other, self)\n\n def __or__(self, other: \"retry_base\") -> \"retry_any\":\n return other.__ror__(self)\n\n def __ror__(self, other: \"retry_base\") -> \"retry_any\":\n return retry_any(other, self)\n\n\nRetryBaseT = typing.Union[retry_base, typing.Callable[[\"RetryCallState\"], bool]]\n\n\nclass _retry_never(retry_base):\n \"\"\"Retry strategy that never rejects any result.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return False\n\n\nretry_never = _retry_never()\n\n\nclass _retry_always(retry_base):\n \"\"\"Retry strategy that always rejects any result.\"\"\"\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return True\n\n\nretry_always = _retry_always()\n\n\nclass retry_if_exception(retry_base):\n \"\"\"Retry strategy that retries if an exception verifies a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[BaseException], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if retry_state.outcome.failed:\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n else:\n return False\n\n\nclass retry_if_exception_type(retry_if_exception):\n \"\"\"Retries if an exception has been raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: isinstance(e, exception_types))\n\n\nclass retry_if_not_exception_type(retry_if_exception):\n \"\"\"Retries except an exception has been raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: not isinstance(e, exception_types))\n\n\nclass retry_unless_exception_type(retry_if_exception):\n \"\"\"Retries until an exception is raised of one or more types.\"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_types = exception_types\n super().__init__(lambda e: not isinstance(e, exception_types))\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n # always retry if no exception was raised\n if not retry_state.outcome.failed:\n return True\n\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n\n\nclass retry_if_exception_cause_type(retry_base):\n \"\"\"Retries if any of the causes of the raised exception is of one or more types.\n\n The check on the type of the cause of the exception is done recursively (until finding\n an exception in the chain that has no `__cause__`)\n \"\"\"\n\n def __init__(\n self,\n exception_types: typing.Union[\n typing.Type[BaseException],\n typing.Tuple[typing.Type[BaseException], ...],\n ] = Exception,\n ) -> None:\n self.exception_cause_types = exception_types\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__ called before outcome was set\")\n\n if retry_state.outcome.failed:\n exc = retry_state.outcome.exception()\n while exc is not None:\n if isinstance(exc.__cause__, self.exception_cause_types):\n return True\n exc = exc.__cause__\n\n return False\n\n\nclass retry_if_result(retry_base):\n \"\"\"Retries if the result verifies a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_if_not_result(retry_base):\n \"\"\"Retries if the result refutes a predicate.\"\"\"\n\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\n self.predicate = predicate\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return not self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_if_exception_message(retry_if_exception):\n \"\"\"Retries if an exception message equals or matches.\"\"\"\n\n def __init__(\n self,\n message: typing.Optional[str] = None,\n match: typing.Optional[str] = None,\n ) -> None:\n if message and match:\n raise TypeError(\n f\"{self.__class__.__name__}() takes either 'message' or 'match', not both\"\n )\n\n # set predicate\n if message:\n\n def message_fnc(exception: BaseException) -> bool:\n return message == str(exception)\n\n predicate = message_fnc\n elif match:\n prog = re.compile(match)\n\n def match_fnc(exception: BaseException) -> bool:\n return bool(prog.match(str(exception)))\n\n predicate = match_fnc\n else:\n raise TypeError(\n f\"{self.__class__.__name__}() missing 1 required argument 'message' or 'match'\"\n )\n\n super().__init__(predicate)\n\n\nclass retry_if_not_exception_message(retry_if_exception_message):\n \"\"\"Retries until an exception message equals or matches.\"\"\"\n\n def __init__(\n self,\n message: typing.Optional[str] = None,\n match: typing.Optional[str] = None,\n ) -> None:\n super().__init__(message, match)\n # invert predicate\n if_predicate = self.predicate\n self.predicate = lambda *args_, **kwargs_: not if_predicate(*args_, **kwargs_)\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return True\n\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return self.predicate(exception)\n\n\nclass retry_any(retry_base):\n \"\"\"Retries if any of the retries condition is valid.\"\"\"\n\n def __init__(self, *retries: retry_base) -> None:\n self.retries = retries\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return any(r(retry_state) for r in self.retries)\n\n\nclass retry_all(retry_base):\n \"\"\"Retries if all the retries condition are valid.\"\"\"\n\n def __init__(self, *retries: retry_base) -> None:\n self.retries = retries\n\n def __call__(self, retry_state: \"RetryCallState\") -> bool:\n return all(r(retry_state) for r in self.retries)\n\n[end of tenacity/retry.py]","filename":"tenacity/retry.py","id":"17"},{"content":"[end of tenacity/py.typed]","filename":"tenacity/py.typed","id":"18"},{"content":"# Copyright 2017 Elisey Zanko\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport sys\nimport typing\n\nfrom tenacity import BaseRetrying\nfrom tenacity import DoAttempt\nfrom tenacity import DoSleep\nfrom tenacity import RetryCallState\n\nfrom tornado import gen\n\nif typing.TYPE_CHECKING:\n from tornado.concurrent import Future\n\n_RetValT = typing.TypeVar(\"_RetValT\")\n\n\nclass TornadoRetrying(BaseRetrying):\n def __init__(\n self,\n sleep: \"typing.Callable[[float], Future[None]]\" = gen.sleep,\n **kwargs: typing.Any,\n ) -> None:\n super().__init__(**kwargs)\n self.sleep = sleep\n\n @gen.coroutine # type: ignore[misc]\n def __call__(\n self,\n fn: \"typing.Callable[..., typing.Union[typing.Generator[typing.Any, typing.Any, _RetValT], Future[_RetValT]]]\",\n *args: typing.Any,\n **kwargs: typing.Any,\n ) -> \"typing.Generator[typing.Any, typing.Any, _RetValT]\":\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = yield fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n yield self.sleep(do)\n else:\n raise gen.Return(do)\n\n[end of tenacity/tornadoweb.py]","filename":"tenacity/tornadoweb.py","id":"19"},{"content":"# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport functools\nimport inspect\nimport sys\nimport typing\nfrom datetime import timedelta\n\n\n# sys.maxsize:\n# An integer giving the maximum value a variable of type Py_ssize_t can take.\nMAX_WAIT = sys.maxsize / 2\n\n\ndef find_ordinal(pos_num: int) -> str:\n # See: https://en.wikipedia.org/wiki/English_numerals#Ordinal_numbers\n if pos_num == 0:\n return \"th\"\n elif pos_num == 1:\n return \"st\"\n elif pos_num == 2:\n return \"nd\"\n elif pos_num == 3:\n return \"rd\"\n elif 4 <= pos_num <= 20:\n return \"th\"\n else:\n return find_ordinal(pos_num % 10)\n\n\ndef to_ordinal(pos_num: int) -> str:\n return f\"{pos_num}{find_ordinal(pos_num)}\"\n\n\ndef get_callback_name(cb: typing.Callable[..., typing.Any]) -> str:\n \"\"\"Get a callback fully-qualified name.\n\n If no name can be produced ``repr(cb)`` is called and returned.\n \"\"\"\n segments = []\n try:\n segments.append(cb.__qualname__)\n except AttributeError:\n try:\n segments.append(cb.__name__)\n except AttributeError:\n pass\n if not segments:\n return repr(cb)\n else:\n try:\n # When running under sphinx it appears this can be none?\n if cb.__module__:\n segments.insert(0, cb.__module__)\n except AttributeError:\n pass\n return \".\".join(segments)\n\n\ntime_unit_type = typing.Union[int, float, timedelta]\n\n\ndef to_seconds(time_unit: time_unit_type) -> float:\n return float(\n time_unit.total_seconds() if isinstance(time_unit, timedelta) else time_unit\n )\n\n\ndef is_coroutine_callable(call: typing.Callable[..., typing.Any]) -> bool:\n if inspect.isclass(call):\n return False\n if inspect.iscoroutinefunction(call):\n return True\n partial_call = isinstance(call, functools.partial) and call.func\n dunder_call = partial_call or getattr(call, \"__call__\", None)\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef wrap_to_async_func(\n call: typing.Callable[..., typing.Any],\n) -> typing.Callable[..., typing.Awaitable[typing.Any]]:\n if is_coroutine_callable(call):\n return call\n\n async def inner(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:\n return call(*args, **kwargs)\n\n return inner\n\n[end of tenacity/_utils.py]","filename":"tenacity/_utils.py","id":"20"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport functools\nimport sys\nimport typing as t\n\nimport tenacity\nfrom tenacity import AttemptManager\nfrom tenacity import BaseRetrying\nfrom tenacity import DoAttempt\nfrom tenacity import DoSleep\nfrom tenacity import RetryCallState\nfrom tenacity import RetryError\nfrom tenacity import after_nothing\nfrom tenacity import before_nothing\nfrom tenacity import _utils\n\n# Import all built-in retry strategies for easier usage.\nfrom .retry import RetryBaseT\nfrom .retry import retry_all # noqa\nfrom .retry import retry_any # noqa\nfrom .retry import retry_if_exception # noqa\nfrom .retry import retry_if_result # noqa\nfrom ..retry import RetryBaseT as SyncRetryBaseT\n\nif t.TYPE_CHECKING:\n from tenacity.stop import StopBaseT\n from tenacity.wait import WaitBaseT\n\nWrappedFnReturnT = t.TypeVar(\"WrappedFnReturnT\")\nWrappedFn = t.TypeVar(\"WrappedFn\", bound=t.Callable[..., t.Awaitable[t.Any]])\n\n\ndef _portable_async_sleep(seconds: float) -> t.Awaitable[None]:\n # If trio is already imported, then importing it is cheap.\n # If trio isn't already imported, then it's definitely not running, so we\n # can skip further checks.\n if \"trio\" in sys.modules:\n # If trio is available, then sniffio is too\n import trio\n import sniffio\n\n if sniffio.current_async_library() == \"trio\":\n return trio.sleep(seconds)\n # Otherwise, assume asyncio\n # Lazy import asyncio as it's expensive (responsible for 25-50% of total import overhead).\n import asyncio\n\n return asyncio.sleep(seconds)\n\n\nclass AsyncRetrying(BaseRetrying):\n def __init__(\n self,\n sleep: t.Callable[\n [t.Union[int, float]], t.Union[None, t.Awaitable[None]]\n ] = _portable_async_sleep,\n stop: \"StopBaseT\" = tenacity.stop.stop_never,\n wait: \"WaitBaseT\" = tenacity.wait.wait_none(),\n retry: \"t.Union[SyncRetryBaseT, RetryBaseT]\" = tenacity.retry_if_exception_type(),\n before: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = before_nothing,\n after: t.Callable[\n [\"RetryCallState\"], t.Union[None, t.Awaitable[None]]\n ] = after_nothing,\n before_sleep: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[None, t.Awaitable[None]]]\n ] = None,\n reraise: bool = False,\n retry_error_cls: t.Type[\"RetryError\"] = RetryError,\n retry_error_callback: t.Optional[\n t.Callable[[\"RetryCallState\"], t.Union[t.Any, t.Awaitable[t.Any]]]\n ] = None,\n ) -> None:\n super().__init__(\n sleep=sleep, # type: ignore[arg-type]\n stop=stop,\n wait=wait,\n retry=retry, # type: ignore[arg-type]\n before=before, # type: ignore[arg-type]\n after=after, # type: ignore[arg-type]\n before_sleep=before_sleep, # type: ignore[arg-type]\n reraise=reraise,\n retry_error_cls=retry_error_cls,\n retry_error_callback=retry_error_callback,\n )\n\n async def __call__( # type: ignore[override]\n self, fn: WrappedFn, *args: t.Any, **kwargs: t.Any\n ) -> WrappedFnReturnT:\n self.begin()\n\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\n while True:\n do = await self.iter(retry_state=retry_state)\n if isinstance(do, DoAttempt):\n try:\n result = await fn(*args, **kwargs)\n except BaseException: # noqa: B902\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\n else:\n retry_state.set_result(result)\n elif isinstance(do, DoSleep):\n retry_state.prepare_for_next_attempt()\n await self.sleep(do) # type: ignore[misc]\n else:\n return do # type: ignore[no-any-return]\n\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\n self.iter_state.actions.append(_utils.wrap_to_async_func(fn))\n\n async def _run_retry(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n self.iter_state.retry_run_result = await _utils.wrap_to_async_func(self.retry)(\n retry_state\n )\n\n async def _run_wait(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n if self.wait:\n sleep = await _utils.wrap_to_async_func(self.wait)(retry_state)\n else:\n sleep = 0.0\n\n retry_state.upcoming_sleep = sleep\n\n async def _run_stop(self, retry_state: \"RetryCallState\") -> None: # type: ignore[override]\n self.statistics[\"delay_since_first_attempt\"] = retry_state.seconds_since_start\n self.iter_state.stop_run_result = await _utils.wrap_to_async_func(self.stop)(\n retry_state\n )\n\n async def iter(\n self, retry_state: \"RetryCallState\"\n ) -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa: A003\n self._begin_iter(retry_state)\n result = None\n for action in self.iter_state.actions:\n result = await action(retry_state)\n return result\n\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\n raise TypeError(\"AsyncRetrying object is not iterable\")\n\n def __aiter__(self) -> \"AsyncRetrying\":\n self.begin()\n self._retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\n return self\n\n async def __anext__(self) -> AttemptManager:\n while True:\n do = await self.iter(retry_state=self._retry_state)\n if do is None:\n raise StopAsyncIteration\n elif isinstance(do, DoAttempt):\n return AttemptManager(retry_state=self._retry_state)\n elif isinstance(do, DoSleep):\n self._retry_state.prepare_for_next_attempt()\n await self.sleep(do) # type: ignore[misc]\n else:\n raise StopAsyncIteration\n\n def wraps(self, fn: WrappedFn) -> WrappedFn:\n wrapped = super().wraps(fn)\n # Ensure wrapper is recognized as a coroutine function.\n\n @functools.wraps(\n fn, functools.WRAPPER_ASSIGNMENTS + (\"__defaults__\", \"__kwdefaults__\")\n )\n async def async_wrapped(*args: t.Any, **kwargs: t.Any) -> t.Any:\n # Always create a copy to prevent overwriting the local contexts when\n # calling the same wrapped functions multiple times in the same stack\n copy = self.copy()\n async_wrapped.statistics = copy.statistics # type: ignore[attr-defined]\n return await copy(fn, *args, **kwargs)\n\n # Preserve attributes\n async_wrapped.retry = self # type: ignore[attr-defined]\n async_wrapped.retry_with = wrapped.retry_with # type: ignore[attr-defined]\n async_wrapped.statistics = {} # type: ignore[attr-defined]\n\n return async_wrapped # type: ignore[return-value]\n\n\n__all__ = [\n \"retry_all\",\n \"retry_any\",\n \"retry_if_exception\",\n \"retry_if_result\",\n \"WrappedFn\",\n \"AsyncRetrying\",\n]\n\n[end of tenacity/asyncio/__init__.py]","filename":"tenacity/asyncio/__init__.py","id":"21"},{"content":"# Copyright 2016–2021 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\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.\nimport abc\nimport typing\n\nfrom tenacity import _utils\nfrom tenacity import retry_base\n\nif typing.TYPE_CHECKING:\n from tenacity import RetryCallState\n\n\nclass async_retry_base(retry_base):\n \"\"\"Abstract base class for async retry strategies.\"\"\"\n\n @abc.abstractmethod\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n pass\n\n def __and__( # type: ignore[override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_all\":\n return retry_all(self, other)\n\n def __rand__( # type: ignore[misc,override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_all\":\n return retry_all(other, self)\n\n def __or__( # type: ignore[override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_any\":\n return retry_any(self, other)\n\n def __ror__( # type: ignore[misc,override]\n self, other: \"typing.Union[retry_base, async_retry_base]\"\n ) -> \"retry_any\":\n return retry_any(other, self)\n\n\nRetryBaseT = typing.Union[\n async_retry_base, typing.Callable[[\"RetryCallState\"], typing.Awaitable[bool]]\n]\n\n\nclass retry_if_exception(async_retry_base):\n \"\"\"Retry strategy that retries if an exception verifies a predicate.\"\"\"\n\n def __init__(\n self, predicate: typing.Callable[[BaseException], typing.Awaitable[bool]]\n ) -> None:\n self.predicate = predicate\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if retry_state.outcome.failed:\n exception = retry_state.outcome.exception()\n if exception is None:\n raise RuntimeError(\"outcome failed but the exception is None\")\n return await self.predicate(exception)\n else:\n return False\n\n\nclass retry_if_result(async_retry_base):\n \"\"\"Retries if the result verifies a predicate.\"\"\"\n\n def __init__(\n self, predicate: typing.Callable[[typing.Any], typing.Awaitable[bool]]\n ) -> None:\n self.predicate = predicate\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n if retry_state.outcome is None:\n raise RuntimeError(\"__call__() called before outcome was set\")\n\n if not retry_state.outcome.failed:\n return await self.predicate(retry_state.outcome.result())\n else:\n return False\n\n\nclass retry_any(async_retry_base):\n \"\"\"Retries if any of the retries condition is valid.\"\"\"\n\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\n self.retries = retries\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n result = False\n for r in self.retries:\n result = result or await _utils.wrap_to_async_func(r)(retry_state)\n if result:\n break\n return result\n\n\nclass retry_all(async_retry_base):\n \"\"\"Retries if all the retries condition are valid.\"\"\"\n\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\n self.retries = retries\n\n async def __call__(self, retry_state: \"RetryCallState\") -> bool: # type: ignore[override]\n result = True\n for r in self.retries:\n result = result and await _utils.wrap_to_async_func(r)(retry_state)\n if not result:\n break\n return result\n\n[end of tenacity/asyncio/retry.py]","filename":"tenacity/asyncio/retry.py","id":"22"},{"content":"Tenacity\n========\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\n :target: https://pypi.python.org/pypi/tenacity\n\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\n :target: https://circleci.com/gh/jd/tenacity\n\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\n :target: https://mergify.io\n :alt: Mergify Status\n\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\n\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\nPython, to simplify the task of adding retry behavior to just about anything.\nIt originates from `a fork of retrying\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\napi compatible with retrying but adds significant new functionality and\nfixes a number of longstanding bugs.\n\nThe simplest use case is retrying a flaky function whenever an `Exception`\noccurs until a value is returned.\n\n.. testcode::\n\n import random\n from tenacity import retry\n\n @retry\n def do_something_unreliable():\n if random.randint(0, 10) > 1:\n raise IOError(\"Broken sauce, everything is hosed!!!111one\")\n else:\n return \"Awesome sauce!\"\n\n print(do_something_unreliable())\n\n.. testoutput::\n :hide:\n\n Awesome sauce!\n\n\n.. toctree::\n :hidden:\n :maxdepth: 2\n\n changelog\n api\n\n\nFeatures\n--------\n\n- Generic Decorator API\n- Specify stop condition (i.e. limit by number of attempts)\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\n- Customize retrying on Exceptions\n- Customize retrying on expected returned result\n- Retry on coroutines\n- Retry code block with context manager\n\n\nInstallation\n------------\n\nTo install *tenacity*, simply:\n\n.. code-block:: bash\n\n $ pip install tenacity\n\n\nExamples\n----------\n\nBasic Retry\n~~~~~~~~~~~\n\n.. testsetup::\n\n import logging\n #\n # Note the following import is used for demonstration convenience only.\n # Production code should always explicitly import the names it needs.\n #\n from tenacity import *\n\n class MyException(Exception):\n pass\n\nAs you saw above, the default behavior is to retry forever without waiting when\nan exception is raised.\n\n.. testcode::\n\n @retry\n def never_gonna_give_you_up():\n print(\"Retry forever ignoring Exceptions, don't wait between retries\")\n raise Exception\n\nStopping\n~~~~~~~~\n\nLet's be a little less persistent and set some boundaries, such as the number\nof attempts before giving up.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(7))\n def stop_after_7_attempts():\n print(\"Stopping after 7 attempts\")\n raise Exception\n\nWe don't have all day, so let's set a boundary for how long we should be\nretrying stuff.\n\n.. testcode::\n\n @retry(stop=stop_after_delay(10))\n def stop_after_10_s():\n print(\"Stopping after 10 seconds\")\n raise Exception\n\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\nthen you can give up on retries one attempt before you would exceed the delay.\n\n.. testcode::\n\n @retry(stop=stop_before_delay(10))\n def stop_before_10_s():\n print(\"Stopping 1 attempt before 10 seconds\")\n raise Exception\n\nYou can combine several stop conditions by using the `|` operator:\n\n.. testcode::\n\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\n def stop_after_10_s_or_5_retries():\n print(\"Stopping after 10 seconds or 5 retries\")\n raise Exception\n\nWaiting before retrying\n~~~~~~~~~~~~~~~~~~~~~~~\n\nMost things don't like to be polled as fast as possible, so let's just wait 2\nseconds between retries.\n\n.. testcode::\n\n @retry(wait=wait_fixed(2))\n def wait_2_s():\n print(\"Wait 2 second between retries\")\n raise Exception\n\nSome things perform best with a bit of randomness injected.\n\n.. testcode::\n\n @retry(wait=wait_random(min=1, max=2))\n def wait_random_1_to_2_s():\n print(\"Randomly wait 1 to 2 seconds between retries\")\n raise Exception\n\nThen again, it's hard to beat exponential backoff when retrying distributed\nservices and other remote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\n def wait_exponential_1():\n print(\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\")\n raise Exception\n\n\nThen again, it's also hard to beat combining fixed waits and jitter (to\nhelp avoid thundering herds) when retrying distributed services and other\nremote endpoints.\n\n.. testcode::\n\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\n def wait_fixed_jitter():\n print(\"Wait at least 3 seconds, and add up to 2 seconds of random delay\")\n raise Exception\n\nWhen multiple processes are in contention for a shared resource, exponentially\nincreasing jitter helps minimise collisions.\n\n.. testcode::\n\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\n def wait_exponential_jitter():\n print(\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\")\n raise Exception\n\n\nSometimes it's necessary to build a chain of backoffs.\n\n.. testcode::\n\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\n [wait_fixed(7) for i in range(2)] +\n [wait_fixed(9)]))\n def wait_fixed_chained():\n print(\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\")\n raise Exception\n\nWhether to retry\n~~~~~~~~~~~~~~~~\n\nWe have a few options for dealing with retries that raise specific or general\nexceptions, as in the cases here.\n\n.. testcode::\n\n class ClientError(Exception):\n \"\"\"Some type of client error.\"\"\"\n\n @retry(retry=retry_if_exception_type(IOError))\n def might_io_error():\n print(\"Retry forever with no wait if an IOError occurs, raise any other errors\")\n raise Exception\n\n @retry(retry=retry_if_not_exception_type(ClientError))\n def might_client_error():\n print(\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\")\n raise Exception\n\nWe can also use the result of the function to alter the behavior of retrying.\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=retry_if_result(is_none_p))\n def might_return_none():\n print(\"Retry with no wait if return value is None\")\n\nSee also these methods:\n\n.. testcode::\n\n retry_if_exception\n retry_if_exception_type\n retry_if_not_exception_type\n retry_unless_exception_type\n retry_if_result\n retry_if_not_result\n retry_if_exception_message\n retry_if_not_exception_message\n retry_any\n retry_all\n\nWe can also combine several conditions:\n\n.. testcode::\n\n def is_none_p(value):\n \"\"\"Return True if value is None\"\"\"\n return value is None\n\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\n def might_return_none():\n print(\"Retry forever ignoring Exceptions with no wait if return value is None\")\n\nAny combination of stop, wait, etc. is also supported to give you the freedom\nto mix and match.\n\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\nexception:\n\n.. testcode::\n\n @retry\n def do_something():\n result = something_else()\n if result == 23:\n raise TryAgain\n\nError Handling\n~~~~~~~~~~~~~~\n\nNormally when your function fails its final time (and will not be retried again based on your settings),\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\nof the stack trace.\n\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\nis most visible), you can set `reraise=True`.\n\n.. testcode::\n\n @retry(reraise=True, stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except MyException:\n # timed out retrying\n pass\n\nBefore and After Retry, and Logging\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIt's possible to execute an action before any attempt of calling the function\nby using the before callback function:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIn the same spirit, It's possible to execute after a call that failed:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\nIt's also possible to only log failures that are going to be retried. Normally\nretries happen after a wait interval, so the keyword argument is called\n``before_sleep``:\n\n.. testcode::\n\n import logging\n import sys\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n @retry(stop=stop_after_attempt(3),\n before_sleep=before_sleep_log(logger, logging.DEBUG))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n\nStatistics\n~~~~~~~~~~\n\nYou can access the statistics about the retry made over a function by using the\n`statistics` attribute attached to the function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nCustom Callbacks\n~~~~~~~~~~~~~~~~\n\nYou can also define your own callbacks. The callback should accept one\nparameter called ``retry_state`` that contains all information about current\nretry invocation.\n\nFor example, you can call a custom callback function after all retries failed,\nwithout raising an exception (or you can re-raise or do anything really)\n\n.. testcode::\n\n def return_last_value(retry_state):\n \"\"\"return the result of the last call attempt\"\"\"\n return retry_state.outcome.result()\n\n def is_false(value):\n \"\"\"Return True if value is False\"\"\"\n return value is False\n\n # will return False after trying 3 times to get a different result\n @retry(stop=stop_after_attempt(3),\n retry_error_callback=return_last_value,\n retry=retry_if_result(is_false))\n def eventually_return_false():\n return False\n\nRetryCallState\n~~~~~~~~~~~~~~\n\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\n\nOther Custom Callbacks\n~~~~~~~~~~~~~~~~~~~~~~\n\nIt's also possible to define custom callbacks for other keyword arguments.\n\n.. function:: my_stop(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should stop\n :rtype: bool\n\n.. function:: my_wait(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: number of seconds to wait before next retry\n :rtype: float\n\n.. function:: my_retry(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n :return: whether or not retrying should continue\n :rtype: bool\n\n.. function:: my_before(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_after(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\n.. function:: my_before_sleep(retry_state)\n\n :param RetryCallState retry_state: info about current retry invocation\n\nHere's an example with a custom ``before_sleep`` function:\n\n.. testcode::\n\n import logging\n\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\n\n logger = logging.getLogger(__name__)\n\n def my_before_sleep(retry_state):\n if retry_state.attempt_number < 1:\n loglevel = logging.INFO\n else:\n loglevel = logging.WARNING\n logger.log(\n loglevel, 'Retrying %s: attempt %s ended with: %s',\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\n\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception()\n except RetryError:\n pass\n\n\nChanging Arguments at Run Time\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can change the arguments of a retry decorator as needed when calling it by\nusing the `retry_with` function attached to the wrapped function:\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n try:\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nIf you want to use variables to set up the retry parameters, you don't have\nto use the `retry` decorator - you can instead use `Retrying` directly:\n\n.. testcode::\n\n def never_good_enough(arg1):\n raise Exception('Invalid argument: {}'.format(arg1))\n\n def try_never_good_enough(max_attempts=3):\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\n retryer(never_good_enough, 'I really do try')\n\nYou may also want to change the behaviour of a decorated function temporarily,\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\nattribute attached to the function. Bear in mind this is a write-only attribute,\nstatistics should be read from the function `statistics` attribute.\n\n.. testcode::\n\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\n def raise_my_exception():\n raise MyException(\"Fail\")\n\n from unittest import mock\n\n with mock.patch.object(raise_my_exception.retry, \"wait\", wait_fixed(0)):\n try:\n raise_my_exception()\n except Exception:\n pass\n\n print(raise_my_exception.statistics)\n\n.. testoutput::\n :hide:\n\n ...\n\nRetrying code block\n~~~~~~~~~~~~~~~~~~~\n\nTenacity allows you to retry a code block without the need to wraps it in an\nisolated function. This makes it easy to isolate failing block while sharing\ncontext. The trick is to combine a for loop and a context manager.\n\n.. testcode::\n\n from tenacity import Retrying, RetryError, stop_after_attempt\n\n try:\n for attempt in Retrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nYou can configure every details of retry policy by configuring the Retrying\nobject.\n\nWith async code you can use AsyncRetrying.\n\n.. testcode::\n\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\n\n async def function():\n try:\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\n with attempt:\n raise Exception('My code is failing!')\n except RetryError:\n pass\n\nIn both cases, you may want to set the result to the attempt so it's available\nin retry strategies like ``retry_if_result``. This can be done accessing the\n``retry_state`` property:\n\n.. testcode::\n\n from tenacity import AsyncRetrying, retry_if_result\n\n async def function():\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\n with attempt:\n result = 1 # Some complex calculation, function call, etc.\n if not attempt.retry_state.outcome.failed:\n attempt.retry_state.set_result(result)\n return result\n\nAsync and retry\n~~~~~~~~~~~~~~~\n\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\nSleeps are done asynchronously too.\n\n.. code-block:: python\n\n @retry\n async def my_asyncio_function(loop):\n await loop.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n async def my_async_trio_function():\n await trio.socket.getaddrinfo('8.8.8.8', 53)\n\n.. code-block:: python\n\n @retry\n @tornado.gen.coroutine\n def my_async_tornado_function(http_client, url):\n yield http_client.fetch(url)\n\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\n\n.. code-block:: python\n\n @retry(sleep=curio.sleep)\n async def my_async_curio_function():\n await asks.get('https://example.org')\n\nContribute\n----------\n\n#. Check for open issues or open a fresh issue to start a discussion around a\n feature idea or a bug.\n#. Fork `the repository`_ on GitHub to start making your changes to the\n **main** branch (or branch off of it).\n#. Write a test which shows that the bug was fixed or that the feature works as\n expected.\n#. Add a `changelog <#Changelogs>`_\n#. Make the docs better (or more detailed, or more easier to read, or ...)\n\n.. _`the repository`: https://github.com/jd/tenacity\n\nChangelogs\n~~~~~~~~~~\n\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\n\nThe doc generation will automatically compile the changelogs. You just need to add them.\n\n.. code-block:: sh\n\n # Opens a template file in an editor\n tox -e reno -- new some-slug-for-my-change --edit\n\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\n\n[end of doc/source/index.rst]","filename":"doc/source/index.rst","id":"23"},{"content":"# Copyright 2016 Étienne Bersac\n# Copyright 2016 Julien Danjou\n# Copyright 2016 Joshua Harlow\n# Copyright 2013-2014 Ray Holder\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport os\nimport sys\n\nmaster_doc = \"index\"\nproject = \"Tenacity\"\n\n# Add tenacity to the path, so sphinx can find the functions for autodoc.\nsys.path.insert(0, os.path.abspath(\"../..\"))\n\nextensions = [\n \"sphinx.ext.doctest\",\n \"sphinx.ext.autodoc\",\n \"reno.sphinxext\",\n]\n\n# -- Options for sphinx.ext.doctest -----------------------------------------\n\n# doctest_default_flags =\ncwd = os.path.abspath(os.path.dirname(__file__))\ntenacity_path = os.path.join(cwd, os.pardir, os.pardir)\ndoctest_path = [tenacity_path]\n# doctest_global_setup =\n# doctest_global_cleanup =\n# doctest_test_doctest_blocks =\n\n[end of doc/source/conf.py]","filename":"doc/source/conf.py","id":"24"},{"content":"Changelog\n=========\n\n.. release-notes::\n\n[end of doc/source/changelog.rst]","filename":"doc/source/changelog.rst","id":"25"},{"content":"===============\n API Reference\n===============\n\nRetry Main API\n--------------\n\n.. autofunction:: tenacity.retry\n :noindex:\n\n.. autoclass:: tenacity.Retrying\n :members:\n\n.. autoclass:: tenacity.AsyncRetrying\n :members:\n\n.. autoclass:: tenacity.tornadoweb.TornadoRetrying\n :members:\n\n.. autoclass:: tenacity.RetryCallState\n :members:\n\nAfter Functions\n---------------\n\nThose functions can be used as the `after` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.after\n :members:\n\nBefore Functions\n----------------\n\nThose functions can be used as the `before` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.before\n :members:\n\nBefore Sleep Functions\n----------------------\n\nThose functions can be used as the `before_sleep` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.before_sleep\n :members:\n\nNap Functions\n-------------\n\nThose functions can be used as the `sleep` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.nap\n :members:\n\nRetry Functions\n---------------\n\nThose functions can be used as the `retry` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.retry\n :members:\n\nStop Functions\n--------------\n\nThose functions can be used as the `stop` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.stop\n :members:\n\nWait Functions\n--------------\n\nThose functions can be used as the `wait` keyword argument of\n:py:func:`tenacity.retry`.\n\n.. automodule:: tenacity.wait\n :members:\n\n[end of doc/source/api.rst]","filename":"doc/source/api.rst","id":"26"},{"content":"---\nupgrade:\n - |\n Support for Python 3.6 has been removed.\n\n[end of releasenotes/notes/remove-py36-876c0416cf279d15.yaml]","filename":"releasenotes/notes/remove-py36-876c0416cf279d15.yaml","id":"27"},{"content":"---\nfixes:\n - |\n Fix async loop with retrying code block when result is available.\n\n[end of releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml]","filename":"releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml","id":"28"},{"content":"---\nupgrade:\n - \"Removed `BaseRetrying.call`: was long time deprecated and produced `DeprecationWarning`\"\n - \"Removed `BaseRetrying.fn`: was noted as deprecated\"\n - \"API change: `BaseRetrying.begin()` do not require arguments anymore as it not setting `BaseRetrying.fn`\"\n\n[end of releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml]","filename":"releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml","id":"29"},{"content":"---\nfixes:\n - Fix setuptools config to include tenacity.asyncio package in release distributions.\n\n[end of releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml]","filename":"releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml","id":"30"},{"content":"---\nother:\n - Add a \\\"test\\\" extra\n\n[end of releasenotes/notes/add-test-extra-55e869261b03e56d.yaml]","filename":"releasenotes/notes/add-test-extra-55e869261b03e56d.yaml","id":"31"},{"content":"---\nfixes:\n - |\n Use str.format to format the logs internally to make logging compatible with other logger such as loguru.\n\n[end of releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml]","filename":"releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml","id":"32"},{"content":"---\nother:\n - Unit tests can now mock ``nap.sleep()`` for testing in all tenacity usage styles\n[end of releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml]","filename":"releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml","id":"33"},{"content":"---\nfixes:\n - \"Fix after_log logger format: function name was used with delay formatting.\"\n\n[end of releasenotes/notes/after_log-50f4d73b24ce9203.yaml]","filename":"releasenotes/notes/after_log-50f4d73b24ce9203.yaml","id":"34"},{"content":"---\nother:\n - \"Use `black` for code formatting and validate using `black --check`. Code compatibility: py26-py39.\"\n - \"Enforce maximal line length to 120 symbols\"\n\n[end of releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml]","filename":"releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml","id":"35"},{"content":"---\nfixes:\n - |\n Preserve __defaults__ and __kwdefaults__ through retry decorator\n\n[end of releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml]","filename":"releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml","id":"36"},{"content":"---\nfeatures:\n - Add ``retry_if_not_exception_type()`` that allows to retry if a raised exception doesn't match given exceptions.\n\n[end of releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml]","filename":"releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml","id":"37"},{"content":"---\nfixes:\n - |\n Argument `wait` was improperly annotated, making mypy checks fail.\n Now it's annotated as `typing.Union[wait_base, typing.Callable[[\"RetryCallState\"], typing.Union[float, int]]]`\n\n[end of releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml]","filename":"releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml","id":"38"},{"content":"---\nfeatures:\n - Explicitly export convenience symbols from tenacity root module\n\n[end of releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml]","filename":"releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml","id":"39"},{"content":"---\nfeatures:\n - Add ``datetime.timedelta`` as accepted wait unit type.\n\n[end of releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml]","filename":"releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml","id":"40"},{"content":"---\nother:\n - |\n Add a Dependabot configuration submit PRs monthly (as needed)\n to keep GitHub action versions updated.\n\n[end of releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml]","filename":"releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml","id":"41"},{"content":"---\nfeatures:\n - |\n Add a new `retry_base` class called `retry_if_exception_cause_type` that\n checks, recursively, if any of the causes of the raised exception is of a certain type.\n\n[end of releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml]","filename":"releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml","id":"42"},{"content":"---\nfeatures:\n - |\n Added the ability to use async functions for retries. This way, you can now use\n asyncio coroutines for retry strategy predicates.\n\n[end of releasenotes/notes/add-async-actions-b249c527d99723bb.yaml]","filename":"releasenotes/notes/add-async-actions-b249c527d99723bb.yaml","id":"43"},{"content":"---\nprelude: >\n Clarify usage of `reraise` keyword argument\n\n[end of releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml]","filename":"releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml","id":"44"},{"content":"---\nfixes: Sphinx build error where Sphinx complains about an undefined class.\n\n[end of releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml]","filename":"releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml","id":"45"},{"content":"---\nfeatures:\n - Add reno (changelog system)\n\n[end of releasenotes/notes/add-reno-d1ab5710f272650a.yaml]","filename":"releasenotes/notes/add-reno-d1ab5710f272650a.yaml","id":"46"},{"content":"---\nfixes:\n - |\n Avoid overwriting local contexts when applying the retry decorator.\n\n[end of releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml]","filename":"releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml","id":"47"},{"content":"---\nfeatures:\n - Most part of the code is type annotated.\n - Python 3.10 support has been added.\n\n[end of releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml]","filename":"releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml","id":"48"},{"content":"---\nother:\n - Add type annotations to cover all public API.\n\n[end of releasenotes/notes/annotate_code-197b93130df14042.yaml]","filename":"releasenotes/notes/annotate_code-197b93130df14042.yaml","id":"49"},{"content":"---\nfixes:\n - |\n `AsyncRetrying` was erroneously implementing `__iter__()`, making tenacity\n retrying mechanism working but in a synchronous fashion and not waiting as\n expected. This interface has been removed, `__aiter__()` should be used\n instead.\n\n[end of releasenotes/notes/no-async-iter-6132a42e52348a75.yaml]","filename":"releasenotes/notes/no-async-iter-6132a42e52348a75.yaml","id":"50"},{"content":"---\nfeatures:\n - |\n Added a new stop function: stop_before_delay, which will stop execution\n if the next sleep time would cause overall delay to exceed the specified delay. \n Useful for use cases where you have some upper bound on retry times that you must\n not exceed, so returning before that timeout is preferable than returning after that timeout.\n[end of releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml]","filename":"releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml","id":"51"},{"content":"---\nfeatures:\n - |\n If you're using `Trio <https://trio.readthedocs.io>`__, then\n ``@retry`` now works automatically. It's no longer necessary to\n pass ``sleep=trio.sleep``.\n\n[end of releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml]","filename":"releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml","id":"52"},{"content":"---\nother: >-\n Corrected the PyPI-published wheel tag to match the\n metadata saying that the release is Python 3 only.\n...\n\n[end of releasenotes/notes/pr320-py3-only-wheel-tag.yaml]","filename":"releasenotes/notes/pr320-py3-only-wheel-tag.yaml","id":"53"},{"content":"---\nfeatures:\n - |\n - accept ``datetime.timedelta`` instances as argument to ``tenacity.stop.stop_after_delay``\n\n[end of releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml]","filename":"releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml","id":"54"},{"content":"---\nfixes:\n - |\n Restore the value of the `retry` attribute for wrapped functions. Also,\n clarify that those attributes are write-only and statistics should be\n read from the function attribute directly.\n\n[end of releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml]","filename":"releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml","id":"55"},{"content":"---\nfixes:\n - \"Fix issue #288 : __name__ and other attributes for async functions\"\n\n[end of releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml]","filename":"releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml","id":"56"},{"content":"---\nother:\n - |\n Added a link to the documentation, as code snippets are not being rendered properly\n Changed branch name to main in index.rst\n\n[end of releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml]","filename":"releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml","id":"57"},{"content":"---\nfixes:\n - |\n Respects `min` arg for `wait_random_exponential`\n\n[end of releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml]","filename":"releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml","id":"58"},{"content":"---\nfeatures:\n - Add a ``__repr__`` method to ``RetryCallState`` objects for easier debugging.\n\n[end of releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml]","filename":"releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml","id":"59"},{"content":"---\nother:\n - |\n Drop support for deprecated Python versions (2.7 and 3.5)\n\n[end of releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml]","filename":"releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml","id":"60"},{"content":"---\nfeatures:\n - Add an ``exc_info`` option to the ``before_sleep_log()`` strategy.\n[end of releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml]","filename":"releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml","id":"61"},{"content":"---\nother:\n - Add `retry_if_exception_cause_type`and `wait_exponential_jitter` to __all__ of init.py\n[end of releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml]","filename":"releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml","id":"62"},{"content":"---\nfeatures:\n - |\n Implement a wait.wait_exponential_jitter per Google's storage retry guide.\n See https://cloud.google.com/storage/docs/retry-strategy\n\n[end of releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml]","filename":"releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml","id":"63"}],"string":"[\n {\n \"content\": \"queue_rules:\\n - name: default\\n merge_method: squash\\n queue_conditions:\\n - or:\\n - author = jd\\n - \\\"#approved-reviews-by >= 1\\\"\\n - author = dependabot[bot]\\n - or:\\n - files ~= ^releasenotes/notes/\\n - label = no-changelog\\n - author = dependabot[bot]\\n - \\\"check-success=test (3.9, py39)\\\"\\n - \\\"check-success=test (3.10, py310)\\\"\\n - \\\"check-success=test (3.11, py311)\\\"\\n - \\\"check-success=test (3.12, py312)\\\"\\n - \\\"check-success=test (3.13, py313,py313-trio)\\\"\\n - \\\"check-success=test (3.12, pep8)\\\"\\n\\npull_request_rules:\\n - name: warn on no changelog\\n conditions:\\n - -files~=^releasenotes/notes/\\n - label!=no-changelog\\n - -closed\\n actions:\\n comment:\\n message: >\\n ⚠️ No release notes detected. Please make sure to use\\n [reno](https://docs.openstack.org/reno/latest/user/usage.html) to add\\n a changelog entry.\\n\\n - name: automatic queue\\n conditions: []\\n actions:\\n queue:\\n\\n - name: dismiss reviews\\n conditions: []\\n actions:\\n dismiss_reviews: {}\\n\\n[end of .mergify.yml]\",\n \"filename\": \".mergify.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"---\\nunreleased_version_title: Unreleased\\n\\n[end of reno.yaml]\",\n \"filename\": \"reno.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"Apache License\\n Version 2.0, January 2004\\n http://www.apache.org/licenses/\\n\\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\\n\\n 1. Definitions.\\n\\n \\\"License\\\" shall mean the terms and conditions for use, reproduction,\\n and distribution as defined by Sections 1 through 9 of this document.\\n\\n \\\"Licensor\\\" shall mean the copyright owner or entity authorized by\\n the copyright owner that is granting the License.\\n\\n \\\"Legal Entity\\\" shall mean the union of the acting entity and all\\n other entities that control, are controlled by, or are under common\\n control with that entity. For the purposes of this definition,\\n \\\"control\\\" means (i) the power, direct or indirect, to cause the\\n direction or management of such entity, whether by contract or\\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\\n outstanding shares, or (iii) beneficial ownership of such entity.\\n\\n \\\"You\\\" (or \\\"Your\\\") shall mean an individual or Legal Entity\\n exercising permissions granted by this License.\\n\\n \\\"Source\\\" form shall mean the preferred form for making modifications,\\n including but not limited to software source code, documentation\\n source, and configuration files.\\n\\n \\\"Object\\\" form shall mean any form resulting from mechanical\\n transformation or translation of a Source form, including but\\n not limited to compiled object code, generated documentation,\\n and conversions to other media types.\\n\\n \\\"Work\\\" shall mean the work of authorship, whether in Source or\\n Object form, made available under the License, as indicated by a\\n copyright notice that is included in or attached to the work\\n (an example is provided in the Appendix below).\\n\\n \\\"Derivative Works\\\" shall mean any work, whether in Source or Object\\n form, that is based on (or derived from) the Work and for which the\\n editorial revisions, annotations, elaborations, or other modifications\\n represent, as a whole, an original work of authorship. For the purposes\\n of this License, Derivative Works shall not include works that remain\\n separable from, or merely link (or bind by name) to the interfaces of,\\n the Work and Derivative Works thereof.\\n\\n \\\"Contribution\\\" shall mean any work of authorship, including\\n the original version of the Work and any modifications or additions\\n to that Work or Derivative Works thereof, that is intentionally\\n submitted to Licensor for inclusion in the Work by the copyright owner\\n or by an individual or Legal Entity authorized to submit on behalf of\\n the copyright owner. For the purposes of this definition, \\\"submitted\\\"\\n means any form of electronic, verbal, or written communication sent\\n to the Licensor or its representatives, including but not limited to\\n communication on electronic mailing lists, source code control systems,\\n and issue tracking systems that are managed by, or on behalf of, the\\n Licensor for the purpose of discussing and improving the Work, but\\n excluding communication that is conspicuously marked or otherwise\\n designated in writing by the copyright owner as \\\"Not a Contribution.\\\"\\n\\n \\\"Contributor\\\" shall mean Licensor and any individual or Legal Entity\\n on behalf of whom a Contribution has been received by Licensor and\\n subsequently incorporated within the Work.\\n\\n 2. Grant of Copyright License. Subject to the terms and conditions of\\n this License, each Contributor hereby grants to You a perpetual,\\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\\n copyright license to reproduce, prepare Derivative Works of,\\n publicly display, publicly perform, sublicense, and distribute the\\n Work and such Derivative Works in Source or Object form.\\n\\n 3. Grant of Patent License. Subject to the terms and conditions of\\n this License, each Contributor hereby grants to You a perpetual,\\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\\n (except as stated in this section) patent license to make, have made,\\n use, offer to sell, sell, import, and otherwise transfer the Work,\\n where such license applies only to those patent claims licensable\\n by such Contributor that are necessarily infringed by their\\n Contribution(s) alone or by combination of their Contribution(s)\\n with the Work to which such Contribution(s) was submitted. If You\\n institute patent litigation against any entity (including a\\n cross-claim or counterclaim in a lawsuit) alleging that the Work\\n or a Contribution incorporated within the Work constitutes direct\\n or contributory patent infringement, then any patent licenses\\n granted to You under this License for that Work shall terminate\\n as of the date such litigation is filed.\\n\\n 4. Redistribution. You may reproduce and distribute copies of the\\n Work or Derivative Works thereof in any medium, with or without\\n modifications, and in Source or Object form, provided that You\\n meet the following conditions:\\n\\n (a) You must give any other recipients of the Work or\\n Derivative Works a copy of this License; and\\n\\n (b) You must cause any modified files to carry prominent notices\\n stating that You changed the files; and\\n\\n (c) You must retain, in the Source form of any Derivative Works\\n that You distribute, all copyright, patent, trademark, and\\n attribution notices from the Source form of the Work,\\n excluding those notices that do not pertain to any part of\\n the Derivative Works; and\\n\\n (d) If the Work includes a \\\"NOTICE\\\" text file as part of its\\n distribution, then any Derivative Works that You distribute must\\n include a readable copy of the attribution notices contained\\n within such NOTICE file, excluding those notices that do not\\n pertain to any part of the Derivative Works, in at least one\\n of the following places: within a NOTICE text file distributed\\n as part of the Derivative Works; within the Source form or\\n documentation, if provided along with the Derivative Works; or,\\n within a display generated by the Derivative Works, if and\\n wherever such third-party notices normally appear. The contents\\n of the NOTICE file are for informational purposes only and\\n do not modify the License. You may add Your own attribution\\n notices within Derivative Works that You distribute, alongside\\n or as an addendum to the NOTICE text from the Work, provided\\n that such additional attribution notices cannot be construed\\n as modifying the License.\\n\\n You may add Your own copyright statement to Your modifications and\\n may provide additional or different license terms and conditions\\n for use, reproduction, or distribution of Your modifications, or\\n for any such Derivative Works as a whole, provided Your use,\\n reproduction, and distribution of the Work otherwise complies with\\n the conditions stated in this License.\\n\\n 5. Submission of Contributions. Unless You explicitly state otherwise,\\n any Contribution intentionally submitted for inclusion in the Work\\n by You to the Licensor shall be under the terms and conditions of\\n this License, without any additional terms or conditions.\\n Notwithstanding the above, nothing herein shall supersede or modify\\n the terms of any separate license agreement you may have executed\\n with Licensor regarding such Contributions.\\n\\n 6. Trademarks. This License does not grant permission to use the trade\\n names, trademarks, service marks, or product names of the Licensor,\\n except as required for reasonable and customary use in describing the\\n origin of the Work and reproducing the content of the NOTICE file.\\n\\n 7. Disclaimer of Warranty. Unless required by applicable law or\\n agreed to in writing, Licensor provides the Work (and each\\n Contributor provides its Contributions) on an \\\"AS IS\\\" BASIS,\\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\\n implied, including, without limitation, any warranties or conditions\\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\\n PARTICULAR PURPOSE. You are solely responsible for determining the\\n appropriateness of using or redistributing the Work and assume any\\n risks associated with Your exercise of permissions under this License.\\n\\n 8. Limitation of Liability. In no event and under no legal theory,\\n whether in tort (including negligence), contract, or otherwise,\\n unless required by applicable law (such as deliberate and grossly\\n negligent acts) or agreed to in writing, shall any Contributor be\\n liable to You for damages, including any direct, indirect, special,\\n incidental, or consequential damages of any character arising as a\\n result of this License or out of the use or inability to use the\\n Work (including but not limited to damages for loss of goodwill,\\n work stoppage, computer failure or malfunction, or any and all\\n other commercial damages or losses), even if such Contributor\\n has been advised of the possibility of such damages.\\n\\n 9. Accepting Warranty or Additional Liability. While redistributing\\n the Work or Derivative Works thereof, You may choose to offer,\\n and charge a fee for, acceptance of support, warranty, indemnity,\\n or other liability obligations and/or rights consistent with this\\n License. However, in accepting such obligations, You may act only\\n on Your own behalf and on Your sole responsibility, not on behalf\\n of any other Contributor, and only if You agree to indemnify,\\n defend, and hold each Contributor harmless for any liability\\n incurred by, or claims asserted against, such Contributor by reason\\n of your accepting any such warranty or additional liability.\\n\\n END OF TERMS AND CONDITIONS\\n\\n APPENDIX: How to apply the Apache License to your work.\\n\\n To apply the Apache License to your work, attach the following\\n boilerplate notice, with the fields enclosed by brackets \\\"[]\\\"\\n replaced with your own identifying information. (Don't include\\n the brackets!) The text should be enclosed in the appropriate\\n comment syntax for the file format. We also recommend that a\\n file or class name and description of purpose be included on the\\n same \\\"printed page\\\" as the copyright notice for easier\\n identification within third-party archives.\\n\\n Copyright [yyyy] [name of copyright owner]\\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[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[build-system]\\n# Minimum requirements for the build system to execute.\\n# PEP 508 specifications for PEP 518.\\n# Banned setuptools versions have well-known issues\\nrequires = [\\n \\\"setuptools >= 21.0.0,!=24.0.0,!=34.0.0,!=34.0.1,!=34.0.2,!=34.0.3,!=34.1.0,!=34.1.1,!=34.2.0,!=34.3.0,!=34.3.1,!=34.3.2,!=36.2.0\\\", # PSF/ZPL\\n \\\"setuptools_scm[toml]>=3.4\\\",\\n]\\nbuild-backend=\\\"setuptools.build_meta\\\"\\n\\n[tool.ruff]\\nline-length = 88\\nindent-width = 4\\ntarget-version = \\\"py39\\\"\\n\\n[tool.mypy]\\nstrict = true\\nfiles = [\\\"tenacity\\\", \\\"tests\\\"]\\nshow_error_codes = true\\n\\n[[tool.mypy.overrides]]\\nmodule = \\\"tornado.*\\\"\\nignore_missing_imports = true\\n\\n[tool.setuptools_scm]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"version: 2\\npython:\\n install:\\n - method: pip\\n path: .\\n extra_requirements:\\n - doc\\n\\n[end of .readthedocs.yml]\",\n \"filename\": \".readthedocs.yml\",\n \"id\": \"4\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\ncharset = utf-8\\nend_of_line = lf\\nindent_size = 2\\nindent_style = space\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\n\\n[*.{py,pyx,pxd,pyi}]\\nindent_size = 4\\nmax_line_length = 120\\n\\n[*.ini]\\nindent_size = 4\\n\\n[*.rst]\\nmax_line_length = 150\\n\\n[Makefile]\\nindent_style = tab\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"5\"\n },\n {\n \"content\": \"#!/usr/bin/env python\\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\\n# implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport setuptools\\n\\nsetuptools.setup(\\n setup_requires=[\\\"setuptools_scm\\\"],\\n use_scm_version=True,\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"[tox]\\n# we only test trio on latest python version\\nenvlist = py3{9,10,11,12,13,13-trio}, pep8, pypy3\\nskip_missing_interpreters = True\\n\\n[testenv]\\nusedevelop = True\\nsitepackages = False\\ndeps =\\n .[test]\\n .[doc]\\n trio: trio\\ncommands =\\n py3{8,9,10,11,12,13},pypy3: pytest {posargs}\\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b doctest doc/source doc/build\\n py3{8,9,10,11,12,13},pypy3: sphinx-build -a -E -W -b html doc/source doc/build\\n\\n[testenv:pep8]\\nbasepython = python3\\ndeps = ruff\\ncommands =\\n ruff check . {posargs}\\n ruff format --check . {posargs}\\n\\n[testenv:mypy]\\ndeps =\\n mypy>=1.0.0\\n pytest # for stubs\\n trio\\ncommands =\\n mypy {posargs}\\n\\n[testenv:reno]\\nbasepython = python3\\ndeps = reno\\ncommands = reno {posargs}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"7\"\n },\n {\n \"content\": \"[metadata]\\nname = tenacity\\nlicense = Apache 2.0\\nurl = https://github.com/jd/tenacity\\nsummary = Retry code until it succeeds\\nlong_description = Tenacity is a general-purpose retrying library to simplify the task of adding retry behavior to just about anything.\\nauthor = Julien Danjou\\nauthor_email = julien@danjou.info\\nhome_page = https://github.com/jd/tenacity\\nclassifier =\\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 :: Only\\n Programming Language :: Python :: 3.9\\n Programming Language :: Python :: 3.10\\n Programming Language :: Python :: 3.11\\n Programming Language :: Python :: 3.12\\n Programming Language :: Python :: 3.13\\n Topic :: Utilities\\n\\n[options]\\ninstall_requires =\\npython_requires = >=3.9\\npackages = find:\\n\\n[options.packages.find]\\ninclude = tenacity*\\nexclude = tests\\n\\n[options.package_data]\\ntenacity = py.typed\\n\\n[options.extras_require]\\ndoc =\\n reno\\n sphinx\\ntest =\\n pytest\\n tornado>=4.5\\n typeguard\\n\\n[tool:pytest]\\nfilterwarnings =\\n # Show any DeprecationWarnings once\\n once::DeprecationWarning\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"8\"\n },\n {\n \"content\": \"Tenacity\\n========\\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\\n :target: https://pypi.python.org/pypi/tenacity\\n\\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\\n :target: https://circleci.com/gh/jd/tenacity\\n\\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\\n :target: https://mergify.io\\n :alt: Mergify Status\\n\\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\\n\\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\\nPython, to simplify the task of adding retry behavior to just about anything.\\nIt originates from `a fork of retrying\\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\\napi compatible with retrying but adds significant new functionality and\\nfixes a number of longstanding bugs.\\n\\nThe simplest use case is retrying a flaky function whenever an `Exception`\\noccurs until a value is returned.\\n\\n.. testcode::\\n\\n import random\\n from tenacity import retry\\n\\n @retry\\n def do_something_unreliable():\\n if random.randint(0, 10) > 1:\\n raise IOError(\\\"Broken sauce, everything is hosed!!!111one\\\")\\n else:\\n return \\\"Awesome sauce!\\\"\\n\\n print(do_something_unreliable())\\n\\n.. testoutput::\\n :hide:\\n\\n Awesome sauce!\\n\\n\\n.. toctree::\\n :hidden:\\n :maxdepth: 2\\n\\n changelog\\n api\\n\\n\\nFeatures\\n--------\\n\\n- Generic Decorator API\\n- Specify stop condition (i.e. limit by number of attempts)\\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\\n- Customize retrying on Exceptions\\n- Customize retrying on expected returned result\\n- Retry on coroutines\\n- Retry code block with context manager\\n\\n\\nInstallation\\n------------\\n\\nTo install *tenacity*, simply:\\n\\n.. code-block:: bash\\n\\n $ pip install tenacity\\n\\n\\nExamples\\n----------\\n\\nBasic Retry\\n~~~~~~~~~~~\\n\\n.. testsetup::\\n\\n import logging\\n #\\n # Note the following import is used for demonstration convenience only.\\n # Production code should always explicitly import the names it needs.\\n #\\n from tenacity import *\\n\\n class MyException(Exception):\\n pass\\n\\nAs you saw above, the default behavior is to retry forever without waiting when\\nan exception is raised.\\n\\n.. testcode::\\n\\n @retry\\n def never_gonna_give_you_up():\\n print(\\\"Retry forever ignoring Exceptions, don't wait between retries\\\")\\n raise Exception\\n\\nStopping\\n~~~~~~~~\\n\\nLet's be a little less persistent and set some boundaries, such as the number\\nof attempts before giving up.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(7))\\n def stop_after_7_attempts():\\n print(\\\"Stopping after 7 attempts\\\")\\n raise Exception\\n\\nWe don't have all day, so let's set a boundary for how long we should be\\nretrying stuff.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_delay(10))\\n def stop_after_10_s():\\n print(\\\"Stopping after 10 seconds\\\")\\n raise Exception\\n\\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\\nthen you can give up on retries one attempt before you would exceed the delay.\\n\\n.. testcode::\\n\\n @retry(stop=stop_before_delay(10))\\n def stop_before_10_s():\\n print(\\\"Stopping 1 attempt before 10 seconds\\\")\\n raise Exception\\n\\nYou can combine several stop conditions by using the `|` operator:\\n\\n.. testcode::\\n\\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\\n def stop_after_10_s_or_5_retries():\\n print(\\\"Stopping after 10 seconds or 5 retries\\\")\\n raise Exception\\n\\nWaiting before retrying\\n~~~~~~~~~~~~~~~~~~~~~~~\\n\\nMost things don't like to be polled as fast as possible, so let's just wait 2\\nseconds between retries.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(2))\\n def wait_2_s():\\n print(\\\"Wait 2 second between retries\\\")\\n raise Exception\\n\\nSome things perform best with a bit of randomness injected.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random(min=1, max=2))\\n def wait_random_1_to_2_s():\\n print(\\\"Randomly wait 1 to 2 seconds between retries\\\")\\n raise Exception\\n\\nThen again, it's hard to beat exponential backoff when retrying distributed\\nservices and other remote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\\n def wait_exponential_1():\\n print(\\\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\\\")\\n raise Exception\\n\\n\\nThen again, it's also hard to beat combining fixed waits and jitter (to\\nhelp avoid thundering herds) when retrying distributed services and other\\nremote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\\n def wait_fixed_jitter():\\n print(\\\"Wait at least 3 seconds, and add up to 2 seconds of random delay\\\")\\n raise Exception\\n\\nWhen multiple processes are in contention for a shared resource, exponentially\\nincreasing jitter helps minimise collisions.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\\n def wait_exponential_jitter():\\n print(\\\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\\\")\\n raise Exception\\n\\n\\nSometimes it's necessary to build a chain of backoffs.\\n\\n.. testcode::\\n\\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\\n [wait_fixed(7) for i in range(2)] +\\n [wait_fixed(9)]))\\n def wait_fixed_chained():\\n print(\\\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\\\")\\n raise Exception\\n\\nWhether to retry\\n~~~~~~~~~~~~~~~~\\n\\nWe have a few options for dealing with retries that raise specific or general\\nexceptions, as in the cases here.\\n\\n.. testcode::\\n\\n class ClientError(Exception):\\n \\\"\\\"\\\"Some type of client error.\\\"\\\"\\\"\\n\\n @retry(retry=retry_if_exception_type(IOError))\\n def might_io_error():\\n print(\\\"Retry forever with no wait if an IOError occurs, raise any other errors\\\")\\n raise Exception\\n\\n @retry(retry=retry_if_not_exception_type(ClientError))\\n def might_client_error():\\n print(\\\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\\\")\\n raise Exception\\n\\nWe can also use the result of the function to alter the behavior of retrying.\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=retry_if_result(is_none_p))\\n def might_return_none():\\n print(\\\"Retry with no wait if return value is None\\\")\\n\\nSee also these methods:\\n\\n.. testcode::\\n\\n retry_if_exception\\n retry_if_exception_type\\n retry_if_not_exception_type\\n retry_unless_exception_type\\n retry_if_result\\n retry_if_not_result\\n retry_if_exception_message\\n retry_if_not_exception_message\\n retry_any\\n retry_all\\n\\nWe can also combine several conditions:\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\\n def might_return_none():\\n print(\\\"Retry forever ignoring Exceptions with no wait if return value is None\\\")\\n\\nAny combination of stop, wait, etc. is also supported to give you the freedom\\nto mix and match.\\n\\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\\nexception:\\n\\n.. testcode::\\n\\n @retry\\n def do_something():\\n result = something_else()\\n if result == 23:\\n raise TryAgain\\n\\nError Handling\\n~~~~~~~~~~~~~~\\n\\nNormally when your function fails its final time (and will not be retried again based on your settings),\\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\\nof the stack trace.\\n\\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\\nis most visible), you can set `reraise=True`.\\n\\n.. testcode::\\n\\n @retry(reraise=True, stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except MyException:\\n # timed out retrying\\n pass\\n\\nBefore and After Retry, and Logging\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's possible to execute an action before any attempt of calling the function\\nby using the before callback function:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIn the same spirit, It's possible to execute after a call that failed:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIt's also possible to only log failures that are going to be retried. Normally\\nretries happen after a wait interval, so the keyword argument is called\\n``before_sleep``:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3),\\n before_sleep=before_sleep_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n\\nStatistics\\n~~~~~~~~~~\\n\\nYou can access the statistics about the retry made over a function by using the\\n`statistics` attribute attached to the function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nCustom Callbacks\\n~~~~~~~~~~~~~~~~\\n\\nYou can also define your own callbacks. The callback should accept one\\nparameter called ``retry_state`` that contains all information about current\\nretry invocation.\\n\\nFor example, you can call a custom callback function after all retries failed,\\nwithout raising an exception (or you can re-raise or do anything really)\\n\\n.. testcode::\\n\\n def return_last_value(retry_state):\\n \\\"\\\"\\\"return the result of the last call attempt\\\"\\\"\\\"\\n return retry_state.outcome.result()\\n\\n def is_false(value):\\n \\\"\\\"\\\"Return True if value is False\\\"\\\"\\\"\\n return value is False\\n\\n # will return False after trying 3 times to get a different result\\n @retry(stop=stop_after_attempt(3),\\n retry_error_callback=return_last_value,\\n retry=retry_if_result(is_false))\\n def eventually_return_false():\\n return False\\n\\nRetryCallState\\n~~~~~~~~~~~~~~\\n\\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\\n\\nOther Custom Callbacks\\n~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's also possible to define custom callbacks for other keyword arguments.\\n\\n.. function:: my_stop(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should stop\\n :rtype: bool\\n\\n.. function:: my_wait(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: number of seconds to wait before next retry\\n :rtype: float\\n\\n.. function:: my_retry(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should continue\\n :rtype: bool\\n\\n.. function:: my_before(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_after(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_before_sleep(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\nHere's an example with a custom ``before_sleep`` function:\\n\\n.. testcode::\\n\\n import logging\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n def my_before_sleep(retry_state):\\n if retry_state.attempt_number < 1:\\n loglevel = logging.INFO\\n else:\\n loglevel = logging.WARNING\\n logger.log(\\n loglevel, 'Retrying %s: attempt %s ended with: %s',\\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\\n\\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except RetryError:\\n pass\\n\\n\\nChanging Arguments at Run Time\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nYou can change the arguments of a retry decorator as needed when calling it by\\nusing the `retry_with` function attached to the wrapped function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nIf you want to use variables to set up the retry parameters, you don't have\\nto use the `retry` decorator - you can instead use `Retrying` directly:\\n\\n.. testcode::\\n\\n def never_good_enough(arg1):\\n raise Exception('Invalid argument: {}'.format(arg1))\\n\\n def try_never_good_enough(max_attempts=3):\\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\\n retryer(never_good_enough, 'I really do try')\\n\\nYou may also want to change the behaviour of a decorated function temporarily,\\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\\nattribute attached to the function. Bear in mind this is a write-only attribute,\\nstatistics should be read from the function `statistics` attribute.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n from unittest import mock\\n\\n with mock.patch.object(raise_my_exception.retry, \\\"wait\\\", wait_fixed(0)):\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nRetrying code block\\n~~~~~~~~~~~~~~~~~~~\\n\\nTenacity allows you to retry a code block without the need to wraps it in an\\nisolated function. This makes it easy to isolate failing block while sharing\\ncontext. The trick is to combine a for loop and a context manager.\\n\\n.. testcode::\\n\\n from tenacity import Retrying, RetryError, stop_after_attempt\\n\\n try:\\n for attempt in Retrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nYou can configure every details of retry policy by configuring the Retrying\\nobject.\\n\\nWith async code you can use AsyncRetrying.\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\\n\\n async def function():\\n try:\\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nIn both cases, you may want to set the result to the attempt so it's available\\nin retry strategies like ``retry_if_result``. This can be done accessing the\\n``retry_state`` property:\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, retry_if_result\\n\\n async def function():\\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\\n with attempt:\\n result = 1 # Some complex calculation, function call, etc.\\n if not attempt.retry_state.outcome.failed:\\n attempt.retry_state.set_result(result)\\n return result\\n\\nAsync and retry\\n~~~~~~~~~~~~~~~\\n\\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\\nSleeps are done asynchronously too.\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_asyncio_function(loop):\\n await loop.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_async_trio_function():\\n await trio.socket.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n @tornado.gen.coroutine\\n def my_async_tornado_function(http_client, url):\\n yield http_client.fetch(url)\\n\\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\\n\\n.. code-block:: python\\n\\n @retry(sleep=curio.sleep)\\n async def my_async_curio_function():\\n await asks.get('https://example.org')\\n\\nContribute\\n----------\\n\\n#. Check for open issues or open a fresh issue to start a discussion around a\\n feature idea or a bug.\\n#. Fork `the repository`_ on GitHub to start making your changes to the\\n **main** branch (or branch off of it).\\n#. Write a test which shows that the bug was fixed or that the feature works as\\n expected.\\n#. Add a `changelog <#Changelogs>`_\\n#. Make the docs better (or more detailed, or more easier to read, or ...)\\n\\n.. _`the repository`: https://github.com/jd/tenacity\\n\\nChangelogs\\n~~~~~~~~~~\\n\\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\\n\\nThe doc generation will automatically compile the changelogs. You just need to add them.\\n\\n.. code-block:: sh\\n\\n # Opens a template file in an editor\\n tox -e reno -- new some-slug-for-my-change --edit\\n\\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef before_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"Before call strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef before_log(\\n logger: \\\"logging.Logger\\\", log_level: int\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"Before call strategy that logs to some logger the attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n logger.log(\\n log_level,\\n f\\\"Starting call to '{fn_name}', \\\"\\n f\\\"this is the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\\\",\\n )\\n\\n return log_it\\n\\n[end of tenacity/before.py]\",\n \"filename\": \"tenacity/before.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef before_sleep_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"Before sleep strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef before_sleep_log(\\n logger: \\\"logging.Logger\\\",\\n log_level: int,\\n exc_info: bool = False,\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"Before sleep strategy that logs to some logger the attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n local_exc_info: BaseException | bool | None\\n\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"log_it() called before outcome was set\\\")\\n\\n if retry_state.next_action is None:\\n raise RuntimeError(\\\"log_it() called before next_action was set\\\")\\n\\n if retry_state.outcome.failed:\\n ex = retry_state.outcome.exception()\\n verb, value = \\\"raised\\\", f\\\"{ex.__class__.__name__}: {ex}\\\"\\n\\n if exc_info:\\n local_exc_info = retry_state.outcome.exception()\\n else:\\n local_exc_info = False\\n else:\\n verb, value = \\\"returned\\\", retry_state.outcome.result()\\n local_exc_info = False # exc_info does not apply when no exception\\n\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n\\n logger.log(\\n log_level,\\n f\\\"Retrying {fn_name} \\\"\\n f\\\"in {retry_state.next_action.sleep} seconds as it {verb} {value}.\\\",\\n exc_info=local_exc_info,\\n )\\n\\n return log_it\\n\\n[end of tenacity/before_sleep.py]\",\n \"filename\": \"tenacity/before_sleep.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport abc\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import threading\\n\\n from tenacity import RetryCallState\\n\\n\\nclass stop_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for stop strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n pass\\n\\n def __and__(self, other: \\\"stop_base\\\") -> \\\"stop_all\\\":\\n return stop_all(self, other)\\n\\n def __or__(self, other: \\\"stop_base\\\") -> \\\"stop_any\\\":\\n return stop_any(self, other)\\n\\n\\nStopBaseT = typing.Union[stop_base, typing.Callable[[\\\"RetryCallState\\\"], bool]]\\n\\n\\nclass stop_any(stop_base):\\n \\\"\\\"\\\"Stop if any of the stop condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *stops: stop_base) -> None:\\n self.stops = stops\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return any(x(retry_state) for x in self.stops)\\n\\n\\nclass stop_all(stop_base):\\n \\\"\\\"\\\"Stop if all the stop conditions are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *stops: stop_base) -> None:\\n self.stops = stops\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return all(x(retry_state) for x in self.stops)\\n\\n\\nclass _stop_never(stop_base):\\n \\\"\\\"\\\"Never stop.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return False\\n\\n\\nstop_never = _stop_never()\\n\\n\\nclass stop_when_event_set(stop_base):\\n \\\"\\\"\\\"Stop when the given event is set.\\\"\\\"\\\"\\n\\n def __init__(self, event: \\\"threading.Event\\\") -> None:\\n self.event = event\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return self.event.is_set()\\n\\n\\nclass stop_after_attempt(stop_base):\\n \\\"\\\"\\\"Stop when the previous attempt >= max_attempt.\\\"\\\"\\\"\\n\\n def __init__(self, max_attempt_number: int) -> None:\\n self.max_attempt_number = max_attempt_number\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return retry_state.attempt_number >= self.max_attempt_number\\n\\n\\nclass stop_after_delay(stop_base):\\n \\\"\\\"\\\"\\n Stop when the time from the first attempt >= limit.\\n\\n Note: `max_delay` will be exceeded, so when used with a `wait`, the actual total delay will be greater\\n than `max_delay` by some of the final sleep period before `max_delay` is exceeded.\\n\\n If you need stricter timing with waits, consider `stop_before_delay` instead.\\n \\\"\\\"\\\"\\n\\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\\n self.max_delay = _utils.to_seconds(max_delay)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.seconds_since_start is None:\\n raise RuntimeError(\\\"__call__() called but seconds_since_start is not set\\\")\\n return retry_state.seconds_since_start >= self.max_delay\\n\\n\\nclass stop_before_delay(stop_base):\\n \\\"\\\"\\\"\\n Stop right before the next attempt would take place after the time from the first attempt >= limit.\\n\\n Most useful when you are using with a `wait` function like wait_random_exponential, but need to make\\n sure that the max_delay is not exceeded.\\n \\\"\\\"\\\"\\n\\n def __init__(self, max_delay: _utils.time_unit_type) -> None:\\n self.max_delay = _utils.to_seconds(max_delay)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.seconds_since_start is None:\\n raise RuntimeError(\\\"__call__() called but seconds_since_start is not set\\\")\\n return (\\n retry_state.seconds_since_start + retry_state.upcoming_sleep\\n >= self.max_delay\\n )\\n\\n[end of tenacity/stop.py]\",\n \"filename\": \"tenacity/stop.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport abc\\nimport random\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass wait_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for wait strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n pass\\n\\n def __add__(self, other: \\\"wait_base\\\") -> \\\"wait_combine\\\":\\n return wait_combine(self, other)\\n\\n def __radd__(self, other: \\\"wait_base\\\") -> typing.Union[\\\"wait_combine\\\", \\\"wait_base\\\"]:\\n # make it possible to use multiple waits with the built-in sum function\\n if other == 0: # type: ignore[comparison-overlap]\\n return self\\n return self.__add__(other)\\n\\n\\nWaitBaseT = typing.Union[\\n wait_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Union[float, int]]\\n]\\n\\n\\nclass wait_fixed(wait_base):\\n \\\"\\\"\\\"Wait strategy that waits a fixed amount of time between each retry.\\\"\\\"\\\"\\n\\n def __init__(self, wait: _utils.time_unit_type) -> None:\\n self.wait_fixed = _utils.to_seconds(wait)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return self.wait_fixed\\n\\n\\nclass wait_none(wait_fixed):\\n \\\"\\\"\\\"Wait strategy that doesn't wait at all before retrying.\\\"\\\"\\\"\\n\\n def __init__(self) -> None:\\n super().__init__(0)\\n\\n\\nclass wait_random(wait_base):\\n \\\"\\\"\\\"Wait strategy that waits a random amount of time between min/max.\\\"\\\"\\\"\\n\\n def __init__(\\n self, min: _utils.time_unit_type = 0, max: _utils.time_unit_type = 1\\n ) -> None: # noqa\\n self.wait_random_min = _utils.to_seconds(min)\\n self.wait_random_max = _utils.to_seconds(max)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return self.wait_random_min + (\\n random.random() * (self.wait_random_max - self.wait_random_min)\\n )\\n\\n\\nclass wait_combine(wait_base):\\n \\\"\\\"\\\"Combine several waiting strategies.\\\"\\\"\\\"\\n\\n def __init__(self, *strategies: wait_base) -> None:\\n self.wait_funcs = strategies\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n return sum(x(retry_state=retry_state) for x in self.wait_funcs)\\n\\n\\nclass wait_chain(wait_base):\\n \\\"\\\"\\\"Chain two or more waiting strategies.\\n\\n If all strategies are exhausted, the very last strategy is used\\n thereafter.\\n\\n For example::\\n\\n @retry(wait=wait_chain(*[wait_fixed(1) for i in range(3)] +\\n [wait_fixed(2) for j in range(5)] +\\n [wait_fixed(5) for k in range(4)))\\n def wait_chained():\\n print(\\\"Wait 1s for 3 attempts, 2s for 5 attempts and 5s\\n thereafter.\\\")\\n \\\"\\\"\\\"\\n\\n def __init__(self, *strategies: wait_base) -> None:\\n self.strategies = strategies\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n wait_func_no = min(max(retry_state.attempt_number, 1), len(self.strategies))\\n wait_func = self.strategies[wait_func_no - 1]\\n return wait_func(retry_state=retry_state)\\n\\n\\nclass wait_incrementing(wait_base):\\n \\\"\\\"\\\"Wait an incremental amount of time after each attempt.\\n\\n Starting at a starting value and incrementing by a value for each attempt\\n (and restricting the upper limit to some maximum value).\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n start: _utils.time_unit_type = 0,\\n increment: _utils.time_unit_type = 100,\\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\\n ) -> None:\\n self.start = _utils.to_seconds(start)\\n self.increment = _utils.to_seconds(increment)\\n self.max = _utils.to_seconds(max)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n result = self.start + (self.increment * (retry_state.attempt_number - 1))\\n return max(0, min(result, self.max))\\n\\n\\nclass wait_exponential(wait_base):\\n \\\"\\\"\\\"Wait strategy that applies exponential backoff.\\n\\n It allows for a customized multiplier and an ability to restrict the\\n upper and lower limits to some maximum and minimum value.\\n\\n The intervals are fixed (i.e. there is no jitter), so this strategy is\\n suitable for balancing retries against latency when a required resource is\\n unavailable for an unknown duration, but *not* suitable for resolving\\n contention between multiple processes for a shared resource. Use\\n wait_random_exponential for the latter case.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n multiplier: typing.Union[int, float] = 1,\\n max: _utils.time_unit_type = _utils.MAX_WAIT, # noqa\\n exp_base: typing.Union[int, float] = 2,\\n min: _utils.time_unit_type = 0, # noqa\\n ) -> None:\\n self.multiplier = multiplier\\n self.min = _utils.to_seconds(min)\\n self.max = _utils.to_seconds(max)\\n self.exp_base = exp_base\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n try:\\n exp = self.exp_base ** (retry_state.attempt_number - 1)\\n result = self.multiplier * exp\\n except OverflowError:\\n return self.max\\n return max(max(0, self.min), min(result, self.max))\\n\\n\\nclass wait_random_exponential(wait_exponential):\\n \\\"\\\"\\\"Random wait with exponentially widening window.\\n\\n An exponential backoff strategy used to mediate contention between multiple\\n uncoordinated processes for a shared resource in distributed systems. This\\n is the sense in which \\\"exponential backoff\\\" is meant in e.g. Ethernet\\n networking, and corresponds to the \\\"Full Jitter\\\" algorithm described in\\n this blog post:\\n\\n https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/\\n\\n Each retry occurs at a random time in a geometrically expanding interval.\\n It allows for a custom multiplier and an ability to restrict the upper\\n limit of the random interval to some maximum value.\\n\\n Example::\\n\\n wait_random_exponential(multiplier=0.5, # initial window 0.5s\\n max=60) # max 60s timeout\\n\\n When waiting for an unavailable resource to become available again, as\\n opposed to trying to resolve contention for a shared resource, the\\n wait_exponential strategy (which uses a fixed interval) may be preferable.\\n\\n \\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n high = super().__call__(retry_state=retry_state)\\n return random.uniform(self.min, high)\\n\\n\\nclass wait_exponential_jitter(wait_base):\\n \\\"\\\"\\\"Wait strategy that applies exponential backoff and jitter.\\n\\n It allows for a customized initial wait, maximum wait and jitter.\\n\\n This implements the strategy described here:\\n https://cloud.google.com/storage/docs/retry-strategy\\n\\n The wait time is min(initial * 2**n + random.uniform(0, jitter), maximum)\\n where n is the retry count.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n initial: float = 1,\\n max: float = _utils.MAX_WAIT, # noqa\\n exp_base: float = 2,\\n jitter: float = 1,\\n ) -> None:\\n self.initial = initial\\n self.max = max\\n self.exp_base = exp_base\\n self.jitter = jitter\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> float:\\n jitter = random.uniform(0, self.jitter)\\n try:\\n exp = self.exp_base ** (retry_state.attempt_number - 1)\\n result = self.initial * exp + jitter\\n except OverflowError:\\n result = self.max\\n return max(0, min(result, self.max))\\n\\n[end of tenacity/wait.py]\",\n \"filename\": \"tenacity/wait.py\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# Copyright 2016-2018 Julien Danjou\\n# Copyright 2017 Elisey Zanko\\n# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport dataclasses\\nimport functools\\nimport sys\\nimport threading\\nimport time\\nimport typing as t\\nimport warnings\\nfrom abc import ABC, abstractmethod\\nfrom concurrent import futures\\n\\nfrom . import _utils\\n\\n# Import all built-in retry strategies for easier usage.\\nfrom .retry import retry_base # noqa\\nfrom .retry import retry_all # noqa\\nfrom .retry import retry_always # noqa\\nfrom .retry import retry_any # noqa\\nfrom .retry import retry_if_exception # noqa\\nfrom .retry import retry_if_exception_type # noqa\\nfrom .retry import retry_if_exception_cause_type # noqa\\nfrom .retry import retry_if_not_exception_type # noqa\\nfrom .retry import retry_if_not_result # noqa\\nfrom .retry import retry_if_result # noqa\\nfrom .retry import retry_never # noqa\\nfrom .retry import retry_unless_exception_type # noqa\\nfrom .retry import retry_if_exception_message # noqa\\nfrom .retry import retry_if_not_exception_message # noqa\\n\\n# Import all nap strategies for easier usage.\\nfrom .nap import sleep # noqa\\nfrom .nap import sleep_using_event # noqa\\n\\n# Import all built-in stop strategies for easier usage.\\nfrom .stop import stop_after_attempt # noqa\\nfrom .stop import stop_after_delay # noqa\\nfrom .stop import stop_before_delay # noqa\\nfrom .stop import stop_all # noqa\\nfrom .stop import stop_any # noqa\\nfrom .stop import stop_never # noqa\\nfrom .stop import stop_when_event_set # noqa\\n\\n# Import all built-in wait strategies for easier usage.\\nfrom .wait import wait_chain # noqa\\nfrom .wait import wait_combine # noqa\\nfrom .wait import wait_exponential # noqa\\nfrom .wait import wait_fixed # noqa\\nfrom .wait import wait_incrementing # noqa\\nfrom .wait import wait_none # noqa\\nfrom .wait import wait_random # noqa\\nfrom .wait import wait_random_exponential # noqa\\nfrom .wait import wait_random_exponential as wait_full_jitter # noqa\\nfrom .wait import wait_exponential_jitter # noqa\\n\\n# Import all built-in before strategies for easier usage.\\nfrom .before import before_log # noqa\\nfrom .before import before_nothing # noqa\\n\\n# Import all built-in after strategies for easier usage.\\nfrom .after import after_log # noqa\\nfrom .after import after_nothing # noqa\\n\\n# Import all built-in before sleep strategies for easier usage.\\nfrom .before_sleep import before_sleep_log # noqa\\nfrom .before_sleep import before_sleep_nothing # noqa\\n\\ntry:\\n import tornado\\nexcept ImportError:\\n tornado = None\\n\\nif t.TYPE_CHECKING:\\n import types\\n\\n from typing_extensions import Self\\n\\n from . import asyncio as tasyncio\\n from .retry import RetryBaseT\\n from .stop import StopBaseT\\n from .wait import WaitBaseT\\n\\n\\nWrappedFnReturnT = t.TypeVar(\\\"WrappedFnReturnT\\\")\\nWrappedFn = t.TypeVar(\\\"WrappedFn\\\", bound=t.Callable[..., t.Any])\\n\\n\\ndataclass_kwargs = {}\\nif sys.version_info >= (3, 10):\\n dataclass_kwargs.update({\\\"slots\\\": True})\\n\\n\\n@dataclasses.dataclass(**dataclass_kwargs)\\nclass IterState:\\n actions: t.List[t.Callable[[\\\"RetryCallState\\\"], t.Any]] = dataclasses.field(\\n default_factory=list\\n )\\n retry_run_result: bool = False\\n delay_since_first_attempt: int = 0\\n stop_run_result: bool = False\\n is_explicit_retry: bool = False\\n\\n def reset(self) -> None:\\n self.actions = []\\n self.retry_run_result = False\\n self.delay_since_first_attempt = 0\\n self.stop_run_result = False\\n self.is_explicit_retry = False\\n\\n\\nclass TryAgain(Exception):\\n \\\"\\\"\\\"Always retry the executed function when raised.\\\"\\\"\\\"\\n\\n\\nNO_RESULT = object()\\n\\n\\nclass DoAttempt:\\n pass\\n\\n\\nclass DoSleep(float):\\n pass\\n\\n\\nclass BaseAction:\\n \\\"\\\"\\\"Base class for representing actions to take by retry object.\\n\\n Concrete implementations must define:\\n - __init__: to initialize all necessary fields\\n - REPR_FIELDS: class variable specifying attributes to include in repr(self)\\n - NAME: for identification in retry object methods and callbacks\\n \\\"\\\"\\\"\\n\\n REPR_FIELDS: t.Sequence[str] = ()\\n NAME: t.Optional[str] = None\\n\\n def __repr__(self) -> str:\\n state_str = \\\", \\\".join(\\n f\\\"{field}={getattr(self, field)!r}\\\" for field in self.REPR_FIELDS\\n )\\n return f\\\"{self.__class__.__name__}({state_str})\\\"\\n\\n def __str__(self) -> str:\\n return repr(self)\\n\\n\\nclass RetryAction(BaseAction):\\n REPR_FIELDS = (\\\"sleep\\\",)\\n NAME = \\\"retry\\\"\\n\\n def __init__(self, sleep: t.SupportsFloat) -> None:\\n self.sleep = float(sleep)\\n\\n\\n_unset = object()\\n\\n\\ndef _first_set(first: t.Union[t.Any, object], second: t.Any) -> t.Any:\\n return second if first is _unset else first\\n\\n\\nclass RetryError(Exception):\\n \\\"\\\"\\\"Encapsulates the last attempt instance right before giving up.\\\"\\\"\\\"\\n\\n def __init__(self, last_attempt: \\\"Future\\\") -> None:\\n self.last_attempt = last_attempt\\n super().__init__(last_attempt)\\n\\n def reraise(self) -> t.NoReturn:\\n if self.last_attempt.failed:\\n raise self.last_attempt.result()\\n raise self\\n\\n def __str__(self) -> str:\\n return f\\\"{self.__class__.__name__}[{self.last_attempt}]\\\"\\n\\n\\nclass AttemptManager:\\n \\\"\\\"\\\"Manage attempt context.\\\"\\\"\\\"\\n\\n def __init__(self, retry_state: \\\"RetryCallState\\\"):\\n self.retry_state = retry_state\\n\\n def __enter__(self) -> None:\\n pass\\n\\n def __exit__(\\n self,\\n exc_type: t.Optional[t.Type[BaseException]],\\n exc_value: t.Optional[BaseException],\\n traceback: t.Optional[\\\"types.TracebackType\\\"],\\n ) -> t.Optional[bool]:\\n if exc_type is not None and exc_value is not None:\\n self.retry_state.set_exception((exc_type, exc_value, traceback))\\n return True # Swallow exception.\\n else:\\n # We don't have the result, actually.\\n self.retry_state.set_result(None)\\n return None\\n\\n\\nclass BaseRetrying(ABC):\\n def __init__(\\n self,\\n sleep: t.Callable[[t.Union[int, float]], None] = sleep,\\n stop: \\\"StopBaseT\\\" = stop_never,\\n wait: \\\"WaitBaseT\\\" = wait_none(),\\n retry: \\\"RetryBaseT\\\" = retry_if_exception_type(),\\n before: t.Callable[[\\\"RetryCallState\\\"], None] = before_nothing,\\n after: t.Callable[[\\\"RetryCallState\\\"], None] = after_nothing,\\n before_sleep: t.Optional[t.Callable[[\\\"RetryCallState\\\"], None]] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[RetryError] = RetryError,\\n retry_error_callback: t.Optional[t.Callable[[\\\"RetryCallState\\\"], t.Any]] = None,\\n ):\\n self.sleep = sleep\\n self.stop = stop\\n self.wait = wait\\n self.retry = retry\\n self.before = before\\n self.after = after\\n self.before_sleep = before_sleep\\n self.reraise = reraise\\n self._local = threading.local()\\n self.retry_error_cls = retry_error_cls\\n self.retry_error_callback = retry_error_callback\\n\\n def copy(\\n self,\\n sleep: t.Union[t.Callable[[t.Union[int, float]], None], object] = _unset,\\n stop: t.Union[\\\"StopBaseT\\\", object] = _unset,\\n wait: t.Union[\\\"WaitBaseT\\\", object] = _unset,\\n retry: t.Union[retry_base, object] = _unset,\\n before: t.Union[t.Callable[[\\\"RetryCallState\\\"], None], object] = _unset,\\n after: t.Union[t.Callable[[\\\"RetryCallState\\\"], None], object] = _unset,\\n before_sleep: t.Union[\\n t.Optional[t.Callable[[\\\"RetryCallState\\\"], None]], object\\n ] = _unset,\\n reraise: t.Union[bool, object] = _unset,\\n retry_error_cls: t.Union[t.Type[RetryError], object] = _unset,\\n retry_error_callback: t.Union[\\n t.Optional[t.Callable[[\\\"RetryCallState\\\"], t.Any]], object\\n ] = _unset,\\n ) -> \\\"Self\\\":\\n \\\"\\\"\\\"Copy this object with some parameters changed if needed.\\\"\\\"\\\"\\n return self.__class__(\\n sleep=_first_set(sleep, self.sleep),\\n stop=_first_set(stop, self.stop),\\n wait=_first_set(wait, self.wait),\\n retry=_first_set(retry, self.retry),\\n before=_first_set(before, self.before),\\n after=_first_set(after, self.after),\\n before_sleep=_first_set(before_sleep, self.before_sleep),\\n reraise=_first_set(reraise, self.reraise),\\n retry_error_cls=_first_set(retry_error_cls, self.retry_error_cls),\\n retry_error_callback=_first_set(\\n retry_error_callback, self.retry_error_callback\\n ),\\n )\\n\\n def __repr__(self) -> str:\\n return (\\n f\\\"<{self.__class__.__name__} object at 0x{id(self):x} (\\\"\\n f\\\"stop={self.stop}, \\\"\\n f\\\"wait={self.wait}, \\\"\\n f\\\"sleep={self.sleep}, \\\"\\n f\\\"retry={self.retry}, \\\"\\n f\\\"before={self.before}, \\\"\\n f\\\"after={self.after})>\\\"\\n )\\n\\n @property\\n def statistics(self) -> t.Dict[str, t.Any]:\\n \\\"\\\"\\\"Return a dictionary of runtime statistics.\\n\\n This dictionary will be empty when the controller has never been\\n ran. When it is running or has ran previously it should have (but\\n may not) have useful and/or informational keys and values when\\n running is underway and/or completed.\\n\\n .. warning:: The keys in this dictionary **should** be some what\\n stable (not changing), but there existence **may**\\n change between major releases as new statistics are\\n gathered or removed so before accessing keys ensure that\\n they actually exist and handle when they do not.\\n\\n .. note:: The values in this dictionary are local to the thread\\n running call (so if multiple threads share the same retrying\\n object - either directly or indirectly) they will each have\\n there own view of statistics they have collected (in the\\n future we may provide a way to aggregate the various\\n statistics from each thread).\\n \\\"\\\"\\\"\\n try:\\n return self._local.statistics # type: ignore[no-any-return]\\n except AttributeError:\\n self._local.statistics = t.cast(t.Dict[str, t.Any], {})\\n return self._local.statistics\\n\\n @property\\n def iter_state(self) -> IterState:\\n try:\\n return self._local.iter_state # type: ignore[no-any-return]\\n except AttributeError:\\n self._local.iter_state = IterState()\\n return self._local.iter_state\\n\\n def wraps(self, f: WrappedFn) -> WrappedFn:\\n \\\"\\\"\\\"Wrap a function for retrying.\\n\\n :param f: A function to wraps for retrying.\\n \\\"\\\"\\\"\\n\\n @functools.wraps(\\n f, functools.WRAPPER_ASSIGNMENTS + (\\\"__defaults__\\\", \\\"__kwdefaults__\\\")\\n )\\n def wrapped_f(*args: t.Any, **kw: t.Any) -> t.Any:\\n # Always create a copy to prevent overwriting the local contexts when\\n # calling the same wrapped functions multiple times in the same stack\\n copy = self.copy()\\n wrapped_f.statistics = copy.statistics # type: ignore[attr-defined]\\n return copy(f, *args, **kw)\\n\\n def retry_with(*args: t.Any, **kwargs: t.Any) -> WrappedFn:\\n return self.copy(*args, **kwargs).wraps(f)\\n\\n # Preserve attributes\\n wrapped_f.retry = self # type: ignore[attr-defined]\\n wrapped_f.retry_with = retry_with # type: ignore[attr-defined]\\n wrapped_f.statistics = {} # type: ignore[attr-defined]\\n\\n return wrapped_f # type: ignore[return-value]\\n\\n def begin(self) -> None:\\n self.statistics.clear()\\n self.statistics[\\\"start_time\\\"] = time.monotonic()\\n self.statistics[\\\"attempt_number\\\"] = 1\\n self.statistics[\\\"idle_for\\\"] = 0\\n\\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\\n self.iter_state.actions.append(fn)\\n\\n def _run_retry(self, retry_state: \\\"RetryCallState\\\") -> None:\\n self.iter_state.retry_run_result = self.retry(retry_state)\\n\\n def _run_wait(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if self.wait:\\n sleep = self.wait(retry_state)\\n else:\\n sleep = 0.0\\n\\n retry_state.upcoming_sleep = sleep\\n\\n def _run_stop(self, retry_state: \\\"RetryCallState\\\") -> None:\\n self.statistics[\\\"delay_since_first_attempt\\\"] = retry_state.seconds_since_start\\n self.iter_state.stop_run_result = self.stop(retry_state)\\n\\n def iter(self, retry_state: \\\"RetryCallState\\\") -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa\\n self._begin_iter(retry_state)\\n result = None\\n for action in self.iter_state.actions:\\n result = action(retry_state)\\n return result\\n\\n def _begin_iter(self, retry_state: \\\"RetryCallState\\\") -> None: # noqa\\n self.iter_state.reset()\\n\\n fut = retry_state.outcome\\n if fut is None:\\n if self.before is not None:\\n self._add_action_func(self.before)\\n self._add_action_func(lambda rs: DoAttempt())\\n return\\n\\n self.iter_state.is_explicit_retry = fut.failed and isinstance(\\n fut.exception(), TryAgain\\n )\\n if not self.iter_state.is_explicit_retry:\\n self._add_action_func(self._run_retry)\\n self._add_action_func(self._post_retry_check_actions)\\n\\n def _post_retry_check_actions(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if not (self.iter_state.is_explicit_retry or self.iter_state.retry_run_result):\\n self._add_action_func(lambda rs: rs.outcome.result())\\n return\\n\\n if self.after is not None:\\n self._add_action_func(self.after)\\n\\n self._add_action_func(self._run_wait)\\n self._add_action_func(self._run_stop)\\n self._add_action_func(self._post_stop_check_actions)\\n\\n def _post_stop_check_actions(self, retry_state: \\\"RetryCallState\\\") -> None:\\n if self.iter_state.stop_run_result:\\n if self.retry_error_callback:\\n self._add_action_func(self.retry_error_callback)\\n return\\n\\n def exc_check(rs: \\\"RetryCallState\\\") -> None:\\n fut = t.cast(Future, rs.outcome)\\n retry_exc = self.retry_error_cls(fut)\\n if self.reraise:\\n raise retry_exc.reraise()\\n raise retry_exc from fut.exception()\\n\\n self._add_action_func(exc_check)\\n return\\n\\n def next_action(rs: \\\"RetryCallState\\\") -> None:\\n sleep = rs.upcoming_sleep\\n rs.next_action = RetryAction(sleep)\\n rs.idle_for += sleep\\n self.statistics[\\\"idle_for\\\"] += sleep\\n self.statistics[\\\"attempt_number\\\"] += 1\\n\\n self._add_action_func(next_action)\\n\\n if self.before_sleep is not None:\\n self._add_action_func(self.before_sleep)\\n\\n self._add_action_func(lambda rs: DoSleep(rs.upcoming_sleep))\\n\\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\\n self.begin()\\n\\n retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n yield AttemptManager(retry_state=retry_state)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n self.sleep(do)\\n else:\\n break\\n\\n @abstractmethod\\n def __call__(\\n self,\\n fn: t.Callable[..., WrappedFnReturnT],\\n *args: t.Any,\\n **kwargs: t.Any,\\n ) -> WrappedFnReturnT:\\n pass\\n\\n\\nclass Retrying(BaseRetrying):\\n \\\"\\\"\\\"Retrying controller.\\\"\\\"\\\"\\n\\n def __call__(\\n self,\\n fn: t.Callable[..., WrappedFnReturnT],\\n *args: t.Any,\\n **kwargs: t.Any,\\n ) -> WrappedFnReturnT:\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n self.sleep(do)\\n else:\\n return do # type: ignore[no-any-return]\\n\\n\\nif sys.version_info >= (3, 9):\\n FutureGenericT = futures.Future[t.Any]\\nelse:\\n FutureGenericT = futures.Future\\n\\n\\nclass Future(FutureGenericT):\\n \\\"\\\"\\\"Encapsulates a (future or past) attempted call to a target function.\\\"\\\"\\\"\\n\\n def __init__(self, attempt_number: int) -> None:\\n super().__init__()\\n self.attempt_number = attempt_number\\n\\n @property\\n def failed(self) -> bool:\\n \\\"\\\"\\\"Return whether a exception is being held in this future.\\\"\\\"\\\"\\n return self.exception() is not None\\n\\n @classmethod\\n def construct(\\n cls, attempt_number: int, value: t.Any, has_exception: bool\\n ) -> \\\"Future\\\":\\n \\\"\\\"\\\"Construct a new Future object.\\\"\\\"\\\"\\n fut = cls(attempt_number)\\n if has_exception:\\n fut.set_exception(value)\\n else:\\n fut.set_result(value)\\n return fut\\n\\n\\nclass RetryCallState:\\n \\\"\\\"\\\"State related to a single call wrapped with Retrying.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n retry_object: BaseRetrying,\\n fn: t.Optional[WrappedFn],\\n args: t.Any,\\n kwargs: t.Any,\\n ) -> None:\\n #: Retry call start timestamp\\n self.start_time = time.monotonic()\\n #: Retry manager object\\n self.retry_object = retry_object\\n #: Function wrapped by this retry call\\n self.fn = fn\\n #: Arguments of the function wrapped by this retry call\\n self.args = args\\n #: Keyword arguments of the function wrapped by this retry call\\n self.kwargs = kwargs\\n\\n #: The number of the current attempt\\n self.attempt_number: int = 1\\n #: Last outcome (result or exception) produced by the function\\n self.outcome: t.Optional[Future] = None\\n #: Timestamp of the last outcome\\n self.outcome_timestamp: t.Optional[float] = None\\n #: Time spent sleeping in retries\\n self.idle_for: float = 0.0\\n #: Next action as decided by the retry manager\\n self.next_action: t.Optional[RetryAction] = None\\n #: Next sleep time as decided by the retry manager.\\n self.upcoming_sleep: float = 0.0\\n\\n @property\\n def seconds_since_start(self) -> t.Optional[float]:\\n if self.outcome_timestamp is None:\\n return None\\n return self.outcome_timestamp - self.start_time\\n\\n def prepare_for_next_attempt(self) -> None:\\n self.outcome = None\\n self.outcome_timestamp = None\\n self.attempt_number += 1\\n self.next_action = None\\n\\n def set_result(self, val: t.Any) -> None:\\n ts = time.monotonic()\\n fut = Future(self.attempt_number)\\n fut.set_result(val)\\n self.outcome, self.outcome_timestamp = fut, ts\\n\\n def set_exception(\\n self,\\n exc_info: t.Tuple[\\n t.Type[BaseException], BaseException, \\\"types.TracebackType| None\\\"\\n ],\\n ) -> None:\\n ts = time.monotonic()\\n fut = Future(self.attempt_number)\\n fut.set_exception(exc_info[1])\\n self.outcome, self.outcome_timestamp = fut, ts\\n\\n def __repr__(self) -> str:\\n if self.outcome is None:\\n result = \\\"none yet\\\"\\n elif self.outcome.failed:\\n exception = self.outcome.exception()\\n result = f\\\"failed ({exception.__class__.__name__} {exception})\\\"\\n else:\\n result = f\\\"returned {self.outcome.result()}\\\"\\n\\n slept = float(round(self.idle_for, 2))\\n clsname = self.__class__.__name__\\n return f\\\"<{clsname} {id(self)}: attempt #{self.attempt_number}; slept for {slept}; last result: {result}>\\\"\\n\\n\\n@t.overload\\ndef retry(func: WrappedFn) -> WrappedFn: ...\\n\\n\\n@t.overload\\ndef retry(\\n sleep: t.Callable[[t.Union[int, float]], t.Union[None, t.Awaitable[None]]] = sleep,\\n stop: \\\"StopBaseT\\\" = stop_never,\\n wait: \\\"WaitBaseT\\\" = wait_none(),\\n retry: \\\"t.Union[RetryBaseT, tasyncio.retry.RetryBaseT]\\\" = retry_if_exception_type(),\\n before: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = before_nothing,\\n after: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = after_nothing,\\n before_sleep: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]]\\n ] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[\\\"RetryError\\\"] = RetryError,\\n retry_error_callback: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[t.Any, t.Awaitable[t.Any]]]\\n ] = None,\\n) -> t.Callable[[WrappedFn], WrappedFn]: ...\\n\\n\\ndef retry(*dargs: t.Any, **dkw: t.Any) -> t.Any:\\n \\\"\\\"\\\"Wrap a function with a new `Retrying` object.\\n\\n :param dargs: positional arguments passed to Retrying object\\n :param dkw: keyword arguments passed to the Retrying object\\n \\\"\\\"\\\"\\n # support both @retry and @retry() as valid syntax\\n if len(dargs) == 1 and callable(dargs[0]):\\n return retry()(dargs[0])\\n else:\\n\\n def wrap(f: WrappedFn) -> WrappedFn:\\n if isinstance(f, retry_base):\\n warnings.warn(\\n f\\\"Got retry_base instance ({f.__class__.__name__}) as callable argument, \\\"\\n f\\\"this will probably hang indefinitely (did you mean retry={f.__class__.__name__}(...)?)\\\"\\n )\\n r: \\\"BaseRetrying\\\"\\n if _utils.is_coroutine_callable(f):\\n r = AsyncRetrying(*dargs, **dkw)\\n elif (\\n tornado\\n and hasattr(tornado.gen, \\\"is_coroutine_function\\\")\\n and tornado.gen.is_coroutine_function(f)\\n ):\\n r = TornadoRetrying(*dargs, **dkw)\\n else:\\n r = Retrying(*dargs, **dkw)\\n\\n return r.wraps(f)\\n\\n return wrap\\n\\n\\nfrom tenacity.asyncio import AsyncRetrying # noqa:E402,I100\\n\\nif tornado:\\n from tenacity.tornadoweb import TornadoRetrying\\n\\n\\n__all__ = [\\n \\\"retry_base\\\",\\n \\\"retry_all\\\",\\n \\\"retry_always\\\",\\n \\\"retry_any\\\",\\n \\\"retry_if_exception\\\",\\n \\\"retry_if_exception_type\\\",\\n \\\"retry_if_exception_cause_type\\\",\\n \\\"retry_if_not_exception_type\\\",\\n \\\"retry_if_not_result\\\",\\n \\\"retry_if_result\\\",\\n \\\"retry_never\\\",\\n \\\"retry_unless_exception_type\\\",\\n \\\"retry_if_exception_message\\\",\\n \\\"retry_if_not_exception_message\\\",\\n \\\"sleep\\\",\\n \\\"sleep_using_event\\\",\\n \\\"stop_after_attempt\\\",\\n \\\"stop_after_delay\\\",\\n \\\"stop_before_delay\\\",\\n \\\"stop_all\\\",\\n \\\"stop_any\\\",\\n \\\"stop_never\\\",\\n \\\"stop_when_event_set\\\",\\n \\\"wait_chain\\\",\\n \\\"wait_combine\\\",\\n \\\"wait_exponential\\\",\\n \\\"wait_fixed\\\",\\n \\\"wait_incrementing\\\",\\n \\\"wait_none\\\",\\n \\\"wait_random\\\",\\n \\\"wait_random_exponential\\\",\\n \\\"wait_full_jitter\\\",\\n \\\"wait_exponential_jitter\\\",\\n \\\"before_log\\\",\\n \\\"before_nothing\\\",\\n \\\"after_log\\\",\\n \\\"after_nothing\\\",\\n \\\"before_sleep_log\\\",\\n \\\"before_sleep_nothing\\\",\\n \\\"retry\\\",\\n \\\"WrappedFn\\\",\\n \\\"TryAgain\\\",\\n \\\"NO_RESULT\\\",\\n \\\"DoAttempt\\\",\\n \\\"DoSleep\\\",\\n \\\"BaseAction\\\",\\n \\\"RetryAction\\\",\\n \\\"RetryError\\\",\\n \\\"AttemptManager\\\",\\n \\\"BaseRetrying\\\",\\n \\\"Retrying\\\",\\n \\\"Future\\\",\\n \\\"RetryCallState\\\",\\n \\\"AsyncRetrying\\\",\\n]\\n\\n[end of tenacity/__init__.py]\",\n \"filename\": \"tenacity/__init__.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport time\\nimport typing\\n\\nif typing.TYPE_CHECKING:\\n import threading\\n\\n\\ndef sleep(seconds: float) -> None:\\n \\\"\\\"\\\"\\n Sleep strategy that delays execution for a given number of seconds.\\n\\n This is the default strategy, and may be mocked out for unit testing.\\n \\\"\\\"\\\"\\n time.sleep(seconds)\\n\\n\\nclass sleep_using_event:\\n \\\"\\\"\\\"Sleep strategy that waits on an event to be set.\\\"\\\"\\\"\\n\\n def __init__(self, event: \\\"threading.Event\\\") -> None:\\n self.event = event\\n\\n def __call__(self, timeout: typing.Optional[float]) -> None:\\n # NOTE(harlowja): this may *not* actually wait for timeout\\n # seconds if the event is set (ie this may eject out early).\\n self.event.wait(timeout=timeout)\\n\\n[end of tenacity/nap.py]\",\n \"filename\": \"tenacity/nap.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport typing\\n\\nfrom tenacity import _utils\\n\\nif typing.TYPE_CHECKING:\\n import logging\\n\\n from tenacity import RetryCallState\\n\\n\\ndef after_nothing(retry_state: \\\"RetryCallState\\\") -> None:\\n \\\"\\\"\\\"After call strategy that does nothing.\\\"\\\"\\\"\\n\\n\\ndef after_log(\\n logger: \\\"logging.Logger\\\",\\n log_level: int,\\n sec_format: str = \\\"%0.3f\\\",\\n) -> typing.Callable[[\\\"RetryCallState\\\"], None]:\\n \\\"\\\"\\\"After call strategy that logs to some logger the finished attempt.\\\"\\\"\\\"\\n\\n def log_it(retry_state: \\\"RetryCallState\\\") -> None:\\n if retry_state.fn is None:\\n # NOTE(sileht): can't really happen, but we must please mypy\\n fn_name = \\\"<unknown>\\\"\\n else:\\n fn_name = _utils.get_callback_name(retry_state.fn)\\n logger.log(\\n log_level,\\n f\\\"Finished call to '{fn_name}' \\\"\\n f\\\"after {sec_format % retry_state.seconds_since_start}(s), \\\"\\n f\\\"this was the {_utils.to_ordinal(retry_state.attempt_number)} time calling it.\\\",\\n )\\n\\n return log_it\\n\\n[end of tenacity/after.py]\",\n \"filename\": \"tenacity/after.py\",\n \"id\": \"16\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport abc\\nimport re\\nimport typing\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass retry_base(abc.ABC):\\n \\\"\\\"\\\"Abstract base class for retry strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n pass\\n\\n def __and__(self, other: \\\"retry_base\\\") -> \\\"retry_all\\\":\\n return other.__rand__(self)\\n\\n def __rand__(self, other: \\\"retry_base\\\") -> \\\"retry_all\\\":\\n return retry_all(other, self)\\n\\n def __or__(self, other: \\\"retry_base\\\") -> \\\"retry_any\\\":\\n return other.__ror__(self)\\n\\n def __ror__(self, other: \\\"retry_base\\\") -> \\\"retry_any\\\":\\n return retry_any(other, self)\\n\\n\\nRetryBaseT = typing.Union[retry_base, typing.Callable[[\\\"RetryCallState\\\"], bool]]\\n\\n\\nclass _retry_never(retry_base):\\n \\\"\\\"\\\"Retry strategy that never rejects any result.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return False\\n\\n\\nretry_never = _retry_never()\\n\\n\\nclass _retry_always(retry_base):\\n \\\"\\\"\\\"Retry strategy that always rejects any result.\\\"\\\"\\\"\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return True\\n\\n\\nretry_always = _retry_always()\\n\\n\\nclass retry_if_exception(retry_base):\\n \\\"\\\"\\\"Retry strategy that retries if an exception verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[BaseException], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n else:\\n return False\\n\\n\\nclass retry_if_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries if an exception has been raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: isinstance(e, exception_types))\\n\\n\\nclass retry_if_not_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries except an exception has been raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: not isinstance(e, exception_types))\\n\\n\\nclass retry_unless_exception_type(retry_if_exception):\\n \\\"\\\"\\\"Retries until an exception is raised of one or more types.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_types = exception_types\\n super().__init__(lambda e: not isinstance(e, exception_types))\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n # always retry if no exception was raised\\n if not retry_state.outcome.failed:\\n return True\\n\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n\\n\\nclass retry_if_exception_cause_type(retry_base):\\n \\\"\\\"\\\"Retries if any of the causes of the raised exception is of one or more types.\\n\\n The check on the type of the cause of the exception is done recursively (until finding\\n an exception in the chain that has no `__cause__`)\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n exception_types: typing.Union[\\n typing.Type[BaseException],\\n typing.Tuple[typing.Type[BaseException], ...],\\n ] = Exception,\\n ) -> None:\\n self.exception_cause_types = exception_types\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__ called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exc = retry_state.outcome.exception()\\n while exc is not None:\\n if isinstance(exc.__cause__, self.exception_cause_types):\\n return True\\n exc = exc.__cause__\\n\\n return False\\n\\n\\nclass retry_if_result(retry_base):\\n \\\"\\\"\\\"Retries if the result verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_if_not_result(retry_base):\\n \\\"\\\"\\\"Retries if the result refutes a predicate.\\\"\\\"\\\"\\n\\n def __init__(self, predicate: typing.Callable[[typing.Any], bool]) -> None:\\n self.predicate = predicate\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return not self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_if_exception_message(retry_if_exception):\\n \\\"\\\"\\\"Retries if an exception message equals or matches.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: typing.Optional[str] = None,\\n match: typing.Optional[str] = None,\\n ) -> None:\\n if message and match:\\n raise TypeError(\\n f\\\"{self.__class__.__name__}() takes either 'message' or 'match', not both\\\"\\n )\\n\\n # set predicate\\n if message:\\n\\n def message_fnc(exception: BaseException) -> bool:\\n return message == str(exception)\\n\\n predicate = message_fnc\\n elif match:\\n prog = re.compile(match)\\n\\n def match_fnc(exception: BaseException) -> bool:\\n return bool(prog.match(str(exception)))\\n\\n predicate = match_fnc\\n else:\\n raise TypeError(\\n f\\\"{self.__class__.__name__}() missing 1 required argument 'message' or 'match'\\\"\\n )\\n\\n super().__init__(predicate)\\n\\n\\nclass retry_if_not_exception_message(retry_if_exception_message):\\n \\\"\\\"\\\"Retries until an exception message equals or matches.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: typing.Optional[str] = None,\\n match: typing.Optional[str] = None,\\n ) -> None:\\n super().__init__(message, match)\\n # invert predicate\\n if_predicate = self.predicate\\n self.predicate = lambda *args_, **kwargs_: not if_predicate(*args_, **kwargs_)\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return True\\n\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return self.predicate(exception)\\n\\n\\nclass retry_any(retry_base):\\n \\\"\\\"\\\"Retries if any of the retries condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: retry_base) -> None:\\n self.retries = retries\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return any(r(retry_state) for r in self.retries)\\n\\n\\nclass retry_all(retry_base):\\n \\\"\\\"\\\"Retries if all the retries condition are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: retry_base) -> None:\\n self.retries = retries\\n\\n def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool:\\n return all(r(retry_state) for r in self.retries)\\n\\n[end of tenacity/retry.py]\",\n \"filename\": \"tenacity/retry.py\",\n \"id\": \"17\"\n },\n {\n \"content\": \"[end of tenacity/py.typed]\",\n \"filename\": \"tenacity/py.typed\",\n \"id\": \"18\"\n },\n {\n \"content\": \"# Copyright 2017 Elisey Zanko\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport sys\\nimport typing\\n\\nfrom tenacity import BaseRetrying\\nfrom tenacity import DoAttempt\\nfrom tenacity import DoSleep\\nfrom tenacity import RetryCallState\\n\\nfrom tornado import gen\\n\\nif typing.TYPE_CHECKING:\\n from tornado.concurrent import Future\\n\\n_RetValT = typing.TypeVar(\\\"_RetValT\\\")\\n\\n\\nclass TornadoRetrying(BaseRetrying):\\n def __init__(\\n self,\\n sleep: \\\"typing.Callable[[float], Future[None]]\\\" = gen.sleep,\\n **kwargs: typing.Any,\\n ) -> None:\\n super().__init__(**kwargs)\\n self.sleep = sleep\\n\\n @gen.coroutine # type: ignore[misc]\\n def __call__(\\n self,\\n fn: \\\"typing.Callable[..., typing.Union[typing.Generator[typing.Any, typing.Any, _RetValT], Future[_RetValT]]]\\\",\\n *args: typing.Any,\\n **kwargs: typing.Any,\\n ) -> \\\"typing.Generator[typing.Any, typing.Any, _RetValT]\\\":\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = yield fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n yield self.sleep(do)\\n else:\\n raise gen.Return(do)\\n\\n[end of tenacity/tornadoweb.py]\",\n \"filename\": \"tenacity/tornadoweb.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport functools\\nimport inspect\\nimport sys\\nimport typing\\nfrom datetime import timedelta\\n\\n\\n# sys.maxsize:\\n# An integer giving the maximum value a variable of type Py_ssize_t can take.\\nMAX_WAIT = sys.maxsize / 2\\n\\n\\ndef find_ordinal(pos_num: int) -> str:\\n # See: https://en.wikipedia.org/wiki/English_numerals#Ordinal_numbers\\n if pos_num == 0:\\n return \\\"th\\\"\\n elif pos_num == 1:\\n return \\\"st\\\"\\n elif pos_num == 2:\\n return \\\"nd\\\"\\n elif pos_num == 3:\\n return \\\"rd\\\"\\n elif 4 <= pos_num <= 20:\\n return \\\"th\\\"\\n else:\\n return find_ordinal(pos_num % 10)\\n\\n\\ndef to_ordinal(pos_num: int) -> str:\\n return f\\\"{pos_num}{find_ordinal(pos_num)}\\\"\\n\\n\\ndef get_callback_name(cb: typing.Callable[..., typing.Any]) -> str:\\n \\\"\\\"\\\"Get a callback fully-qualified name.\\n\\n If no name can be produced ``repr(cb)`` is called and returned.\\n \\\"\\\"\\\"\\n segments = []\\n try:\\n segments.append(cb.__qualname__)\\n except AttributeError:\\n try:\\n segments.append(cb.__name__)\\n except AttributeError:\\n pass\\n if not segments:\\n return repr(cb)\\n else:\\n try:\\n # When running under sphinx it appears this can be none?\\n if cb.__module__:\\n segments.insert(0, cb.__module__)\\n except AttributeError:\\n pass\\n return \\\".\\\".join(segments)\\n\\n\\ntime_unit_type = typing.Union[int, float, timedelta]\\n\\n\\ndef to_seconds(time_unit: time_unit_type) -> float:\\n return float(\\n time_unit.total_seconds() if isinstance(time_unit, timedelta) else time_unit\\n )\\n\\n\\ndef is_coroutine_callable(call: typing.Callable[..., typing.Any]) -> bool:\\n if inspect.isclass(call):\\n return False\\n if inspect.iscoroutinefunction(call):\\n return True\\n partial_call = isinstance(call, functools.partial) and call.func\\n dunder_call = partial_call or getattr(call, \\\"__call__\\\", None)\\n return inspect.iscoroutinefunction(dunder_call)\\n\\n\\ndef wrap_to_async_func(\\n call: typing.Callable[..., typing.Any],\\n) -> typing.Callable[..., typing.Awaitable[typing.Any]]:\\n if is_coroutine_callable(call):\\n return call\\n\\n async def inner(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:\\n return call(*args, **kwargs)\\n\\n return inner\\n\\n[end of tenacity/_utils.py]\",\n \"filename\": \"tenacity/_utils.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport functools\\nimport sys\\nimport typing as t\\n\\nimport tenacity\\nfrom tenacity import AttemptManager\\nfrom tenacity import BaseRetrying\\nfrom tenacity import DoAttempt\\nfrom tenacity import DoSleep\\nfrom tenacity import RetryCallState\\nfrom tenacity import RetryError\\nfrom tenacity import after_nothing\\nfrom tenacity import before_nothing\\nfrom tenacity import _utils\\n\\n# Import all built-in retry strategies for easier usage.\\nfrom .retry import RetryBaseT\\nfrom .retry import retry_all # noqa\\nfrom .retry import retry_any # noqa\\nfrom .retry import retry_if_exception # noqa\\nfrom .retry import retry_if_result # noqa\\nfrom ..retry import RetryBaseT as SyncRetryBaseT\\n\\nif t.TYPE_CHECKING:\\n from tenacity.stop import StopBaseT\\n from tenacity.wait import WaitBaseT\\n\\nWrappedFnReturnT = t.TypeVar(\\\"WrappedFnReturnT\\\")\\nWrappedFn = t.TypeVar(\\\"WrappedFn\\\", bound=t.Callable[..., t.Awaitable[t.Any]])\\n\\n\\ndef _portable_async_sleep(seconds: float) -> t.Awaitable[None]:\\n # If trio is already imported, then importing it is cheap.\\n # If trio isn't already imported, then it's definitely not running, so we\\n # can skip further checks.\\n if \\\"trio\\\" in sys.modules:\\n # If trio is available, then sniffio is too\\n import trio\\n import sniffio\\n\\n if sniffio.current_async_library() == \\\"trio\\\":\\n return trio.sleep(seconds)\\n # Otherwise, assume asyncio\\n # Lazy import asyncio as it's expensive (responsible for 25-50% of total import overhead).\\n import asyncio\\n\\n return asyncio.sleep(seconds)\\n\\n\\nclass AsyncRetrying(BaseRetrying):\\n def __init__(\\n self,\\n sleep: t.Callable[\\n [t.Union[int, float]], t.Union[None, t.Awaitable[None]]\\n ] = _portable_async_sleep,\\n stop: \\\"StopBaseT\\\" = tenacity.stop.stop_never,\\n wait: \\\"WaitBaseT\\\" = tenacity.wait.wait_none(),\\n retry: \\\"t.Union[SyncRetryBaseT, RetryBaseT]\\\" = tenacity.retry_if_exception_type(),\\n before: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = before_nothing,\\n after: t.Callable[\\n [\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]\\n ] = after_nothing,\\n before_sleep: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[None, t.Awaitable[None]]]\\n ] = None,\\n reraise: bool = False,\\n retry_error_cls: t.Type[\\\"RetryError\\\"] = RetryError,\\n retry_error_callback: t.Optional[\\n t.Callable[[\\\"RetryCallState\\\"], t.Union[t.Any, t.Awaitable[t.Any]]]\\n ] = None,\\n ) -> None:\\n super().__init__(\\n sleep=sleep, # type: ignore[arg-type]\\n stop=stop,\\n wait=wait,\\n retry=retry, # type: ignore[arg-type]\\n before=before, # type: ignore[arg-type]\\n after=after, # type: ignore[arg-type]\\n before_sleep=before_sleep, # type: ignore[arg-type]\\n reraise=reraise,\\n retry_error_cls=retry_error_cls,\\n retry_error_callback=retry_error_callback,\\n )\\n\\n async def __call__( # type: ignore[override]\\n self, fn: WrappedFn, *args: t.Any, **kwargs: t.Any\\n ) -> WrappedFnReturnT:\\n self.begin()\\n\\n retry_state = RetryCallState(retry_object=self, fn=fn, args=args, kwargs=kwargs)\\n while True:\\n do = await self.iter(retry_state=retry_state)\\n if isinstance(do, DoAttempt):\\n try:\\n result = await fn(*args, **kwargs)\\n except BaseException: # noqa: B902\\n retry_state.set_exception(sys.exc_info()) # type: ignore[arg-type]\\n else:\\n retry_state.set_result(result)\\n elif isinstance(do, DoSleep):\\n retry_state.prepare_for_next_attempt()\\n await self.sleep(do) # type: ignore[misc]\\n else:\\n return do # type: ignore[no-any-return]\\n\\n def _add_action_func(self, fn: t.Callable[..., t.Any]) -> None:\\n self.iter_state.actions.append(_utils.wrap_to_async_func(fn))\\n\\n async def _run_retry(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n self.iter_state.retry_run_result = await _utils.wrap_to_async_func(self.retry)(\\n retry_state\\n )\\n\\n async def _run_wait(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n if self.wait:\\n sleep = await _utils.wrap_to_async_func(self.wait)(retry_state)\\n else:\\n sleep = 0.0\\n\\n retry_state.upcoming_sleep = sleep\\n\\n async def _run_stop(self, retry_state: \\\"RetryCallState\\\") -> None: # type: ignore[override]\\n self.statistics[\\\"delay_since_first_attempt\\\"] = retry_state.seconds_since_start\\n self.iter_state.stop_run_result = await _utils.wrap_to_async_func(self.stop)(\\n retry_state\\n )\\n\\n async def iter(\\n self, retry_state: \\\"RetryCallState\\\"\\n ) -> t.Union[DoAttempt, DoSleep, t.Any]: # noqa: A003\\n self._begin_iter(retry_state)\\n result = None\\n for action in self.iter_state.actions:\\n result = await action(retry_state)\\n return result\\n\\n def __iter__(self) -> t.Generator[AttemptManager, None, None]:\\n raise TypeError(\\\"AsyncRetrying object is not iterable\\\")\\n\\n def __aiter__(self) -> \\\"AsyncRetrying\\\":\\n self.begin()\\n self._retry_state = RetryCallState(self, fn=None, args=(), kwargs={})\\n return self\\n\\n async def __anext__(self) -> AttemptManager:\\n while True:\\n do = await self.iter(retry_state=self._retry_state)\\n if do is None:\\n raise StopAsyncIteration\\n elif isinstance(do, DoAttempt):\\n return AttemptManager(retry_state=self._retry_state)\\n elif isinstance(do, DoSleep):\\n self._retry_state.prepare_for_next_attempt()\\n await self.sleep(do) # type: ignore[misc]\\n else:\\n raise StopAsyncIteration\\n\\n def wraps(self, fn: WrappedFn) -> WrappedFn:\\n wrapped = super().wraps(fn)\\n # Ensure wrapper is recognized as a coroutine function.\\n\\n @functools.wraps(\\n fn, functools.WRAPPER_ASSIGNMENTS + (\\\"__defaults__\\\", \\\"__kwdefaults__\\\")\\n )\\n async def async_wrapped(*args: t.Any, **kwargs: t.Any) -> t.Any:\\n # Always create a copy to prevent overwriting the local contexts when\\n # calling the same wrapped functions multiple times in the same stack\\n copy = self.copy()\\n async_wrapped.statistics = copy.statistics # type: ignore[attr-defined]\\n return await copy(fn, *args, **kwargs)\\n\\n # Preserve attributes\\n async_wrapped.retry = self # type: ignore[attr-defined]\\n async_wrapped.retry_with = wrapped.retry_with # type: ignore[attr-defined]\\n async_wrapped.statistics = {} # type: ignore[attr-defined]\\n\\n return async_wrapped # type: ignore[return-value]\\n\\n\\n__all__ = [\\n \\\"retry_all\\\",\\n \\\"retry_any\\\",\\n \\\"retry_if_exception\\\",\\n \\\"retry_if_result\\\",\\n \\\"WrappedFn\\\",\\n \\\"AsyncRetrying\\\",\\n]\\n\\n[end of tenacity/asyncio/__init__.py]\",\n \"filename\": \"tenacity/asyncio/__init__.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \"# Copyright 2016–2021 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\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.\\nimport abc\\nimport typing\\n\\nfrom tenacity import _utils\\nfrom tenacity import retry_base\\n\\nif typing.TYPE_CHECKING:\\n from tenacity import RetryCallState\\n\\n\\nclass async_retry_base(retry_base):\\n \\\"\\\"\\\"Abstract base class for async retry strategies.\\\"\\\"\\\"\\n\\n @abc.abstractmethod\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n pass\\n\\n def __and__( # type: ignore[override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_all\\\":\\n return retry_all(self, other)\\n\\n def __rand__( # type: ignore[misc,override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_all\\\":\\n return retry_all(other, self)\\n\\n def __or__( # type: ignore[override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_any\\\":\\n return retry_any(self, other)\\n\\n def __ror__( # type: ignore[misc,override]\\n self, other: \\\"typing.Union[retry_base, async_retry_base]\\\"\\n ) -> \\\"retry_any\\\":\\n return retry_any(other, self)\\n\\n\\nRetryBaseT = typing.Union[\\n async_retry_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Awaitable[bool]]\\n]\\n\\n\\nclass retry_if_exception(async_retry_base):\\n \\\"\\\"\\\"Retry strategy that retries if an exception verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(\\n self, predicate: typing.Callable[[BaseException], typing.Awaitable[bool]]\\n ) -> None:\\n self.predicate = predicate\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if retry_state.outcome.failed:\\n exception = retry_state.outcome.exception()\\n if exception is None:\\n raise RuntimeError(\\\"outcome failed but the exception is None\\\")\\n return await self.predicate(exception)\\n else:\\n return False\\n\\n\\nclass retry_if_result(async_retry_base):\\n \\\"\\\"\\\"Retries if the result verifies a predicate.\\\"\\\"\\\"\\n\\n def __init__(\\n self, predicate: typing.Callable[[typing.Any], typing.Awaitable[bool]]\\n ) -> None:\\n self.predicate = predicate\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n if retry_state.outcome is None:\\n raise RuntimeError(\\\"__call__() called before outcome was set\\\")\\n\\n if not retry_state.outcome.failed:\\n return await self.predicate(retry_state.outcome.result())\\n else:\\n return False\\n\\n\\nclass retry_any(async_retry_base):\\n \\\"\\\"\\\"Retries if any of the retries condition is valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\\n self.retries = retries\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n result = False\\n for r in self.retries:\\n result = result or await _utils.wrap_to_async_func(r)(retry_state)\\n if result:\\n break\\n return result\\n\\n\\nclass retry_all(async_retry_base):\\n \\\"\\\"\\\"Retries if all the retries condition are valid.\\\"\\\"\\\"\\n\\n def __init__(self, *retries: typing.Union[retry_base, async_retry_base]) -> None:\\n self.retries = retries\\n\\n async def __call__(self, retry_state: \\\"RetryCallState\\\") -> bool: # type: ignore[override]\\n result = True\\n for r in self.retries:\\n result = result and await _utils.wrap_to_async_func(r)(retry_state)\\n if not result:\\n break\\n return result\\n\\n[end of tenacity/asyncio/retry.py]\",\n \"filename\": \"tenacity/asyncio/retry.py\",\n \"id\": \"22\"\n },\n {\n \"content\": \"Tenacity\\n========\\n.. image:: https://img.shields.io/pypi/v/tenacity.svg\\n :target: https://pypi.python.org/pypi/tenacity\\n\\n.. image:: https://circleci.com/gh/jd/tenacity.svg?style=svg\\n :target: https://circleci.com/gh/jd/tenacity\\n\\n.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/badges/jd/tenacity&style=flat\\n :target: https://mergify.io\\n :alt: Mergify Status\\n\\n**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**\\n\\nTenacity is an Apache 2.0 licensed general-purpose retrying library, written in\\nPython, to simplify the task of adding retry behavior to just about anything.\\nIt originates from `a fork of retrying\\n<https://github.com/rholder/retrying/issues/65>`_ which is sadly no longer\\n`maintained <https://julien.danjou.info/python-tenacity/>`_. Tenacity isn't\\napi compatible with retrying but adds significant new functionality and\\nfixes a number of longstanding bugs.\\n\\nThe simplest use case is retrying a flaky function whenever an `Exception`\\noccurs until a value is returned.\\n\\n.. testcode::\\n\\n import random\\n from tenacity import retry\\n\\n @retry\\n def do_something_unreliable():\\n if random.randint(0, 10) > 1:\\n raise IOError(\\\"Broken sauce, everything is hosed!!!111one\\\")\\n else:\\n return \\\"Awesome sauce!\\\"\\n\\n print(do_something_unreliable())\\n\\n.. testoutput::\\n :hide:\\n\\n Awesome sauce!\\n\\n\\n.. toctree::\\n :hidden:\\n :maxdepth: 2\\n\\n changelog\\n api\\n\\n\\nFeatures\\n--------\\n\\n- Generic Decorator API\\n- Specify stop condition (i.e. limit by number of attempts)\\n- Specify wait condition (i.e. exponential backoff sleeping between attempts)\\n- Customize retrying on Exceptions\\n- Customize retrying on expected returned result\\n- Retry on coroutines\\n- Retry code block with context manager\\n\\n\\nInstallation\\n------------\\n\\nTo install *tenacity*, simply:\\n\\n.. code-block:: bash\\n\\n $ pip install tenacity\\n\\n\\nExamples\\n----------\\n\\nBasic Retry\\n~~~~~~~~~~~\\n\\n.. testsetup::\\n\\n import logging\\n #\\n # Note the following import is used for demonstration convenience only.\\n # Production code should always explicitly import the names it needs.\\n #\\n from tenacity import *\\n\\n class MyException(Exception):\\n pass\\n\\nAs you saw above, the default behavior is to retry forever without waiting when\\nan exception is raised.\\n\\n.. testcode::\\n\\n @retry\\n def never_gonna_give_you_up():\\n print(\\\"Retry forever ignoring Exceptions, don't wait between retries\\\")\\n raise Exception\\n\\nStopping\\n~~~~~~~~\\n\\nLet's be a little less persistent and set some boundaries, such as the number\\nof attempts before giving up.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(7))\\n def stop_after_7_attempts():\\n print(\\\"Stopping after 7 attempts\\\")\\n raise Exception\\n\\nWe don't have all day, so let's set a boundary for how long we should be\\nretrying stuff.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_delay(10))\\n def stop_after_10_s():\\n print(\\\"Stopping after 10 seconds\\\")\\n raise Exception\\n\\nIf you're on a tight deadline, and exceeding your delay time isn't ok,\\nthen you can give up on retries one attempt before you would exceed the delay.\\n\\n.. testcode::\\n\\n @retry(stop=stop_before_delay(10))\\n def stop_before_10_s():\\n print(\\\"Stopping 1 attempt before 10 seconds\\\")\\n raise Exception\\n\\nYou can combine several stop conditions by using the `|` operator:\\n\\n.. testcode::\\n\\n @retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))\\n def stop_after_10_s_or_5_retries():\\n print(\\\"Stopping after 10 seconds or 5 retries\\\")\\n raise Exception\\n\\nWaiting before retrying\\n~~~~~~~~~~~~~~~~~~~~~~~\\n\\nMost things don't like to be polled as fast as possible, so let's just wait 2\\nseconds between retries.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(2))\\n def wait_2_s():\\n print(\\\"Wait 2 second between retries\\\")\\n raise Exception\\n\\nSome things perform best with a bit of randomness injected.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random(min=1, max=2))\\n def wait_random_1_to_2_s():\\n print(\\\"Randomly wait 1 to 2 seconds between retries\\\")\\n raise Exception\\n\\nThen again, it's hard to beat exponential backoff when retrying distributed\\nservices and other remote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_exponential(multiplier=1, min=4, max=10))\\n def wait_exponential_1():\\n print(\\\"Wait 2^x * 1 second between each retry starting with 4 seconds, then up to 10 seconds, then 10 seconds afterwards\\\")\\n raise Exception\\n\\n\\nThen again, it's also hard to beat combining fixed waits and jitter (to\\nhelp avoid thundering herds) when retrying distributed services and other\\nremote endpoints.\\n\\n.. testcode::\\n\\n @retry(wait=wait_fixed(3) + wait_random(0, 2))\\n def wait_fixed_jitter():\\n print(\\\"Wait at least 3 seconds, and add up to 2 seconds of random delay\\\")\\n raise Exception\\n\\nWhen multiple processes are in contention for a shared resource, exponentially\\nincreasing jitter helps minimise collisions.\\n\\n.. testcode::\\n\\n @retry(wait=wait_random_exponential(multiplier=1, max=60))\\n def wait_exponential_jitter():\\n print(\\\"Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 seconds, then randomly up to 60 seconds afterwards\\\")\\n raise Exception\\n\\n\\nSometimes it's necessary to build a chain of backoffs.\\n\\n.. testcode::\\n\\n @retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +\\n [wait_fixed(7) for i in range(2)] +\\n [wait_fixed(9)]))\\n def wait_fixed_chained():\\n print(\\\"Wait 3s for 3 attempts, 7s for the next 2 attempts and 9s for all attempts thereafter\\\")\\n raise Exception\\n\\nWhether to retry\\n~~~~~~~~~~~~~~~~\\n\\nWe have a few options for dealing with retries that raise specific or general\\nexceptions, as in the cases here.\\n\\n.. testcode::\\n\\n class ClientError(Exception):\\n \\\"\\\"\\\"Some type of client error.\\\"\\\"\\\"\\n\\n @retry(retry=retry_if_exception_type(IOError))\\n def might_io_error():\\n print(\\\"Retry forever with no wait if an IOError occurs, raise any other errors\\\")\\n raise Exception\\n\\n @retry(retry=retry_if_not_exception_type(ClientError))\\n def might_client_error():\\n print(\\\"Retry forever with no wait if any error other than ClientError occurs. Immediately raise ClientError.\\\")\\n raise Exception\\n\\nWe can also use the result of the function to alter the behavior of retrying.\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=retry_if_result(is_none_p))\\n def might_return_none():\\n print(\\\"Retry with no wait if return value is None\\\")\\n\\nSee also these methods:\\n\\n.. testcode::\\n\\n retry_if_exception\\n retry_if_exception_type\\n retry_if_not_exception_type\\n retry_unless_exception_type\\n retry_if_result\\n retry_if_not_result\\n retry_if_exception_message\\n retry_if_not_exception_message\\n retry_any\\n retry_all\\n\\nWe can also combine several conditions:\\n\\n.. testcode::\\n\\n def is_none_p(value):\\n \\\"\\\"\\\"Return True if value is None\\\"\\\"\\\"\\n return value is None\\n\\n @retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))\\n def might_return_none():\\n print(\\\"Retry forever ignoring Exceptions with no wait if return value is None\\\")\\n\\nAny combination of stop, wait, etc. is also supported to give you the freedom\\nto mix and match.\\n\\nIt's also possible to retry explicitly at any time by raising the `TryAgain`\\nexception:\\n\\n.. testcode::\\n\\n @retry\\n def do_something():\\n result = something_else()\\n if result == 23:\\n raise TryAgain\\n\\nError Handling\\n~~~~~~~~~~~~~~\\n\\nNormally when your function fails its final time (and will not be retried again based on your settings),\\na `RetryError` is raised. The exception your code encountered will be shown somewhere in the *middle*\\nof the stack trace.\\n\\nIf you would rather see the exception your code encountered at the *end* of the stack trace (where it\\nis most visible), you can set `reraise=True`.\\n\\n.. testcode::\\n\\n @retry(reraise=True, stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except MyException:\\n # timed out retrying\\n pass\\n\\nBefore and After Retry, and Logging\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's possible to execute an action before any attempt of calling the function\\nby using the before callback function:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIn the same spirit, It's possible to execute after a call that failed:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\nIt's also possible to only log failures that are going to be retried. Normally\\nretries happen after a wait interval, so the keyword argument is called\\n``before_sleep``:\\n\\n.. testcode::\\n\\n import logging\\n import sys\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n @retry(stop=stop_after_attempt(3),\\n before_sleep=before_sleep_log(logger, logging.DEBUG))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n\\nStatistics\\n~~~~~~~~~~\\n\\nYou can access the statistics about the retry made over a function by using the\\n`statistics` attribute attached to the function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nCustom Callbacks\\n~~~~~~~~~~~~~~~~\\n\\nYou can also define your own callbacks. The callback should accept one\\nparameter called ``retry_state`` that contains all information about current\\nretry invocation.\\n\\nFor example, you can call a custom callback function after all retries failed,\\nwithout raising an exception (or you can re-raise or do anything really)\\n\\n.. testcode::\\n\\n def return_last_value(retry_state):\\n \\\"\\\"\\\"return the result of the last call attempt\\\"\\\"\\\"\\n return retry_state.outcome.result()\\n\\n def is_false(value):\\n \\\"\\\"\\\"Return True if value is False\\\"\\\"\\\"\\n return value is False\\n\\n # will return False after trying 3 times to get a different result\\n @retry(stop=stop_after_attempt(3),\\n retry_error_callback=return_last_value,\\n retry=retry_if_result(is_false))\\n def eventually_return_false():\\n return False\\n\\nRetryCallState\\n~~~~~~~~~~~~~~\\n\\n``retry_state`` argument is an object of :class:`~tenacity.RetryCallState` class.\\n\\nOther Custom Callbacks\\n~~~~~~~~~~~~~~~~~~~~~~\\n\\nIt's also possible to define custom callbacks for other keyword arguments.\\n\\n.. function:: my_stop(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should stop\\n :rtype: bool\\n\\n.. function:: my_wait(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: number of seconds to wait before next retry\\n :rtype: float\\n\\n.. function:: my_retry(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n :return: whether or not retrying should continue\\n :rtype: bool\\n\\n.. function:: my_before(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_after(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\n.. function:: my_before_sleep(retry_state)\\n\\n :param RetryCallState retry_state: info about current retry invocation\\n\\nHere's an example with a custom ``before_sleep`` function:\\n\\n.. testcode::\\n\\n import logging\\n\\n logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)\\n\\n logger = logging.getLogger(__name__)\\n\\n def my_before_sleep(retry_state):\\n if retry_state.attempt_number < 1:\\n loglevel = logging.INFO\\n else:\\n loglevel = logging.WARNING\\n logger.log(\\n loglevel, 'Retrying %s: attempt %s ended with: %s',\\n retry_state.fn, retry_state.attempt_number, retry_state.outcome)\\n\\n @retry(stop=stop_after_attempt(3), before_sleep=my_before_sleep)\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception()\\n except RetryError:\\n pass\\n\\n\\nChanging Arguments at Run Time\\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\\n\\nYou can change the arguments of a retry decorator as needed when calling it by\\nusing the `retry_with` function attached to the wrapped function:\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n try:\\n raise_my_exception.retry_with(stop=stop_after_attempt(4))()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nIf you want to use variables to set up the retry parameters, you don't have\\nto use the `retry` decorator - you can instead use `Retrying` directly:\\n\\n.. testcode::\\n\\n def never_good_enough(arg1):\\n raise Exception('Invalid argument: {}'.format(arg1))\\n\\n def try_never_good_enough(max_attempts=3):\\n retryer = Retrying(stop=stop_after_attempt(max_attempts), reraise=True)\\n retryer(never_good_enough, 'I really do try')\\n\\nYou may also want to change the behaviour of a decorated function temporarily,\\nlike in tests to avoid unnecessary wait times. You can modify/patch the `retry`\\nattribute attached to the function. Bear in mind this is a write-only attribute,\\nstatistics should be read from the function `statistics` attribute.\\n\\n.. testcode::\\n\\n @retry(stop=stop_after_attempt(3), wait=wait_fixed(3))\\n def raise_my_exception():\\n raise MyException(\\\"Fail\\\")\\n\\n from unittest import mock\\n\\n with mock.patch.object(raise_my_exception.retry, \\\"wait\\\", wait_fixed(0)):\\n try:\\n raise_my_exception()\\n except Exception:\\n pass\\n\\n print(raise_my_exception.statistics)\\n\\n.. testoutput::\\n :hide:\\n\\n ...\\n\\nRetrying code block\\n~~~~~~~~~~~~~~~~~~~\\n\\nTenacity allows you to retry a code block without the need to wraps it in an\\nisolated function. This makes it easy to isolate failing block while sharing\\ncontext. The trick is to combine a for loop and a context manager.\\n\\n.. testcode::\\n\\n from tenacity import Retrying, RetryError, stop_after_attempt\\n\\n try:\\n for attempt in Retrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nYou can configure every details of retry policy by configuring the Retrying\\nobject.\\n\\nWith async code you can use AsyncRetrying.\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, RetryError, stop_after_attempt\\n\\n async def function():\\n try:\\n async for attempt in AsyncRetrying(stop=stop_after_attempt(3)):\\n with attempt:\\n raise Exception('My code is failing!')\\n except RetryError:\\n pass\\n\\nIn both cases, you may want to set the result to the attempt so it's available\\nin retry strategies like ``retry_if_result``. This can be done accessing the\\n``retry_state`` property:\\n\\n.. testcode::\\n\\n from tenacity import AsyncRetrying, retry_if_result\\n\\n async def function():\\n async for attempt in AsyncRetrying(retry=retry_if_result(lambda x: x < 3)):\\n with attempt:\\n result = 1 # Some complex calculation, function call, etc.\\n if not attempt.retry_state.outcome.failed:\\n attempt.retry_state.set_result(result)\\n return result\\n\\nAsync and retry\\n~~~~~~~~~~~~~~~\\n\\nFinally, ``retry`` works also on asyncio, Trio, and Tornado (>= 4.5) coroutines.\\nSleeps are done asynchronously too.\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_asyncio_function(loop):\\n await loop.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n async def my_async_trio_function():\\n await trio.socket.getaddrinfo('8.8.8.8', 53)\\n\\n.. code-block:: python\\n\\n @retry\\n @tornado.gen.coroutine\\n def my_async_tornado_function(http_client, url):\\n yield http_client.fetch(url)\\n\\nYou can even use alternative event loops such as `curio` by passing the correct sleep function:\\n\\n.. code-block:: python\\n\\n @retry(sleep=curio.sleep)\\n async def my_async_curio_function():\\n await asks.get('https://example.org')\\n\\nContribute\\n----------\\n\\n#. Check for open issues or open a fresh issue to start a discussion around a\\n feature idea or a bug.\\n#. Fork `the repository`_ on GitHub to start making your changes to the\\n **main** branch (or branch off of it).\\n#. Write a test which shows that the bug was fixed or that the feature works as\\n expected.\\n#. Add a `changelog <#Changelogs>`_\\n#. Make the docs better (or more detailed, or more easier to read, or ...)\\n\\n.. _`the repository`: https://github.com/jd/tenacity\\n\\nChangelogs\\n~~~~~~~~~~\\n\\n`reno`_ is used for managing changelogs. Take a look at their usage docs.\\n\\nThe doc generation will automatically compile the changelogs. You just need to add them.\\n\\n.. code-block:: sh\\n\\n # Opens a template file in an editor\\n tox -e reno -- new some-slug-for-my-change --edit\\n\\n.. _`reno`: https://docs.openstack.org/reno/latest/user/usage.html\\n\\n[end of doc/source/index.rst]\",\n \"filename\": \"doc/source/index.rst\",\n \"id\": \"23\"\n },\n {\n \"content\": \"# Copyright 2016 Étienne Bersac\\n# Copyright 2016 Julien Danjou\\n# Copyright 2016 Joshua Harlow\\n# Copyright 2013-2014 Ray Holder\\n#\\n# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\\n# you may not use this file except in compliance with the License.\\n# You may obtain a copy of the License at\\n#\\n# http://www.apache.org/licenses/LICENSE-2.0\\n#\\n# Unless required by applicable law or agreed to in writing, software\\n# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\\n# See the License for the specific language governing permissions and\\n# limitations under the License.\\n\\nimport os\\nimport sys\\n\\nmaster_doc = \\\"index\\\"\\nproject = \\\"Tenacity\\\"\\n\\n# Add tenacity to the path, so sphinx can find the functions for autodoc.\\nsys.path.insert(0, os.path.abspath(\\\"../..\\\"))\\n\\nextensions = [\\n \\\"sphinx.ext.doctest\\\",\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"reno.sphinxext\\\",\\n]\\n\\n# -- Options for sphinx.ext.doctest -----------------------------------------\\n\\n# doctest_default_flags =\\ncwd = os.path.abspath(os.path.dirname(__file__))\\ntenacity_path = os.path.join(cwd, os.pardir, os.pardir)\\ndoctest_path = [tenacity_path]\\n# doctest_global_setup =\\n# doctest_global_cleanup =\\n# doctest_test_doctest_blocks =\\n\\n[end of doc/source/conf.py]\",\n \"filename\": \"doc/source/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"Changelog\\n=========\\n\\n.. release-notes::\\n\\n[end of doc/source/changelog.rst]\",\n \"filename\": \"doc/source/changelog.rst\",\n \"id\": \"25\"\n },\n {\n \"content\": \"===============\\n API Reference\\n===============\\n\\nRetry Main API\\n--------------\\n\\n.. autofunction:: tenacity.retry\\n :noindex:\\n\\n.. autoclass:: tenacity.Retrying\\n :members:\\n\\n.. autoclass:: tenacity.AsyncRetrying\\n :members:\\n\\n.. autoclass:: tenacity.tornadoweb.TornadoRetrying\\n :members:\\n\\n.. autoclass:: tenacity.RetryCallState\\n :members:\\n\\nAfter Functions\\n---------------\\n\\nThose functions can be used as the `after` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.after\\n :members:\\n\\nBefore Functions\\n----------------\\n\\nThose functions can be used as the `before` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.before\\n :members:\\n\\nBefore Sleep Functions\\n----------------------\\n\\nThose functions can be used as the `before_sleep` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.before_sleep\\n :members:\\n\\nNap Functions\\n-------------\\n\\nThose functions can be used as the `sleep` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.nap\\n :members:\\n\\nRetry Functions\\n---------------\\n\\nThose functions can be used as the `retry` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.retry\\n :members:\\n\\nStop Functions\\n--------------\\n\\nThose functions can be used as the `stop` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.stop\\n :members:\\n\\nWait Functions\\n--------------\\n\\nThose functions can be used as the `wait` keyword argument of\\n:py:func:`tenacity.retry`.\\n\\n.. automodule:: tenacity.wait\\n :members:\\n\\n[end of doc/source/api.rst]\",\n \"filename\": \"doc/source/api.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"---\\nupgrade:\\n - |\\n Support for Python 3.6 has been removed.\\n\\n[end of releasenotes/notes/remove-py36-876c0416cf279d15.yaml]\",\n \"filename\": \"releasenotes/notes/remove-py36-876c0416cf279d15.yaml\",\n \"id\": \"27\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Fix async loop with retrying code block when result is available.\\n\\n[end of releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml]\",\n \"filename\": \"releasenotes/notes/fix-async-loop-with-result-f68e913ccb425aca.yaml\",\n \"id\": \"28\"\n },\n {\n \"content\": \"---\\nupgrade:\\n - \\\"Removed `BaseRetrying.call`: was long time deprecated and produced `DeprecationWarning`\\\"\\n - \\\"Removed `BaseRetrying.fn`: was noted as deprecated\\\"\\n - \\\"API change: `BaseRetrying.begin()` do not require arguments anymore as it not setting `BaseRetrying.fn`\\\"\\n\\n[end of releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml]\",\n \"filename\": \"releasenotes/notes/drop_deprecated-7ea90b212509b082.yaml\",\n \"id\": \"29\"\n },\n {\n \"content\": \"---\\nfixes:\\n - Fix setuptools config to include tenacity.asyncio package in release distributions.\\n\\n[end of releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml]\",\n \"filename\": \"releasenotes/notes/fix-setuptools-config-3af71aa3592b6948.yaml\",\n \"id\": \"30\"\n },\n {\n \"content\": \"---\\nother:\\n - Add a \\\\\\\"test\\\\\\\" extra\\n\\n[end of releasenotes/notes/add-test-extra-55e869261b03e56d.yaml]\",\n \"filename\": \"releasenotes/notes/add-test-extra-55e869261b03e56d.yaml\",\n \"id\": \"31\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Use str.format to format the logs internally to make logging compatible with other logger such as loguru.\\n\\n[end of releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml]\",\n \"filename\": \"releasenotes/notes/make-logger-more-compatible-5da1ddf1bab77047.yaml\",\n \"id\": \"32\"\n },\n {\n \"content\": \"---\\nother:\\n - Unit tests can now mock ``nap.sleep()`` for testing in all tenacity usage styles\\n[end of releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml]\",\n \"filename\": \"releasenotes/notes/allow-mocking-of-nap-sleep-6679c50e702446f1.yaml\",\n \"id\": \"33\"\n },\n {\n \"content\": \"---\\nfixes:\\n - \\\"Fix after_log logger format: function name was used with delay formatting.\\\"\\n\\n[end of releasenotes/notes/after_log-50f4d73b24ce9203.yaml]\",\n \"filename\": \"releasenotes/notes/after_log-50f4d73b24ce9203.yaml\",\n \"id\": \"34\"\n },\n {\n \"content\": \"---\\nother:\\n - \\\"Use `black` for code formatting and validate using `black --check`. Code compatibility: py26-py39.\\\"\\n - \\\"Enforce maximal line length to 120 symbols\\\"\\n\\n[end of releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml]\",\n \"filename\": \"releasenotes/notes/Use--for-formatting-and-validate-using-black-39ec9d57d4691778.yaml\",\n \"id\": \"35\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Preserve __defaults__ and __kwdefaults__ through retry decorator\\n\\n[end of releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml]\",\n \"filename\": \"releasenotes/notes/some-slug-for-preserve-defaults-86682846dfa18005.yaml\",\n \"id\": \"36\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add ``retry_if_not_exception_type()`` that allows to retry if a raised exception doesn't match given exceptions.\\n\\n[end of releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml]\",\n \"filename\": \"releasenotes/notes/add-retry_except_exception_type-31b31da1924d55f4.yaml\",\n \"id\": \"37\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Argument `wait` was improperly annotated, making mypy checks fail.\\n Now it's annotated as `typing.Union[wait_base, typing.Callable[[\\\"RetryCallState\\\"], typing.Union[float, int]]]`\\n\\n[end of releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml]\",\n \"filename\": \"releasenotes/notes/fix-wait-typing-b26eecdb6cc0a1de.yaml\",\n \"id\": \"38\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Explicitly export convenience symbols from tenacity root module\\n\\n[end of releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml]\",\n \"filename\": \"releasenotes/notes/export-convenience-symbols-981d9611c8b754f3.yaml\",\n \"id\": \"39\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add ``datetime.timedelta`` as accepted wait unit type.\\n\\n[end of releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml]\",\n \"filename\": \"releasenotes/notes/support-timedelta-wait-unit-type-5ba1e9fc0fe45523.yaml\",\n \"id\": \"40\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Add a Dependabot configuration submit PRs monthly (as needed)\\n to keep GitHub action versions updated.\\n\\n[end of releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml]\",\n \"filename\": \"releasenotes/notes/dependabot-for-github-actions-4d2464f3c0928463.yaml\",\n \"id\": \"41\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Add a new `retry_base` class called `retry_if_exception_cause_type` that\\n checks, recursively, if any of the causes of the raised exception is of a certain type.\\n\\n[end of releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml]\",\n \"filename\": \"releasenotes/notes/add_retry_if_exception_cause_type-d16b918ace4ae0ad.yaml\",\n \"id\": \"42\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Added the ability to use async functions for retries. This way, you can now use\\n asyncio coroutines for retry strategy predicates.\\n\\n[end of releasenotes/notes/add-async-actions-b249c527d99723bb.yaml]\",\n \"filename\": \"releasenotes/notes/add-async-actions-b249c527d99723bb.yaml\",\n \"id\": \"43\"\n },\n {\n \"content\": \"---\\nprelude: >\\n Clarify usage of `reraise` keyword argument\\n\\n[end of releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml]\",\n \"filename\": \"releasenotes/notes/clarify-reraise-option-6829667eacf4f599.yaml\",\n \"id\": \"44\"\n },\n {\n \"content\": \"---\\nfixes: Sphinx build error where Sphinx complains about an undefined class.\\n\\n[end of releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml]\",\n \"filename\": \"releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml\",\n \"id\": \"45\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add reno (changelog system)\\n\\n[end of releasenotes/notes/add-reno-d1ab5710f272650a.yaml]\",\n \"filename\": \"releasenotes/notes/add-reno-d1ab5710f272650a.yaml\",\n \"id\": \"46\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Avoid overwriting local contexts when applying the retry decorator.\\n\\n[end of releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml]\",\n \"filename\": \"releasenotes/notes/fix-local-context-overwrite-94190ba06a481631.yaml\",\n \"id\": \"47\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Most part of the code is type annotated.\\n - Python 3.10 support has been added.\\n\\n[end of releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml]\",\n \"filename\": \"releasenotes/notes/py36_plus-c425fb3aa17c6682.yaml\",\n \"id\": \"48\"\n },\n {\n \"content\": \"---\\nother:\\n - Add type annotations to cover all public API.\\n\\n[end of releasenotes/notes/annotate_code-197b93130df14042.yaml]\",\n \"filename\": \"releasenotes/notes/annotate_code-197b93130df14042.yaml\",\n \"id\": \"49\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n `AsyncRetrying` was erroneously implementing `__iter__()`, making tenacity\\n retrying mechanism working but in a synchronous fashion and not waiting as\\n expected. This interface has been removed, `__aiter__()` should be used\\n instead.\\n\\n[end of releasenotes/notes/no-async-iter-6132a42e52348a75.yaml]\",\n \"filename\": \"releasenotes/notes/no-async-iter-6132a42e52348a75.yaml\",\n \"id\": \"50\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Added a new stop function: stop_before_delay, which will stop execution\\n if the next sleep time would cause overall delay to exceed the specified delay. \\n Useful for use cases where you have some upper bound on retry times that you must\\n not exceed, so returning before that timeout is preferable than returning after that timeout.\\n[end of releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml]\",\n \"filename\": \"releasenotes/notes/add-stop-before-delay-a775f88ac872c923.yaml\",\n \"id\": \"51\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n If you're using `Trio <https://trio.readthedocs.io>`__, then\\n ``@retry`` now works automatically. It's no longer necessary to\\n pass ``sleep=trio.sleep``.\\n\\n[end of releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml]\",\n \"filename\": \"releasenotes/notes/trio-support-retry-22bd544800cd1f36.yaml\",\n \"id\": \"52\"\n },\n {\n \"content\": \"---\\nother: >-\\n Corrected the PyPI-published wheel tag to match the\\n metadata saying that the release is Python 3 only.\\n...\\n\\n[end of releasenotes/notes/pr320-py3-only-wheel-tag.yaml]\",\n \"filename\": \"releasenotes/notes/pr320-py3-only-wheel-tag.yaml\",\n \"id\": \"53\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n - accept ``datetime.timedelta`` instances as argument to ``tenacity.stop.stop_after_delay``\\n\\n[end of releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml]\",\n \"filename\": \"releasenotes/notes/timedelta-for-stop-ef6bf71b88ce9988.yaml\",\n \"id\": \"54\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Restore the value of the `retry` attribute for wrapped functions. Also,\\n clarify that those attributes are write-only and statistics should be\\n read from the function attribute directly.\\n\\n[end of releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml]\",\n \"filename\": \"releasenotes/notes/fix-retry-wrapper-attributes-f7a3a45b8e90f257.yaml\",\n \"id\": \"55\"\n },\n {\n \"content\": \"---\\nfixes:\\n - \\\"Fix issue #288 : __name__ and other attributes for async functions\\\"\\n\\n[end of releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml]\",\n \"filename\": \"releasenotes/notes/fix_async-52b6594c8e75c4bc.yaml\",\n \"id\": \"56\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Added a link to the documentation, as code snippets are not being rendered properly\\n Changed branch name to main in index.rst\\n\\n[end of releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml]\",\n \"filename\": \"releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml\",\n \"id\": \"57\"\n },\n {\n \"content\": \"---\\nfixes:\\n - |\\n Respects `min` arg for `wait_random_exponential`\\n\\n[end of releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml]\",\n \"filename\": \"releasenotes/notes/wait-random-exponential-min-2a4b7eed9f002436.yaml\",\n \"id\": \"58\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add a ``__repr__`` method to ``RetryCallState`` objects for easier debugging.\\n\\n[end of releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml]\",\n \"filename\": \"releasenotes/notes/retrycallstate-repr-94947f7b00ee15e1.yaml\",\n \"id\": \"59\"\n },\n {\n \"content\": \"---\\nother:\\n - |\\n Drop support for deprecated Python versions (2.7 and 3.5)\\n\\n[end of releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml]\",\n \"filename\": \"releasenotes/notes/drop-deprecated-python-versions-69a05cb2e0f1034c.yaml\",\n \"id\": \"60\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - Add an ``exc_info`` option to the ``before_sleep_log()`` strategy.\\n[end of releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml]\",\n \"filename\": \"releasenotes/notes/before_sleep_log-improvements-d8149274dfb37d7c.yaml\",\n \"id\": \"61\"\n },\n {\n \"content\": \"---\\nother:\\n - Add `retry_if_exception_cause_type`and `wait_exponential_jitter` to __all__ of init.py\\n[end of releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml]\",\n \"filename\": \"releasenotes/notes/add_omitted_modules_to_import_all-2ab282f20a2c22f7.yaml\",\n \"id\": \"62\"\n },\n {\n \"content\": \"---\\nfeatures:\\n - |\\n Implement a wait.wait_exponential_jitter per Google's storage retry guide.\\n See https://cloud.google.com/storage/docs/retry-strategy\\n\\n[end of releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml]\",\n \"filename\": \"releasenotes/notes/wait_exponential_jitter-6ffc81dddcbaa6d3.yaml\",\n \"id\": \"63\"\n }\n]","isConversational":false}}},{"rowIdx":69,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 69,\n \"num_files\": 28,\n \"repo_id\": \"repo_0069\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"Copyright (C) 2010, 2011 Sebastian Thiel and contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions \nare met:\n\n* Redistributions of source code must retain the above copyright \nnotice, this list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright \nnotice, this list of conditions and the following disclaimer in the \ndocumentation and/or other materials provided with the distribution.\n\n* Neither the name of the async project nor the names of \nits contributors may be used to endorse or promote products derived \nfrom this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED \nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR \nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING \nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":".PHONY: all clean release force_release\n\nall:\n\t@grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all\n\nclean:\n\trm -rf build/ dist/ .eggs/ .tox/\n\nforce_release: clean\n\t./build-release.sh\n\ttwine upload dist/*\n\tgit push --tags origin master\n\n[end of Makefile]","filename":"Makefile","id":"1"},{"content":"# Include the license file\ninclude LICENSE\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"2"},{"content":"[run]\nsource = smmap\n\n; to make nosetests happy\n[report]\nomit = \n\t*/yaml*\n\t*/tests/*\n */python?.?/*\n */site-packages/nose/*\n[end of .coveragerc]","filename":".coveragerc","id":"3"},{"content":"## Motivation\n\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\n\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\n\n\n## Limitations\n\n* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.\n* The memory access is read-only by design.\n\n\n## Overview\n\n\n\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\n\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\n\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\n\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\n\n\n\n## Prerequisites\n\n* Python 3.7+\n* OSX, Windows or Linux\n\nThe package was tested on all of the previously mentioned configurations.\n\n## Installing smmap\n\n[](https://readthedocs.org/projects/smmap/?badge=latest)\n\nIts easiest to install smmap using the [pip](http://www.pip-installer.org/en/latest) program:\n\n```bash\n$ pip install smmap\n```\n\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\n\nIf you have downloaded the source archive, the package can be installed by running the `setup.py` script:\n\n```bash\n$ python setup.py install\n```\n\nIt is advised to have a look at the **Usage Guide** for a brief introduction on the different database implementations.\n\n\n\n## Homepage and Links\n\nThe project is home on github at https://github.com/gitpython-developers/smmap .\n\nThe latest source can be cloned from github as well:\n\n* git://github.com/gitpython-developers/smmap.git\n\n\nFor support, please use the git-python mailing list:\n\n* http://groups.google.com/group/git-python\n\n\nIssues can be filed on github:\n\n* https://github.com/gitpython-developers/smmap/issues\n\nA link to the pypi page related to this repository:\n\n* https://pypi.org/project/smmap/\n\n\n## License Information\n\n*smmap* is licensed under the New BSD License.\n\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"#!/usr/bin/env python\nimport os\n\ntry:\n from setuptools import setup, find_packages\nexcept ImportError:\n from ez_setup import use_setuptools\n use_setuptools()\n from setuptools import setup, find_packages\n\nimport smmap\n\nif os.path.exists(\"README.md\"):\n long_description = open('README.md', encoding=\"utf-8\").read().replace('\\r\\n', '\\n')\nelse:\n long_description = \"See https://github.com/gitpython-developers/smmap\"\n\nsetup(\n name=\"smmap\",\n version=smmap.__version__,\n description=\"A pure Python implementation of a sliding window memory map manager\",\n author=smmap.__author__,\n author_email=smmap.__contact__,\n url=smmap.__homepage__,\n platforms=[\"any\"],\n license=\"BSD-3-Clause\",\n packages=find_packages(),\n zip_safe=True,\n python_requires=\">=3.7\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Operating System :: POSIX\",\n \"Operating System :: Microsoft :: Windows\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.7\",\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 \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3 :: Only\",\n ],\n long_description=long_description,\n long_description_content_type='text/markdown',\n)\n\n[end of setup.py]","filename":"setup.py","id":"5"},{"content":"# Tox (http://tox.testrun.org/) is a tool for running tests\n# in multiple virtualenvs. This configuration file will run the\n# test suite on all supported python versions. To use it, \"pip install tox\"\n# and then run \"tox\" from this directory.\n\n[tox]\nenvlist = flake8, py{37, 38, 39, 310, 311, 312}\n\n[testenv]\ncommands = {envpython} -m pytest --cov smmap --cov-report xml {posargs}\ndeps =\n pytest\n pytest-cov\n\n[testenv:flake8]\ncommands = flake8 {posargs}\ndeps = flake8\n\n[end of tox.ini]","filename":"tox.ini","id":"6"},{"content":"[flake8]\nexclude = .tox,.venv,build,dist,doc\n\n[end of setup.cfg]","filename":"setup.cfg","id":"7"},{"content":"#!/bin/bash\n#\n# This script builds a release. If run in a venv, it auto-installs its tools.\n# You may want to run \"make release\" instead of running this script directly.\n\nset -eEu\n\nfunction release_with() {\n $1 -m build --sdist --wheel\n}\n\nif test -n \"${VIRTUAL_ENV:-}\"; then\n deps=(build twine) # Install twine along with build, as we need it later.\n echo \"Virtual environment detected. Adding packages: ${deps[*]}\"\n pip install --quiet --upgrade \"${deps[@]}\"\n echo 'Starting the build.'\n release_with python\nelse\n function suggest_venv() {\n venv_cmd='python -m venv env && source env/bin/activate'\n printf \"HELP: To avoid this error, use a virtual-env with '%s' instead.\\n\" \"$venv_cmd\"\n }\n trap suggest_venv ERR # This keeps the original exit (error) code.\n echo 'Starting the build.'\n release_with python3 # Outside a venv, use python3.\nfi\n\n[end of build-release.sh]","filename":"build-release.sh","id":"8"},{"content":"# Security Policy\n\nSee [GitPython](https://github.com/gitpython-developers/GitPython/blob/main/SECURITY.md). Vulnerabilities found in `smmap` can be reported there.\n\n[end of SECURITY.md]","filename":"SECURITY.md","id":"9"},{"content":"\"\"\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\"\"\"\nfrom .util import (\n MapWindow,\n MapRegion,\n MapRegionList,\n is_64_bit,\n)\n\nimport sys\nfrom functools import reduce\n\n__all__ = [\"StaticWindowMapManager\", \"SlidingWindowMapManager\", \"WindowCursor\"]\n#{ Utilities\n\n#}END utilities\n\n\nclass WindowCursor:\n\n \"\"\"\n Pointer into the mapped region of the memory manager, keeping the map\n alive until it is destroyed and no other client uses it.\n\n Cursors should not be created manually, but are instead returned by the SlidingWindowMapManager\n\n **Note:**: The current implementation is suited for static and sliding window managers, but it also means\n that it must be suited for the somewhat quite different sliding manager. It could be improved, but\n I see no real need to do so.\"\"\"\n __slots__ = (\n '_manager', # the manager keeping all file regions\n '_rlist', # a regions list with regions for our file\n '_region', # our current class:`MapRegion` or None\n '_ofs', # relative offset from the actually mapped area to our start area\n '_size' # maximum size we should provide\n )\n\n def __init__(self, manager=None, regions=None):\n self._manager = manager\n self._rlist = regions\n self._region = None\n self._ofs = 0\n self._size = 0\n\n def __del__(self):\n self._destroy()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self._destroy()\n\n def _destroy(self):\n \"\"\"Destruction code to decrement counters\"\"\"\n self.unuse_region()\n\n if self._rlist is not None:\n # Actual client count, which doesn't include the reference kept by the manager, nor ours\n # as we are about to be deleted\n try:\n if len(self._rlist) == 0:\n # Free all resources associated with the mapped file\n self._manager._fdict.pop(self._rlist.path_or_fd())\n # END remove regions list from manager\n except (TypeError, KeyError):\n # sometimes, during shutdown, getrefcount is None. Its possible\n # to re-import it, however, its probably better to just ignore\n # this python problem (for now).\n # The next step is to get rid of the error prone getrefcount altogether.\n pass\n # END exception handling\n # END handle regions\n\n def _copy_from(self, rhs):\n \"\"\"Copy all data from rhs into this instance, handles usage count\"\"\"\n self._manager = rhs._manager\n self._rlist = type(rhs._rlist)(rhs._rlist)\n self._region = rhs._region\n self._ofs = rhs._ofs\n self._size = rhs._size\n\n for region in self._rlist:\n region.increment_client_count()\n\n if self._region is not None:\n self._region.increment_client_count()\n # END handle regions\n\n def __copy__(self):\n \"\"\"copy module interface\"\"\"\n cpy = type(self)()\n cpy._copy_from(self)\n return cpy\n\n #{ Interface\n def assign(self, rhs):\n \"\"\"Assign rhs to this instance. This is required in order to get a real copy.\n Alternatively, you can copy an existing instance using the copy module\"\"\"\n self._destroy()\n self._copy_from(rhs)\n\n def use_region(self, offset=0, size=0, flags=0):\n \"\"\"Assure we point to a window which allows access to the given offset into the file\n\n :param offset: absolute offset in bytes into the file\n :param size: amount of bytes to map. If 0, all available bytes will be mapped\n :param flags: additional flags to be given to os.open in case a file handle is initially opened\n for mapping. Has no effect if a region can actually be reused.\n :return: this instance - it should be queried for whether it points to a valid memory region.\n This is not the case if the mapping failed because we reached the end of the file\n\n **Note:**: The size actually mapped may be smaller than the given size. If that is the case,\n either the file has reached its end, or the map was created between two existing regions\"\"\"\n need_region = True\n man = self._manager\n fsize = self._rlist.file_size()\n size = min(size or fsize, man.window_size() or fsize) # clamp size to window size\n\n if self._region is not None:\n if self._region.includes_ofs(offset):\n need_region = False\n else:\n self.unuse_region()\n # END handle existing region\n # END check existing region\n\n # offset too large ?\n if offset >= fsize:\n return self\n # END handle offset\n\n if need_region:\n self._region = man._obtain_region(self._rlist, offset, size, flags, False)\n self._region.increment_client_count()\n # END need region handling\n\n self._ofs = offset - self._region._b\n self._size = min(size, self._region.ofs_end() - offset)\n\n return self\n\n def unuse_region(self):\n \"\"\"Unuse the current region. Does nothing if we have no current region\n\n **Note:** the cursor unuses the region automatically upon destruction. It is recommended\n to un-use the region once you are done reading from it in persistent cursors as it\n helps to free up resource more quickly\"\"\"\n if self._region is not None:\n self._region.increment_client_count(-1)\n self._region = None\n # note: should reset ofs and size, but we spare that for performance. Its not\n # allowed to query information if we are not valid !\n\n def buffer(self):\n \"\"\"Return a buffer object which allows access to our memory region from our offset\n to the window size. Please note that it might be smaller than you requested when calling use_region()\n\n **Note:** You can only obtain a buffer if this instance is_valid() !\n\n **Note:** buffers should not be cached passed the duration of your access as it will\n prevent resources from being freed even though they might not be accounted for anymore !\"\"\"\n return memoryview(self._region.buffer())[self._ofs:self._ofs+self._size]\n\n def map(self):\n \"\"\"\n :return: the underlying raw memory map. Please not that the offset and size is likely to be different\n to what you set as offset and size. Use it only if you are sure about the region it maps, which is the whole\n file in case of StaticWindowMapManager\"\"\"\n return self._region.map()\n\n def is_valid(self):\n \"\"\":return: True if we have a valid and usable region\"\"\"\n return self._region is not None\n\n def is_associated(self):\n \"\"\":return: True if we are associated with a specific file already\"\"\"\n return self._rlist is not None\n\n def ofs_begin(self):\n \"\"\":return: offset to the first byte pointed to by our cursor\n\n **Note:** only if is_valid() is True\"\"\"\n return self._region._b + self._ofs\n\n def ofs_end(self):\n \"\"\":return: offset to one past the last available byte\"\"\"\n # unroll method calls for performance !\n return self._region._b + self._ofs + self._size\n\n def size(self):\n \"\"\":return: amount of bytes we point to\"\"\"\n return self._size\n\n def region(self):\n \"\"\":return: our mapped region, or None if nothing is mapped yet\n :raise AssertionError: if we have no current region. This is only useful for debugging\"\"\"\n return self._region\n\n def includes_ofs(self, ofs):\n \"\"\":return: True if the given absolute offset is contained in the cursors\n current region\n\n **Note:** cursor must be valid for this to work\"\"\"\n # unroll methods\n return (self._region._b + self._ofs) <= ofs < (self._region._b + self._ofs + self._size)\n\n def file_size(self):\n \"\"\":return: size of the underlying file\"\"\"\n return self._rlist.file_size()\n\n def path_or_fd(self):\n \"\"\":return: path or file descriptor of the underlying mapped file\"\"\"\n return self._rlist.path_or_fd()\n\n def path(self):\n \"\"\":return: path of the underlying mapped file\n :raise ValueError: if attached path is not a path\"\"\"\n if isinstance(self._rlist.path_or_fd(), int):\n raise ValueError(\"Path queried although mapping was applied to a file descriptor\")\n # END handle type\n return self._rlist.path_or_fd()\n\n def fd(self):\n \"\"\":return: file descriptor used to create the underlying mapping.\n\n **Note:** it is not required to be valid anymore\n :raise ValueError: if the mapping was not created by a file descriptor\"\"\"\n if isinstance(self._rlist.path_or_fd(), str):\n raise ValueError(\"File descriptor queried although mapping was generated from path\")\n # END handle type\n return self._rlist.path_or_fd()\n\n #} END interface\n\n\nclass StaticWindowMapManager:\n\n \"\"\"Provides a manager which will produce single size cursors that are allowed\n to always map the whole file.\n\n Clients must be written to specifically know that they are accessing their data\n through a StaticWindowMapManager, as they otherwise have to deal with their window size.\n\n These clients would have to use a SlidingWindowMapBuffer to hide this fact.\n\n This type will always use a maximum window size, and optimize certain methods to\n accommodate this fact\"\"\"\n\n __slots__ = [\n '_fdict', # mapping of path -> StorageHelper (of some kind\n '_window_size', # maximum size of a window\n '_max_memory_size', # maximum amount of memory we may allocate\n '_max_handle_count', # maximum amount of handles to keep open\n '_memory_size', # currently allocated memory size\n '_handle_count', # amount of currently allocated file handles\n ]\n\n #{ Configuration\n MapRegionListCls = MapRegionList\n MapWindowCls = MapWindow\n MapRegionCls = MapRegion\n WindowCursorCls = WindowCursor\n #} END configuration\n\n _MB_in_bytes = 1024 * 1024\n\n def __init__(self, window_size=0, max_memory_size=0, max_open_handles=sys.maxsize):\n \"\"\"initialize the manager with the given parameters.\n :param window_size: if -1, a default window size will be chosen depending on\n the operating system's architecture. It will internally be quantified to a multiple of the page size\n If 0, the window may have any size, which basically results in mapping the whole file at one\n :param max_memory_size: maximum amount of memory we may map at once before releasing mapped regions.\n If 0, a viable default will be set depending on the system's architecture.\n It is a soft limit that is tried to be kept, but nothing bad happens if we have to over-allocate\n :param max_open_handles: if not maxint, limit the amount of open file handles to the given number.\n Otherwise the amount is only limited by the system itself. If a system or soft limit is hit,\n the manager will free as many handles as possible\"\"\"\n self._fdict = dict()\n self._window_size = window_size\n self._max_memory_size = max_memory_size\n self._max_handle_count = max_open_handles\n self._memory_size = 0\n self._handle_count = 0\n\n if window_size < 0:\n coeff = 64\n if is_64_bit():\n coeff = 1024\n # END handle arch\n self._window_size = coeff * self._MB_in_bytes\n # END handle max window size\n\n if max_memory_size == 0:\n coeff = 1024\n if is_64_bit():\n coeff = 8192\n # END handle arch\n self._max_memory_size = coeff * self._MB_in_bytes\n # END handle max memory size\n\n #{ Internal Methods\n\n def _collect_lru_region(self, size):\n \"\"\"Unmap the region which was least-recently used and has no client\n :param size: size of the region we want to map next (assuming its not already mapped partially or full\n if 0, we try to free any available region\n :return: Amount of freed regions\n\n .. Note::\n We don't raise exceptions anymore, in order to keep the system working, allowing temporary overallocation.\n If the system runs out of memory, it will tell.\n\n .. TODO::\n implement a case where all unusued regions are discarded efficiently.\n Currently its only brute force\n \"\"\"\n num_found = 0\n while (size == 0) or (self._memory_size + size > self._max_memory_size):\n lru_region = None\n lru_list = None\n for regions in self._fdict.values():\n for region in regions:\n # check client count - if it's 1, it's just us\n if (region.client_count() == 1 and\n (lru_region is None or region._uc < lru_region._uc)):\n lru_region = region\n lru_list = regions\n # END update lru_region\n # END for each region\n # END for each regions list\n\n if lru_region is None:\n break\n # END handle region not found\n\n num_found += 1\n del(lru_list[lru_list.index(lru_region)])\n lru_region.increment_client_count(-1)\n self._memory_size -= lru_region.size()\n self._handle_count -= 1\n # END while there is more memory to free\n return num_found\n\n def _obtain_region(self, a, offset, size, flags, is_recursive):\n \"\"\"Utility to create a new region - for more information on the parameters,\n see MapCursor.use_region.\n :param a: A regions (a)rray\n :return: The newly created region\"\"\"\n if self._memory_size + size > self._max_memory_size:\n self._collect_lru_region(size)\n # END handle collection\n\n r = None\n if a:\n assert len(a) == 1\n r = a[0]\n else:\n try:\n r = self.MapRegionCls(a.path_or_fd(), 0, sys.maxsize, flags)\n except Exception:\n # apparently we are out of system resources or hit a limit\n # As many more operations are likely to fail in that condition (\n # like reading a file from disk, etc) we free up as much as possible\n # As this invalidates our insert position, we have to recurse here\n if is_recursive:\n # we already tried this, and still have no success in obtaining\n # a mapping. This is an exception, so we propagate it\n raise\n # END handle existing recursion\n self._collect_lru_region(0)\n return self._obtain_region(a, offset, size, flags, True)\n # END handle exceptions\n\n self._handle_count += 1\n self._memory_size += r.size()\n a.append(r)\n # END handle array\n\n assert r.includes_ofs(offset)\n return r\n\n #}END internal methods\n\n #{ Interface\n def make_cursor(self, path_or_fd):\n \"\"\"\n :return: a cursor pointing to the given path or file descriptor.\n It can be used to map new regions of the file into memory\n\n **Note:** if a file descriptor is given, it is assumed to be open and valid,\n but may be closed afterwards. To refer to the same file, you may reuse\n your existing file descriptor, but keep in mind that new windows can only\n be mapped as long as it stays valid. This is why the using actual file paths\n are preferred unless you plan to keep the file descriptor open.\n\n **Note:** file descriptors are problematic as they are not necessarily unique, as two\n different files opened and closed in succession might have the same file descriptor id.\n\n **Note:** Using file descriptors directly is faster once new windows are mapped as it\n prevents the file to be opened again just for the purpose of mapping it.\"\"\"\n regions = self._fdict.get(path_or_fd)\n if regions is None:\n regions = self.MapRegionListCls(path_or_fd)\n self._fdict[path_or_fd] = regions\n # END obtain region for path\n return self.WindowCursorCls(self, regions)\n\n def collect(self):\n \"\"\"Collect all available free-to-collect mapped regions\n :return: Amount of freed handles\"\"\"\n return self._collect_lru_region(0)\n\n def num_file_handles(self):\n \"\"\":return: amount of file handles in use. Each mapped region uses one file handle\"\"\"\n return self._handle_count\n\n def num_open_files(self):\n \"\"\"Amount of opened files in the system\"\"\"\n return reduce(lambda x, y: x + y, (1 for rlist in self._fdict.values() if len(rlist) > 0), 0)\n\n def window_size(self):\n \"\"\":return: size of each window when allocating new regions\"\"\"\n return self._window_size\n\n def mapped_memory_size(self):\n \"\"\":return: amount of bytes currently mapped in total\"\"\"\n return self._memory_size\n\n def max_file_handles(self):\n \"\"\":return: maximum amount of handles we may have opened\"\"\"\n return self._max_handle_count\n\n def max_mapped_memory_size(self):\n \"\"\":return: maximum amount of memory we may allocate\"\"\"\n return self._max_memory_size\n\n #} END interface\n\n #{ Special Purpose Interface\n\n def force_map_handle_removal_win(self, base_path):\n \"\"\"ONLY AVAILABLE ON WINDOWS\n On windows removing files is not allowed if anybody still has it opened.\n If this process is ourselves, and if the whole process uses this memory\n manager (as far as the parent framework is concerned) we can enforce\n closing all memory maps whose path matches the given base path to\n allow the respective operation after all.\n The respective system must NOT access the closed memory regions anymore !\n This really may only be used if you know that the items which keep\n the cursors alive will not be using it anymore. They need to be recreated !\n :return: Amount of closed handles\n\n **Note:** does nothing on non-windows platforms\"\"\"\n if sys.platform != 'win32':\n return\n # END early bailout\n\n num_closed = 0\n for path, rlist in self._fdict.items():\n if path.startswith(base_path):\n for region in rlist:\n region.release()\n num_closed += 1\n # END path matches\n # END for each path\n return num_closed\n #} END special purpose interface\n\n\nclass SlidingWindowMapManager(StaticWindowMapManager):\n\n \"\"\"Maintains a list of ranges of mapped memory regions in one or more files and allows to easily\n obtain additional regions assuring there is no overlap.\n Once a certain memory limit is reached globally, or if there cannot be more open file handles\n which result from each mmap call, the least recently used, and currently unused mapped regions\n are unloaded automatically.\n\n **Note:** currently not thread-safe !\n\n **Note:** in the current implementation, we will automatically unload windows if we either cannot\n create more memory maps (as the open file handles limit is hit) or if we have allocated more than\n a safe amount of memory already, which would possibly cause memory allocations to fail as our address\n space is full.\"\"\"\n\n __slots__ = tuple()\n\n def __init__(self, window_size=-1, max_memory_size=0, max_open_handles=sys.maxsize):\n \"\"\"Adjusts the default window size to -1\"\"\"\n super().__init__(window_size, max_memory_size, max_open_handles)\n\n def _obtain_region(self, a, offset, size, flags, is_recursive):\n # bisect to find an existing region. The c++ implementation cannot\n # do that as it uses a linked list for regions.\n r = None\n lo = 0\n hi = len(a)\n while lo < hi:\n mid = (lo + hi) // 2\n ofs = a[mid]._b\n if ofs <= offset:\n if a[mid].includes_ofs(offset):\n r = a[mid]\n break\n # END have region\n lo = mid + 1\n else:\n hi = mid\n # END handle position\n # END while bisecting\n\n if r is None:\n window_size = self._window_size\n left = self.MapWindowCls(0, 0)\n mid = self.MapWindowCls(offset, size)\n right = self.MapWindowCls(a.file_size(), 0)\n\n # we want to honor the max memory size, and assure we have anough\n # memory available\n # Save calls !\n if self._memory_size + window_size > self._max_memory_size:\n self._collect_lru_region(window_size)\n # END handle collection\n\n # we assume the list remains sorted by offset\n insert_pos = 0\n len_regions = len(a)\n if len_regions == 1:\n if a[0]._b <= offset:\n insert_pos = 1\n # END maintain sort\n else:\n # find insert position\n insert_pos = len_regions\n for i, region in enumerate(a):\n if region._b > offset:\n insert_pos = i\n break\n # END if insert position is correct\n # END for each region\n # END obtain insert pos\n\n # adjust the actual offset and size values to create the largest\n # possible mapping\n if insert_pos == 0:\n if len_regions:\n right = self.MapWindowCls.from_region(a[insert_pos])\n # END adjust right side\n else:\n if insert_pos != len_regions:\n right = self.MapWindowCls.from_region(a[insert_pos])\n # END adjust right window\n left = self.MapWindowCls.from_region(a[insert_pos - 1])\n # END adjust surrounding windows\n\n mid.extend_left_to(left, window_size)\n mid.extend_right_to(right, window_size)\n mid.align()\n\n # it can happen that we align beyond the end of the file\n if mid.ofs_end() > right.ofs:\n mid.size = right.ofs - mid.ofs\n # END readjust size\n\n # insert new region at the right offset to keep the order\n try:\n if self._handle_count >= self._max_handle_count:\n raise Exception\n # END assert own imposed max file handles\n r = self.MapRegionCls(a.path_or_fd(), mid.ofs, mid.size, flags)\n except Exception:\n # apparently we are out of system resources or hit a limit\n # As many more operations are likely to fail in that condition (\n # like reading a file from disk, etc) we free up as much as possible\n # As this invalidates our insert position, we have to recurse here\n if is_recursive:\n # we already tried this, and still have no success in obtaining\n # a mapping. This is an exception, so we propagate it\n raise\n # END handle existing recursion\n self._collect_lru_region(0)\n return self._obtain_region(a, offset, size, flags, True)\n # END handle exceptions\n\n self._handle_count += 1\n self._memory_size += r.size()\n a.insert(insert_pos, r)\n # END create new region\n return r\n\n[end of smmap/mman.py]","filename":"smmap/mman.py","id":"10"},{"content":"\"\"\"Module with a simple buffer implementation using the memory manager\"\"\"\nimport sys\n\n__all__ = [\"SlidingWindowMapBuffer\"]\n\n\nclass SlidingWindowMapBuffer:\n\n \"\"\"A buffer like object which allows direct byte-wise object and slicing into\n memory of a mapped file. The mapping is controlled by the provided cursor.\n\n The buffer is relative, that is if you map an offset, index 0 will map to the\n first byte at the offset you used during initialization or begin_access\n\n **Note:** Although this type effectively hides the fact that there are mapped windows\n underneath, it can unfortunately not be used in any non-pure python method which\n needs a buffer or string\"\"\"\n __slots__ = (\n '_c', # our cursor\n '_size', # our supposed size\n )\n\n def __init__(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\n \"\"\"Initialize the instance to operate on the given cursor.\n :param cursor: if not None, the associated cursor to the file you want to access\n If None, you have call begin_access before using the buffer and provide a cursor\n :param offset: absolute offset in bytes\n :param size: the total size of the mapping. Defaults to the maximum possible size\n From that point on, the __len__ of the buffer will be the given size or the file size.\n If the size is larger than the mappable area, you can only access the actually available\n area, although the length of the buffer is reported to be your given size.\n Hence it is in your own interest to provide a proper size !\n :param flags: Additional flags to be passed to os.open\n :raise ValueError: if the buffer could not achieve a valid state\"\"\"\n self._c = cursor\n if cursor and not self.begin_access(cursor, offset, size, flags):\n raise ValueError(\"Failed to allocate the buffer - probably the given offset is out of bounds\")\n # END handle offset\n\n def __del__(self):\n self.end_access()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self.end_access()\n\n def __len__(self):\n return self._size\n\n def __getitem__(self, i):\n if isinstance(i, slice):\n return self.__getslice__(i.start or 0, i.stop or self._size)\n c = self._c\n assert c.is_valid()\n if i < 0:\n i = self._size + i\n if not c.includes_ofs(i):\n c.use_region(i, 1)\n # END handle region usage\n return c.buffer()[i - c.ofs_begin()]\n\n def __getslice__(self, i, j):\n c = self._c\n # fast path, slice fully included - safes a concatenate operation and\n # should be the default\n assert c.is_valid()\n if i < 0:\n i = self._size + i\n if j == sys.maxsize:\n j = self._size\n if j < 0:\n j = self._size + j\n if (c.ofs_begin() <= i) and (j < c.ofs_end()):\n b = c.ofs_begin()\n return c.buffer()[i - b:j - b]\n else:\n l = j - i # total length\n ofs = i\n # It's fastest to keep tokens and join later, especially in py3, which was 7 times slower\n # in the previous iteration of this code\n md = list()\n while l:\n c.use_region(ofs, l)\n assert c.is_valid()\n d = c.buffer()[:l]\n ofs += len(d)\n l -= len(d)\n # Make sure we don't keep references, as c.use_region() might attempt to free resources, but\n # can't unless we use pure bytes\n if hasattr(d, 'tobytes'):\n d = d.tobytes()\n md.append(d)\n # END while there are bytes to read\n return b''.join(md)\n # END fast or slow path\n #{ Interface\n\n def begin_access(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\n \"\"\"Call this before the first use of this instance. The method was already\n called by the constructor in case sufficient information was provided.\n\n For more information no the parameters, see the __init__ method\n :param path: if cursor is None the existing one will be used.\n :return: True if the buffer can be used\"\"\"\n if cursor:\n self._c = cursor\n # END update our cursor\n\n # reuse existing cursors if possible\n if self._c is not None and self._c.is_associated():\n res = self._c.use_region(offset, size, flags).is_valid()\n if res:\n # if given size is too large or default, we computer a proper size\n # If its smaller, we assume the combination between offset and size\n # as chosen by the user is correct and use it !\n # If not, the user is in trouble.\n if size > self._c.file_size():\n size = self._c.file_size() - offset\n # END handle size\n self._size = size\n # END set size\n return res\n # END use our cursor\n return False\n\n def end_access(self):\n \"\"\"Call this method once you are done using the instance. It is automatically\n called on destruction, and should be called just in time to allow system\n resources to be freed.\n\n Once you called end_access, you must call begin access before reusing this instance!\"\"\"\n self._size = 0\n if self._c is not None:\n self._c.unuse_region()\n # END unuse region\n\n def cursor(self):\n \"\"\":return: the currently set cursor which provides access to the data\"\"\"\n return self._c\n\n #}END interface\n\n[end of smmap/buf.py]","filename":"smmap/buf.py","id":"11"},{"content":"\"\"\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\"\"\"\nimport os\nimport sys\n\nfrom mmap import mmap, ACCESS_READ\nfrom mmap import ALLOCATIONGRANULARITY\n\n__all__ = [\"align_to_mmap\", \"is_64_bit\",\n \"MapWindow\", \"MapRegion\", \"MapRegionList\", \"ALLOCATIONGRANULARITY\"]\n\n#{ Utilities\n\n\ndef align_to_mmap(num, round_up):\n \"\"\"\n Align the given integer number to the closest page offset, which usually is 4096 bytes.\n\n :param round_up: if True, the next higher multiple of page size is used, otherwise\n the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)\n :return: num rounded to closest page\"\"\"\n res = (num // ALLOCATIONGRANULARITY) * ALLOCATIONGRANULARITY\n if round_up and (res != num):\n res += ALLOCATIONGRANULARITY\n # END handle size\n return res\n\n\ndef is_64_bit():\n \"\"\":return: True if the system is 64 bit. Otherwise it can be assumed to be 32 bit\"\"\"\n return sys.maxsize > (1 << 32) - 1\n\n#}END utilities\n\n\n#{ Utility Classes\n\nclass MapWindow:\n\n \"\"\"Utility type which is used to snap windows towards each other, and to adjust their size\"\"\"\n __slots__ = (\n 'ofs', # offset into the file in bytes\n 'size' # size of the window in bytes\n )\n\n def __init__(self, offset, size):\n self.ofs = offset\n self.size = size\n\n def __repr__(self):\n return \"MapWindow(%i, %i)\" % (self.ofs, self.size)\n\n @classmethod\n def from_region(cls, region):\n \"\"\":return: new window from a region\"\"\"\n return cls(region._b, region.size())\n\n def ofs_end(self):\n return self.ofs + self.size\n\n def align(self):\n \"\"\"Assures the previous window area is contained in the new one\"\"\"\n nofs = align_to_mmap(self.ofs, 0)\n self.size += self.ofs - nofs # keep size constant\n self.ofs = nofs\n self.size = align_to_mmap(self.size, 1)\n\n def extend_left_to(self, window, max_size):\n \"\"\"Adjust the offset to start where the given window on our left ends if possible,\n but don't make yourself larger than max_size.\n The resize will assure that the new window still contains the old window area\"\"\"\n rofs = self.ofs - window.ofs_end()\n nsize = rofs + self.size\n rofs -= nsize - min(nsize, max_size)\n self.ofs -= rofs\n self.size += rofs\n\n def extend_right_to(self, window, max_size):\n \"\"\"Adjust the size to make our window end where the right window begins, but don't\n get larger than max_size\"\"\"\n self.size = min(self.size + (window.ofs - self.ofs_end()), max_size)\n\n\nclass MapRegion:\n\n \"\"\"Defines a mapped region of memory, aligned to pagesizes\n\n **Note:** deallocates used region automatically on destruction\"\"\"\n __slots__ = [\n '_b', # beginning of mapping\n '_mf', # mapped memory chunk (as returned by mmap)\n '_uc', # total amount of usages\n '_size', # cached size of our memory map\n '__weakref__'\n ]\n\n #{ Configuration\n #} END configuration\n\n def __init__(self, path_or_fd, ofs, size, flags=0):\n \"\"\"Initialize a region, allocate the memory map\n :param path_or_fd: path to the file to map, or the opened file descriptor\n :param ofs: **aligned** offset into the file to be mapped\n :param size: if size is larger then the file on disk, the whole file will be\n allocated the the size automatically adjusted\n :param flags: additional flags to be given when opening the file.\n :raise Exception: if no memory can be allocated\"\"\"\n self._b = ofs\n self._size = 0\n self._uc = 0\n\n if isinstance(path_or_fd, int):\n fd = path_or_fd\n else:\n fd = os.open(path_or_fd, os.O_RDONLY | getattr(os, 'O_BINARY', 0) | flags)\n # END handle fd\n\n try:\n kwargs = dict(access=ACCESS_READ, offset=ofs)\n corrected_size = size\n sizeofs = ofs\n\n # have to correct size, otherwise (instead of the c version) it will\n # bark that the size is too large ... many extra file accesses because\n # if this ... argh !\n actual_size = min(os.fstat(fd).st_size - sizeofs, corrected_size)\n self._mf = mmap(fd, actual_size, **kwargs)\n # END handle memory mode\n\n self._size = len(self._mf)\n finally:\n if isinstance(path_or_fd, str):\n os.close(fd)\n # END only close it if we opened it\n # END close file handle\n # We assume the first one to use us keeps us around\n self.increment_client_count()\n\n def __repr__(self):\n return \"MapRegion<%i, %i>\" % (self._b, self.size())\n\n #{ Interface\n\n def buffer(self):\n \"\"\":return: a buffer containing the memory\"\"\"\n return self._mf\n\n def map(self):\n \"\"\":return: a memory map containing the memory\"\"\"\n return self._mf\n\n def ofs_begin(self):\n \"\"\":return: absolute byte offset to the first byte of the mapping\"\"\"\n return self._b\n\n def size(self):\n \"\"\":return: total size of the mapped region in bytes\"\"\"\n return self._size\n\n def ofs_end(self):\n \"\"\":return: Absolute offset to one byte beyond the mapping into the file\"\"\"\n return self._b + self._size\n\n def includes_ofs(self, ofs):\n \"\"\":return: True if the given offset can be read in our mapped region\"\"\"\n return self._b <= ofs < self._b + self._size\n\n def client_count(self):\n \"\"\":return: number of clients currently using this region\"\"\"\n return self._uc\n\n def increment_client_count(self, ofs = 1):\n \"\"\"Adjust the usage count by the given positive or negative offset.\n If usage count equals 0, we will auto-release our resources\n :return: True if we released resources, False otherwise. In the latter case, we can still be used\"\"\"\n self._uc += ofs\n assert self._uc > -1, \"Increments must match decrements, usage counter negative: %i\" % self._uc\n\n if self.client_count() == 0:\n self.release()\n return True\n else:\n return False\n # end handle release\n\n def release(self):\n \"\"\"Release all resources this instance might hold. Must only be called if there usage_count() is zero\"\"\"\n self._mf.close()\n\n #} END interface\n\n\nclass MapRegionList(list):\n\n \"\"\"List of MapRegion instances associating a path with a list of regions.\"\"\"\n __slots__ = (\n '_path_or_fd', # path or file descriptor which is mapped by all our regions\n '_file_size' # total size of the file we map\n )\n\n def __new__(cls, path):\n return super().__new__(cls)\n\n def __init__(self, path_or_fd):\n self._path_or_fd = path_or_fd\n self._file_size = None\n\n def path_or_fd(self):\n \"\"\":return: path or file descriptor we are attached to\"\"\"\n return self._path_or_fd\n\n def file_size(self):\n \"\"\":return: size of file we manager\"\"\"\n if self._file_size is None:\n if isinstance(self._path_or_fd, str):\n self._file_size = os.stat(self._path_or_fd).st_size\n else:\n self._file_size = os.fstat(self._path_or_fd).st_size\n # END handle path type\n # END update file size\n return self._file_size\n\n#} END utility classes\n\n[end of smmap/util.py]","filename":"smmap/util.py","id":"12"},{"content":"\"\"\"Initialize the smmap package\"\"\"\n\n__author__ = \"Sebastian Thiel\"\n__contact__ = \"byronimo@gmail.com\"\n__homepage__ = \"https://github.com/gitpython-developers/smmap\"\nversion_info = (5, 0, 2)\n__version__ = '.'.join(str(i) for i in version_info)\n\n# make everything available in root package for convenience\nfrom .mman import *\nfrom .buf import *\n\n[end of smmap/__init__.py]","filename":"smmap/__init__.py","id":"13"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = build\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\n\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\t-rm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make all-pdf' or \\`make all-ps' in that directory to\" \\\n\t \"run these through (pdf)latex.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\n[end of doc/Makefile]","filename":"doc/Makefile","id":"14"},{"content":"@ECHO OFF\n\nREM Command file for Sphinx documentation\n\nset SPHINXBUILD=sphinx-build\nset BUILDDIR=build\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\nif NOT \"%PAPER%\" == \"\" (\n\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\n)\n\nif \"%1\" == \"\" goto help\n\nif \"%1\" == \"help\" (\n\t:help\n\techo.Please use `make ^<target^>` where ^<target^> is one of\n\techo. html to make standalone HTML files\n\techo. dirhtml to make HTML files named index.html in directories\n\techo. pickle to make pickle files\n\techo. json to make JSON files\n\techo. htmlhelp to make HTML files and a HTML help project\n\techo. qthelp to make HTML files and a qthelp project\n\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\n\techo. changes to make an overview over all changed/added/deprecated items\n\techo. linkcheck to check all external links for integrity\n\techo. doctest to run all doctests embedded in the documentation if enabled\n\tgoto end\n)\n\nif \"%1\" == \"clean\" (\n\tfor /d %%i in (%BUILDDIR%\\*) do rmdir /q /s %%i\n\tdel /q /s %BUILDDIR%\\*\n\tgoto end\n)\n\nif \"%1\" == \"html\" (\n\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\n\tgoto end\n)\n\nif \"%1\" == \"dirhtml\" (\n\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\n\tgoto end\n)\n\nif \"%1\" == \"pickle\" (\n\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\n\techo.\n\techo.Build finished; now you can process the pickle files.\n\tgoto end\n)\n\nif \"%1\" == \"json\" (\n\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\n\techo.\n\techo.Build finished; now you can process the JSON files.\n\tgoto end\n)\n\nif \"%1\" == \"htmlhelp\" (\n\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\n\techo.\n\techo.Build finished; now you can run HTML Help Workshop with the ^\n.hhp project file in %BUILDDIR%/htmlhelp.\n\tgoto end\n)\n\nif \"%1\" == \"qthelp\" (\n\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\n\techo.\n\techo.Build finished; now you can run \"qcollectiongenerator\" with the ^\n.qhcp project file in %BUILDDIR%/qthelp, like this:\n\techo.^> qcollectiongenerator %BUILDDIR%\\qthelp\\smmap.qhcp\n\techo.To view the help file:\n\techo.^> assistant -collectionFile %BUILDDIR%\\qthelp\\smmap.ghc\n\tgoto end\n)\n\nif \"%1\" == \"latex\" (\n\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\n\techo.\n\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\n\tgoto end\n)\n\nif \"%1\" == \"changes\" (\n\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\n\techo.\n\techo.The overview file is in %BUILDDIR%/changes.\n\tgoto end\n)\n\nif \"%1\" == \"linkcheck\" (\n\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\n\techo.\n\techo.Link check complete; look for any errors in the above output ^\nor in %BUILDDIR%/linkcheck/output.txt.\n\tgoto end\n)\n\nif \"%1\" == \"doctest\" (\n\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\n\techo.\n\techo.Testing of doctests in the sources finished, look at the ^\nresults in %BUILDDIR%/doctest/output.txt.\n\tgoto end\n)\n\n:end\n\n[end of doc/make.bat]","filename":"doc/make.bat","id":"15"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.mman import (\n WindowCursor,\n SlidingWindowMapManager,\n StaticWindowMapManager\n)\nfrom smmap.util import align_to_mmap\n\nfrom random import randint\nfrom time import time\nimport os\nimport sys\nfrom copy import copy\n\n\nclass TestMMan(TestBase):\n\n def test_cursor(self):\n with FileCreator(self.k_window_test_size, \"cursor_test\") as fc:\n man = SlidingWindowMapManager()\n ci = WindowCursor(man) # invalid cursor\n assert not ci.is_valid()\n assert not ci.is_associated()\n assert ci.size() == 0 # this is cached, so we can query it in invalid state\n\n cv = man.make_cursor(fc.path)\n assert not cv.is_valid() # no region mapped yet\n assert cv.is_associated() # but it know where to map it from\n assert cv.file_size() == fc.size\n assert cv.path() == fc.path\n\n # copy module\n cio = copy(cv)\n assert not cio.is_valid() and cio.is_associated()\n\n # assign method\n assert not ci.is_associated()\n ci.assign(cv)\n assert not ci.is_valid() and ci.is_associated()\n\n # unuse non-existing region is fine\n cv.unuse_region()\n cv.unuse_region()\n\n # destruction is fine (even multiple times)\n cv._destroy()\n WindowCursor(man)._destroy()\n\n def test_memory_manager(self):\n slide_man = SlidingWindowMapManager()\n static_man = StaticWindowMapManager()\n\n for man in (static_man, slide_man):\n assert man.num_file_handles() == 0\n assert man.num_open_files() == 0\n winsize_cmp_val = 0\n if isinstance(man, StaticWindowMapManager):\n winsize_cmp_val = -1\n # END handle window size\n assert man.window_size() > winsize_cmp_val\n assert man.mapped_memory_size() == 0\n assert man.max_mapped_memory_size() > 0\n\n # collection doesn't raise in 'any' mode\n man._collect_lru_region(0)\n # doesn't raise if we are within the limit\n man._collect_lru_region(10)\n\n # doesn't fail if we over-allocate\n assert man._collect_lru_region(sys.maxsize) == 0\n\n # use a region, verify most basic functionality\n with FileCreator(self.k_window_test_size, \"manager_test\") as fc:\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n for item in (fc.path, fd):\n c = man.make_cursor(item)\n assert c.path_or_fd() is item\n assert c.use_region(10, 10).is_valid()\n assert c.ofs_begin() == 10\n assert c.size() == 10\n with open(fc.path, 'rb') as fp:\n assert c.buffer()[:] == fp.read(20)[10:]\n\n if isinstance(item, int):\n self.assertRaises(ValueError, c.path)\n else:\n self.assertRaises(ValueError, c.fd)\n # END handle value error\n # END for each input\n finally:\n os.close(fd)\n # END for each manasger type\n\n def test_memman_operation(self):\n # test more access, force it to actually unmap regions\n with FileCreator(self.k_window_test_size, \"manager_operation_test\") as fc:\n with open(fc.path, 'rb') as fp:\n data = fp.read()\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n max_num_handles = 15\n # small_size =\n for mtype, args in ((StaticWindowMapManager, (0, fc.size // 3, max_num_handles)),\n (SlidingWindowMapManager, (fc.size // 100, fc.size // 3, max_num_handles)),):\n for item in (fc.path, fd):\n assert len(data) == fc.size\n\n # small windows, a reasonable max memory. Not too many regions at once\n man = mtype(window_size=args[0], max_memory_size=args[1], max_open_handles=args[2])\n c = man.make_cursor(item)\n\n # still empty (more about that is tested in test_memory_manager()\n assert man.num_open_files() == 0\n assert man.mapped_memory_size() == 0\n\n base_offset = 5000\n # window size is 0 for static managers, hence size will be 0. We take that into consideration\n size = man.window_size() // 2\n assert c.use_region(base_offset, size).is_valid()\n rr = c.region()\n assert rr.client_count() == 2 # the manager and the cursor and us\n\n assert man.num_open_files() == 1\n assert man.num_file_handles() == 1\n assert man.mapped_memory_size() == rr.size()\n\n # assert c.size() == size # the cursor may overallocate in its static version\n assert c.ofs_begin() == base_offset\n assert rr.ofs_begin() == 0 # it was aligned and expanded\n if man.window_size():\n # but isn't larger than the max window (aligned)\n assert rr.size() == align_to_mmap(man.window_size(), True)\n else:\n assert rr.size() == fc.size\n # END ignore static managers which dont use windows and are aligned to file boundaries\n\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\n\n # obtain second window, which spans the first part of the file - it is a still the same window\n nsize = (size or fc.size) - 10\n assert c.use_region(0, nsize).is_valid()\n assert c.region() == rr\n assert man.num_file_handles() == 1\n assert c.size() == nsize\n assert c.ofs_begin() == 0\n assert c.buffer()[:] == data[:nsize]\n\n # map some part at the end, our requested size cannot be kept\n overshoot = 4000\n base_offset = fc.size - (size or c.size()) + overshoot\n assert c.use_region(base_offset, size).is_valid()\n if man.window_size():\n assert man.num_file_handles() == 2\n assert c.size() < size\n assert c.region() is not rr # old region is still available, but has not cursor ref anymore\n assert rr.client_count() == 1 # only held by manager\n else:\n assert c.size() < fc.size\n # END ignore static managers which only have one handle per file\n rr = c.region()\n assert rr.client_count() == 2 # manager + cursor\n assert rr.ofs_begin() < c.ofs_begin() # it should have extended itself to the left\n assert rr.ofs_end() <= fc.size # it cannot be larger than the file\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\n\n # unising a region makes the cursor invalid\n c.unuse_region()\n assert not c.is_valid()\n if man.window_size():\n # but doesn't change anything regarding the handle count - we cache it and only\n # remove mapped regions if we have to\n assert man.num_file_handles() == 2\n # END ignore this for static managers\n\n # iterate through the windows, verify data contents\n # this will trigger map collection after a while\n max_random_accesses = 5000\n num_random_accesses = max_random_accesses\n memory_read = 0\n st = time()\n\n # cache everything to get some more performance\n includes_ofs = c.includes_ofs\n max_mapped_memory_size = man.max_mapped_memory_size()\n max_file_handles = man.max_file_handles()\n mapped_memory_size = man.mapped_memory_size\n num_file_handles = man.num_file_handles\n while num_random_accesses:\n num_random_accesses -= 1\n base_offset = randint(0, fc.size - 1)\n\n # precondition\n if man.window_size():\n assert max_mapped_memory_size >= mapped_memory_size()\n # END statistics will overshoot, which is fine\n assert max_file_handles >= num_file_handles()\n assert c.use_region(base_offset, (size or c.size())).is_valid()\n csize = c.size()\n assert c.buffer()[:] == data[base_offset:base_offset + csize]\n memory_read += csize\n\n assert includes_ofs(base_offset)\n assert includes_ofs(base_offset + csize - 1)\n assert not includes_ofs(base_offset + csize)\n # END while we should do an access\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\n mb = float(1000 * 1000)\n print(\"%s: Read %i mb of memory with %i random on cursor initialized with %s accesses in %fs (%f mb/s)\\n\"\n % (mtype, memory_read / mb, max_random_accesses, type(item), elapsed, (memory_read / mb) / elapsed),\n file=sys.stderr)\n\n # an offset as large as the size doesn't work !\n assert not c.use_region(fc.size, size).is_valid()\n\n # collection - it should be able to collect all\n assert man.num_file_handles()\n assert man.collect()\n assert man.num_file_handles() == 0\n # END for each item\n # END for each manager type\n finally:\n os.close(fd)\n\n[end of smmap/test/test_mman.py]","filename":"smmap/test/test_mman.py","id":"16"},{"content":"\"\"\"Provide base classes for the test system\"\"\"\nfrom unittest import TestCase\nimport os\nimport tempfile\n\n__all__ = ['TestBase', 'FileCreator']\n\n\n#{ Utilities\n\nclass FileCreator:\n\n \"\"\"A instance which creates a temporary file with a prefix and a given size\n and provides this info to the user.\n Once it gets deleted, it will remove the temporary file as well.\"\"\"\n __slots__ = (\"_size\", \"_path\")\n\n def __init__(self, size, prefix=''):\n assert size, \"Require size to be larger 0\"\n\n self._size = size\n\n with tempfile.NamedTemporaryFile(\"wb\", prefix=prefix, delete=False) as file:\n self._path = file.name\n file.seek(size - 1)\n file.write(b'1')\n\n assert os.path.getsize(self.path) == size\n\n def __del__(self):\n try:\n os.remove(self.path)\n except OSError:\n pass\n # END exception handling\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self.__del__()\n\n @property\n def path(self):\n return self._path\n\n @property\n def size(self):\n return self._size\n\n#} END utilities\n\n\nclass TestBase(TestCase):\n\n \"\"\"Foundation used by all tests\"\"\"\n\n #{ Configuration\n k_window_test_size = 1000 * 1000 * 8 + 5195\n #} END configuration\n\n #{ Overrides\n @classmethod\n def setUpAll(cls):\n # nothing for now\n pass\n\n # END overrides\n\n #{ Interface\n\n #} END interface\n\n[end of smmap/test/lib.py]","filename":"smmap/test/lib.py","id":"17"},{"content":"[end of smmap/test/__init__.py]","filename":"smmap/test/__init__.py","id":"18"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.mman import (\n SlidingWindowMapManager,\n StaticWindowMapManager\n)\nfrom smmap.buf import SlidingWindowMapBuffer\n\nfrom random import randint\nfrom time import time\nimport sys\nimport os\n\n\nman_optimal = SlidingWindowMapManager()\nman_worst_case = SlidingWindowMapManager(\n window_size=TestBase.k_window_test_size // 100,\n max_memory_size=TestBase.k_window_test_size // 3,\n max_open_handles=15)\nstatic_man = StaticWindowMapManager()\n\n\nclass TestBuf(TestBase):\n\n def test_basics(self):\n with FileCreator(self.k_window_test_size, \"buffer_test\") as fc:\n\n # invalid paths fail upon construction\n c = man_optimal.make_cursor(fc.path)\n self.assertRaises(ValueError, SlidingWindowMapBuffer, type(c)()) # invalid cursor\n self.assertRaises(ValueError, SlidingWindowMapBuffer, c, fc.size) # offset too large\n\n buf = SlidingWindowMapBuffer() # can create uninitialized buffers\n assert buf.cursor() is None\n\n # can call end access any time\n buf.end_access()\n buf.end_access()\n assert len(buf) == 0\n\n # begin access can revive it, if the offset is suitable\n offset = 100\n assert buf.begin_access(c, fc.size) == False\n assert buf.begin_access(c, offset) == True\n assert len(buf) == fc.size - offset\n assert buf.cursor().is_valid()\n\n # empty begin access keeps it valid on the same path, but alters the offset\n assert buf.begin_access() == True\n assert len(buf) == fc.size\n assert buf.cursor().is_valid()\n\n # simple access\n with open(fc.path, 'rb') as fp:\n data = fp.read()\n assert data[offset] == buf[0]\n assert data[offset:offset * 2] == buf[0:offset]\n\n # negative indices, partial slices\n assert buf[-1] == buf[len(buf) - 1]\n assert buf[-10:] == buf[len(buf) - 10:len(buf)]\n\n # end access makes its cursor invalid\n buf.end_access()\n assert not buf.cursor().is_valid()\n assert buf.cursor().is_associated() # but it remains associated\n\n # an empty begin access fixes it up again\n assert buf.begin_access() == True and buf.cursor().is_valid()\n del(buf) # ends access automatically\n del(c)\n\n assert man_optimal.num_file_handles() == 1\n\n # PERFORMANCE\n # blast away with random access and a full mapping - we don't want to\n # exaggerate the manager's overhead, but measure the buffer overhead\n # We do it once with an optimal setting, and with a worse manager which\n # will produce small mappings only !\n max_num_accesses = 100\n fd = os.open(fc.path, os.O_RDONLY)\n for item in (fc.path, fd):\n for manager, man_id in ((man_optimal, 'optimal'),\n (man_worst_case, 'worst case'),\n (static_man, 'static optimal')):\n buf = SlidingWindowMapBuffer(manager.make_cursor(item))\n assert manager.num_file_handles() == 1\n for access_mode in range(2): # single, multi\n num_accesses_left = max_num_accesses\n num_bytes = 0\n fsize = fc.size\n\n st = time()\n buf.begin_access()\n while num_accesses_left:\n num_accesses_left -= 1\n if access_mode: # multi\n ofs_start = randint(0, fsize)\n ofs_end = randint(ofs_start, fsize)\n d = buf[ofs_start:ofs_end]\n assert len(d) == ofs_end - ofs_start\n assert d == data[ofs_start:ofs_end]\n num_bytes += len(d)\n del d\n else:\n pos = randint(0, fsize)\n assert buf[pos] == data[pos]\n num_bytes += 1\n # END handle mode\n # END handle num accesses\n\n buf.end_access()\n assert manager.num_file_handles()\n assert manager.collect()\n assert manager.num_file_handles() == 0\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\n mb = float(1000 * 1000)\n mode_str = (access_mode and \"slice\") or \"single byte\"\n print(\"%s: Made %i random %s accesses to buffer created from %s reading a total of %f mb in %f s (%f mb/s)\"\n % (man_id, max_num_accesses, mode_str, type(item), num_bytes / mb, elapsed, (num_bytes / mb) / elapsed),\n file=sys.stderr)\n # END handle access mode\n del buf\n # END for each manager\n # END for each input\n os.close(fd)\n\n[end of smmap/test/test_buf.py]","filename":"smmap/test/test_buf.py","id":"19"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.util import (\n MapWindow,\n MapRegion,\n MapRegionList,\n ALLOCATIONGRANULARITY,\n is_64_bit,\n align_to_mmap\n)\n\nimport os\nimport sys\n\n\nclass TestMMan(TestBase):\n\n def test_window(self):\n wl = MapWindow(0, 1) # left\n wc = MapWindow(1, 1) # center\n wc2 = MapWindow(10, 5) # another center\n wr = MapWindow(8000, 50) # right\n\n assert wl.ofs_end() == 1\n assert wc.ofs_end() == 2\n assert wr.ofs_end() == 8050\n\n # extension does nothing if already in place\n maxsize = 100\n wc.extend_left_to(wl, maxsize)\n assert wc.ofs == 1 and wc.size == 1\n wl.extend_right_to(wc, maxsize)\n wl.extend_right_to(wc, maxsize)\n assert wl.ofs == 0 and wl.size == 1\n\n # an actual left extension\n pofs_end = wc2.ofs_end()\n wc2.extend_left_to(wc, maxsize)\n assert wc2.ofs == wc.ofs_end() and pofs_end == wc2.ofs_end()\n\n # respects maxsize\n wc.extend_right_to(wr, maxsize)\n assert wc.ofs == 1 and wc.size == maxsize\n wc.extend_right_to(wr, maxsize)\n assert wc.ofs == 1 and wc.size == maxsize\n\n # without maxsize\n wc.extend_right_to(wr, sys.maxsize)\n assert wc.ofs_end() == wr.ofs and wc.ofs == 1\n\n # extend left\n wr.extend_left_to(wc2, maxsize)\n wr.extend_left_to(wc2, maxsize)\n assert wr.size == maxsize\n\n wr.extend_left_to(wc2, sys.maxsize)\n assert wr.ofs == wc2.ofs_end()\n\n wc.align()\n assert wc.ofs == 0 and wc.size == align_to_mmap(wc.size, True)\n\n def test_region(self):\n with FileCreator(self.k_window_test_size, \"window_test\") as fc:\n half_size = fc.size // 2\n rofs = align_to_mmap(4200, False)\n rfull = MapRegion(fc.path, 0, fc.size)\n rhalfofs = MapRegion(fc.path, rofs, fc.size)\n rhalfsize = MapRegion(fc.path, 0, half_size)\n\n # offsets\n assert rfull.ofs_begin() == 0 and rfull.size() == fc.size\n assert rfull.ofs_end() == fc.size # if this method works, it works always\n\n assert rhalfofs.ofs_begin() == rofs and rhalfofs.size() == fc.size - rofs\n assert rhalfsize.ofs_begin() == 0 and rhalfsize.size() == half_size\n\n assert rfull.includes_ofs(0) and rfull.includes_ofs(fc.size - 1) and rfull.includes_ofs(half_size)\n assert not rfull.includes_ofs(-1) and not rfull.includes_ofs(sys.maxsize)\n\n # auto-refcount\n assert rfull.client_count() == 1\n rfull2 = rfull\n assert rfull.client_count() == 1, \"no auto-counting\"\n\n # window constructor\n w = MapWindow.from_region(rfull)\n assert w.ofs == rfull.ofs_begin() and w.ofs_end() == rfull.ofs_end()\n\n def test_region_list(self):\n with FileCreator(100, \"sample_file\") as fc:\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n for item in (fc.path, fd):\n ml = MapRegionList(item)\n\n assert len(ml) == 0\n assert ml.path_or_fd() == item\n assert ml.file_size() == fc.size\n finally:\n os.close(fd)\n\n def test_util(self):\n assert isinstance(is_64_bit(), bool) # just call it\n assert align_to_mmap(1, False) == 0\n assert align_to_mmap(1, True) == ALLOCATIONGRANULARITY\n\n[end of smmap/test/test_util.py]","filename":"smmap/test/test_util.py","id":"20"},{"content":"from .lib import TestBase\n\n\nclass TestTutorial(TestBase):\n\n def test_example(self):\n # Memory Managers\n ##################\n import smmap\n # This instance should be globally available in your application\n # It is configured to be well suitable for 32-bit or 64 bit applications.\n mman = smmap.SlidingWindowMapManager()\n\n # the manager provides much useful information about its current state\n # like the amount of open file handles or the amount of mapped memory\n assert mman.num_file_handles() == 0\n assert mman.mapped_memory_size() == 0\n # and many more ...\n\n # Cursors\n ##########\n import smmap.test.lib\n with smmap.test.lib.FileCreator(1024 * 1024 * 8, \"test_file\") as fc:\n # obtain a cursor to access some file.\n c = mman.make_cursor(fc.path)\n\n # the cursor is now associated with the file, but not yet usable\n assert c.is_associated()\n assert not c.is_valid()\n\n # before you can use the cursor, you have to specify a window you want to\n # access. The following just says you want as much data as possible starting\n # from offset 0.\n # To be sure your region could be mapped, query for validity\n assert c.use_region().is_valid() # use_region returns self\n\n # once a region was mapped, you must query its dimension regularly\n # to assure you don't try to access its buffer out of its bounds\n assert c.size()\n c.buffer()[0] # first byte\n c.buffer()[1:10] # first 9 bytes\n c.buffer()[c.size() - 1] # last byte\n\n # you can query absolute offsets, and check whether an offset is included\n # in the cursor's data.\n assert c.ofs_begin() < c.ofs_end()\n assert c.includes_ofs(100)\n\n # If you are over out of bounds with one of your region requests, the\n # cursor will be come invalid. It cannot be used in that state\n assert not c.use_region(fc.size, 100).is_valid()\n # map as much as possible after skipping the first 100 bytes\n assert c.use_region(100).is_valid()\n\n # You can explicitly free cursor resources by unusing the cursor's region\n c.unuse_region()\n assert not c.is_valid()\n\n # Buffers\n #########\n # Create a default buffer which can operate on the whole file\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\n\n # you can use it right away\n assert buf.cursor().is_valid()\n\n buf[0] # access the first byte\n buf[-1] # access the last ten bytes on the file\n buf[-10:] # access the last ten bytes\n\n # If you want to keep the instance between different accesses, use the\n # dedicated methods\n buf.end_access()\n assert not buf.cursor().is_valid() # you cannot use the buffer anymore\n assert buf.begin_access(offset=10) # start using the buffer at an offset\n\n[end of smmap/test/test_tutorial.py]","filename":"smmap/test/test_tutorial.py","id":"21"},{"content":".. smmap documentation master file, created by\n sphinx-quickstart on Wed Jun 8 15:14:25 2011.\n You can adapt this file completely to your liking, but it should at least\n contain the root `toctree` directive.\n\nWelcome to smmap's documentation!\n=================================\n**smmap** is a pure python implementation of a sliding memory map to help unifying memory mapped access on 32 and 64 bit systems and to help managing resources more efficiently.\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n \n intro\n tutorial\n api\n changes\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of doc/source/index.rst]","filename":"doc/source/index.rst","id":"22"},{"content":"###########\nMotivation\n###########\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\n\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\n\n########\nOverview\n########\n\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\n\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\n\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\n\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\n\n#############\nPrerequisites\n#############\n* Python 3.7+\n* OSX, Windows or Linux\n\nThe package was tested on all of the previously mentioned configurations.\n\n###########\nLimitations\n###########\n* The memory access is read-only by design.\n\n################\nInstalling smmap\n################\nIts easiest to install smmap using the *pip* program::\n \n $ pip install smmap\n \nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\n\nIf you have downloaded the source archive, the package can be installed by running the ``setup.py`` script::\n \n $ python setup.py install\n\nIt is advised to have a look at the :ref:`Usage Guide <tutorial-label>` for a brief introduction on the different database implementations.\n\n##################\nHomepage and Links\n##################\nThe project is home on github at `https://github.com/gitpython-developers/smmap <https://github.com/gitpython-developers/smmap>`_.\n\nThe latest source can be cloned from github as well:\n\n * git://github.com/gitpython-developers/smmap.git\n \n \nFor support, please use the git-python mailing list:\n\n * http://groups.google.com/group/git-python\n \n\nIssues can be filed on github:\n\n * https://github.com/gitpython-developers/smmap/issues\n \n###################\nLicense Information\n###################\n*smmap* is licensed under the New BSD License.\n\n.. _pip: http://www.pip-installer.org/en/latest/\n\n[end of doc/source/intro.rst]","filename":"doc/source/intro.rst","id":"23"},{"content":"#\n# smmap documentation build configuration file, created by\n# sphinx-quickstart on Wed Jun 8 15:14:25 2011.\n#\n# This file is execfile()d with the current directory set to its containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.append(os.path.abspath('../../'))\n\n# -- General configuration -----------------------------------------------------\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['.templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'smmap'\ncopyright = '2011, Sebastian Thiel'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.8.0'\n# The full version, including alpha/beta/rc tags.\nrelease = '0.8.0'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of documents that shouldn't be included in the build.\n#unused_docs = []\n\n# List of directories, relative to source directory, that shouldn't be searched\n# for source files.\nexclude_trees = []\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. Major themes that come with\n# Sphinx are currently 'default' and 'sphinxdoc'.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['.static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_use_modindex = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# If nonempty, this is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = ''\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'smmapdoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\n# The paper size ('letter' or 'a4').\n#latex_paper_size = 'letter'\n\n# The font size ('10pt', '11pt' or '12pt').\n#latex_font_size = '10pt'\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'smmap.tex', 'smmap Documentation',\n 'Sebastian Thiel', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# Additional stuff for the LaTeX preamble.\n#latex_preamble = ''\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_use_modindex = True\n\n[end of doc/source/conf.py]","filename":"doc/source/conf.py","id":"24"},{"content":".. _tutorial-label:\n\n###########\nUsage Guide\n###########\nThis text briefly introduces you to the basic design decisions and accompanying classes.\n\n******\nDesign\n******\nPer application, there is *MemoryManager* which is held as static instance and used throughout the application. It can be configured to keep your resources within certain limits.\n\nTo access mapped regions, you require a cursor. Cursors point to exactly one file and serve as handles into it. As long as it exists, the respective memory region will remain available.\n\nFor convenience, a buffer implementation is provided which handles cursors and resource allocation behind its simple buffer like interface.\n\n***************\nMemory Managers\n***************\nThere are two types of memory managers, one uses *static* windows, the other one uses *sliding* windows. A window is a region of a file mapped into memory. Although the names might be somewhat misleading as technically windows are always static, the *sliding* version will allocate relatively small windows whereas the *static* version will always map the whole file.\n\nThe *static* manager does nothing more than keeping a client count on the respective memory maps which always map the whole file, which allows to make some assumptions that can lead to simplified data access and increased performance, but reduces the compatibility to 32 bit systems or giant files.\n\nThe *sliding* memory manager therefore should be the default manager when preparing an application for handling huge amounts of data on 32 bit and 64 bit platforms::\n\n import smmap\n # This instance should be globally available in your application\n # It is configured to be well suitable for 32-bit or 64 bit applications.\n mman = smmap.SlidingWindowMapManager()\n \n # the manager provides much useful information about its current state\n # like the amount of open file handles or the amount of mapped memory\n mman.num_file_handles()\n mman.mapped_memory_size()\n # and many more ...\n\n\nCursors\n*******\n*Cursors* are handles that point onto a window, i.e. a region of a file mapped into memory. From them you may obtain a buffer through which the data of that window can actually be accessed::\n\n import smmap.test.lib\n fc = smmap.test.lib.FileCreator(1024*1024*8, \"test_file\")\n \n # obtain a cursor to access some file.\n c = mman.make_cursor(fc.path)\n \n # the cursor is now associated with the file, but not yet usable\n assert c.is_associated()\n assert not c.is_valid()\n \n # before you can use the cursor, you have to specify a window you want to \n # access. The following just says you want as much data as possible starting\n # from offset 0.\n # To be sure your region could be mapped, query for validity\n assert c.use_region().is_valid()\t\t# use_region returns self\n \n # once a region was mapped, you must query its dimension regularly\n # to assure you don't try to access its buffer out of its bounds\n assert c.size()\n c.buffer()[0]\t\t\t# first byte\n c.buffer()[1:10]\t\t\t# first 9 bytes\n c.buffer()[c.size()-1] \t# last byte\n \n # its recommended not to create big slices when feeding the buffer\n # into consumers (e.g. struct or zlib). \n # Instead, either give the buffer directly, or use pythons buffer command.\n buffer(c.buffer(), 1, 9)\t# first 9 bytes without copying them\n \n # you can query absolute offsets, and check whether an offset is included\n # in the cursor's data.\n assert c.ofs_begin() < c.ofs_end()\n assert c.includes_ofs(100)\n \n # If you are over out of bounds with one of your region requests, the \n # cursor will be come invalid. It cannot be used in that state\n assert not c.use_region(fc.size, 100).is_valid()\n # map as much as possible after skipping the first 100 bytes\n assert c.use_region(100).is_valid()\n \n # You can explicitly free cursor resources by unusing the cursor's region\n c.unuse_region()\n assert not c.is_valid()\n \n\nNow you would have to write your algorithms around this interface to properly slide through huge amounts of data. \n \nAlternatively you can use a convenience interface.\n\n*******\nBuffers\n*******\nTo make first use easier, at the expense of performance, there is a Buffer implementation which uses a cursor underneath.\n\nWith it, you can access all data in a possibly huge file without having to take care of setting the cursor to different regions yourself::\n\n # Create a default buffer which can operate on the whole file\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\n \n # you can use it right away\n assert buf.cursor().is_valid()\n \n buf[0]\t# access the first byte\n buf[-1]\t# access the last ten bytes on the file\n buf[-10:]# access the last ten bytes\n \n # If you want to keep the instance between different accesses, use the\n # dedicated methods\n buf.end_access()\n assert not buf.cursor().is_valid()\t# you cannot use the buffer anymore\n assert buf.begin_access(offset=10)\t# start using the buffer at an offset\n \n # it will stop using resources automatically once it goes out of scope\n \nDisadvantages\n*************\nBuffers cannot be used in place of strings or maps, hence you have to slice them to have valid input for the sorts of struct and zlib. A slice means a lot of data handling overhead which makes buffers slower compared to using cursors directly. \n\n\n[end of doc/source/tutorial.rst]","filename":"doc/source/tutorial.rst","id":"25"},{"content":"#########\nChangelog\n#########\n\n******\nv5.0.2\n******\n\n- remove a usage of mktemp\n\n******\nv5.0.1\n******\n\n- Added support for Python 3.12\n\n******\nv6.0.0\n******\n\nYANKED\n\n- Dropped support 3.6 and 3.7\n- Declared support for Python 3.11 and 3.12\n\n******\nv5.0.0\n******\n\n- Dropped support 3.5\n- Added support for Python 3.10\n\n******\nv4.0.0\n******\n\n- Dropped support for Python 2.7 and 3.4\n- Added support for Python 3.7, 3.8, and 3.9\n- Removed unused exc.MemoryManagerError and exc.RegionCollectionError\n\n******\nv3.0.5\n******\n\n- Restored Python 2 support removed in v3.0.2\n- Changed release signature key to 27C50E7F590947D7273A741E85194C08421980C9.\n See https://keybase.io/byronbates for proof of ownership.\n\n******\nv3.0.4\n******\n\n- Signed release (with correct key this time)\n\n******\nv3.0.2\n******\n\n- Signed release\n- Switched to GitHub Actions for CI\n\n******\nv3.0.1\n******\n- Switched back to the smmap package name on PyPI and fixed the smmap2 mirror package\n (`#44 <https://github.com/gitpython-developers/smmap/issues/44>`_)\n- Fixed setup.py ``long_description`` rendering\n (`#40 <https://github.com/gitpython-developers/smmap/pull/40>`_)\n\n**********\nv0.9.0\n**********\n- Fixed issue with resources never being freed as mmaps were never closed.\n- Client counting is now done manually, instead of relying on pyton's reference count\n\n**********\nv0.8.5\n**********\n- Fixed Python 3.0-3.3 regression, which also causes smmap to become about 3 times slower depending on the code path. It's related to this bug (http://bugs.python.org/issue15958), which was fixed in python 3.4\n\n**********\nv0.8.4\n**********\n- Fixed Python 3 performance regression\n\n**********\nv0.8.3\n**********\n- Cleaned up code and assured it works sufficiently well with python 3\n\n**********\nv0.8.1\n**********\n- A single bugfix\n\n**********\nv0.8.0 \n**********\n\n- Initial Release\n\n[end of doc/source/changes.rst]","filename":"doc/source/changes.rst","id":"26"},{"content":".. _api-label:\n\n#############\nAPI Reference\n#############\n\n***********************\nMapped Memory Managers\n***********************\n\n.. automodule:: smmap.mman\n :members:\n :undoc-members:\n\n*******\nBuffers\n*******\n\n.. automodule:: smmap.buf\n :members:\n :undoc-members:\n\n*********\nUtilities\n*********\n\n.. automodule:: smmap.util\n :members:\n :undoc-members:\n\n\n\n\n\n\n[end of doc/source/api.rst]","filename":"doc/source/api.rst","id":"27"}],"string":"[\n {\n \"content\": \"Copyright (C) 2010, 2011 Sebastian Thiel and contributors\\nAll rights reserved.\\n\\nRedistribution and use in source and binary forms, with or without \\nmodification, are permitted provided that the following conditions \\nare met:\\n\\n* Redistributions of source code must retain the above copyright \\nnotice, this list of conditions and the following disclaimer.\\n\\n* Redistributions in binary form must reproduce the above copyright \\nnotice, this list of conditions and the following disclaimer in the \\ndocumentation and/or other materials provided with the distribution.\\n\\n* Neither the name of the async project nor the names of \\nits contributors may be used to endorse or promote products derived \\nfrom this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED \\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR \\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING \\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \".PHONY: all clean release force_release\\n\\nall:\\n\\t@grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all\\n\\nclean:\\n\\trm -rf build/ dist/ .eggs/ .tox/\\n\\nforce_release: clean\\n\\t./build-release.sh\\n\\ttwine upload dist/*\\n\\tgit push --tags origin master\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"1\"\n },\n {\n \"content\": \"# Include the license file\\ninclude LICENSE\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[run]\\nsource = smmap\\n\\n; to make nosetests happy\\n[report]\\nomit = \\n\\t*/yaml*\\n\\t*/tests/*\\n */python?.?/*\\n */site-packages/nose/*\\n[end of .coveragerc]\",\n \"filename\": \".coveragerc\",\n \"id\": \"3\"\n },\n {\n \"content\": \"## Motivation\\n\\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\\n\\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\\n\\n\\n## Limitations\\n\\n* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.\\n* The memory access is read-only by design.\\n\\n\\n## Overview\\n\\n\\n\\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\\n\\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\\n\\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\\n\\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\\n\\n\\n\\n## Prerequisites\\n\\n* Python 3.7+\\n* OSX, Windows or Linux\\n\\nThe package was tested on all of the previously mentioned configurations.\\n\\n## Installing smmap\\n\\n[](https://readthedocs.org/projects/smmap/?badge=latest)\\n\\nIts easiest to install smmap using the [pip](http://www.pip-installer.org/en/latest) program:\\n\\n```bash\\n$ pip install smmap\\n```\\n\\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\\n\\nIf you have downloaded the source archive, the package can be installed by running the `setup.py` script:\\n\\n```bash\\n$ python setup.py install\\n```\\n\\nIt is advised to have a look at the **Usage Guide** for a brief introduction on the different database implementations.\\n\\n\\n\\n## Homepage and Links\\n\\nThe project is home on github at https://github.com/gitpython-developers/smmap .\\n\\nThe latest source can be cloned from github as well:\\n\\n* git://github.com/gitpython-developers/smmap.git\\n\\n\\nFor support, please use the git-python mailing list:\\n\\n* http://groups.google.com/group/git-python\\n\\n\\nIssues can be filed on github:\\n\\n* https://github.com/gitpython-developers/smmap/issues\\n\\nA link to the pypi page related to this repository:\\n\\n* https://pypi.org/project/smmap/\\n\\n\\n## License Information\\n\\n*smmap* is licensed under the New BSD License.\\n\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"#!/usr/bin/env python\\nimport os\\n\\ntry:\\n from setuptools import setup, find_packages\\nexcept ImportError:\\n from ez_setup import use_setuptools\\n use_setuptools()\\n from setuptools import setup, find_packages\\n\\nimport smmap\\n\\nif os.path.exists(\\\"README.md\\\"):\\n long_description = open('README.md', encoding=\\\"utf-8\\\").read().replace('\\\\r\\\\n', '\\\\n')\\nelse:\\n long_description = \\\"See https://github.com/gitpython-developers/smmap\\\"\\n\\nsetup(\\n name=\\\"smmap\\\",\\n version=smmap.__version__,\\n description=\\\"A pure Python implementation of a sliding window memory map manager\\\",\\n author=smmap.__author__,\\n author_email=smmap.__contact__,\\n url=smmap.__homepage__,\\n platforms=[\\\"any\\\"],\\n license=\\\"BSD-3-Clause\\\",\\n packages=find_packages(),\\n zip_safe=True,\\n python_requires=\\\">=3.7\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: Microsoft :: Windows\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.7\\\",\\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 \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: 3 :: Only\\\",\\n ],\\n long_description=long_description,\\n long_description_content_type='text/markdown',\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# Tox (http://tox.testrun.org/) is a tool for running tests\\n# in multiple virtualenvs. This configuration file will run the\\n# test suite on all supported python versions. To use it, \\\"pip install tox\\\"\\n# and then run \\\"tox\\\" from this directory.\\n\\n[tox]\\nenvlist = flake8, py{37, 38, 39, 310, 311, 312}\\n\\n[testenv]\\ncommands = {envpython} -m pytest --cov smmap --cov-report xml {posargs}\\ndeps =\\n pytest\\n pytest-cov\\n\\n[testenv:flake8]\\ncommands = flake8 {posargs}\\ndeps = flake8\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"6\"\n },\n {\n \"content\": \"[flake8]\\nexclude = .tox,.venv,build,dist,doc\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"7\"\n },\n {\n \"content\": \"#!/bin/bash\\n#\\n# This script builds a release. If run in a venv, it auto-installs its tools.\\n# You may want to run \\\"make release\\\" instead of running this script directly.\\n\\nset -eEu\\n\\nfunction release_with() {\\n $1 -m build --sdist --wheel\\n}\\n\\nif test -n \\\"${VIRTUAL_ENV:-}\\\"; then\\n deps=(build twine) # Install twine along with build, as we need it later.\\n echo \\\"Virtual environment detected. Adding packages: ${deps[*]}\\\"\\n pip install --quiet --upgrade \\\"${deps[@]}\\\"\\n echo 'Starting the build.'\\n release_with python\\nelse\\n function suggest_venv() {\\n venv_cmd='python -m venv env && source env/bin/activate'\\n printf \\\"HELP: To avoid this error, use a virtual-env with '%s' instead.\\\\n\\\" \\\"$venv_cmd\\\"\\n }\\n trap suggest_venv ERR # This keeps the original exit (error) code.\\n echo 'Starting the build.'\\n release_with python3 # Outside a venv, use python3.\\nfi\\n\\n[end of build-release.sh]\",\n \"filename\": \"build-release.sh\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# Security Policy\\n\\nSee [GitPython](https://github.com/gitpython-developers/GitPython/blob/main/SECURITY.md). Vulnerabilities found in `smmap` can be reported there.\\n\\n[end of SECURITY.md]\",\n \"filename\": \"SECURITY.md\",\n \"id\": \"9\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\\\"\\\"\\\"\\nfrom .util import (\\n MapWindow,\\n MapRegion,\\n MapRegionList,\\n is_64_bit,\\n)\\n\\nimport sys\\nfrom functools import reduce\\n\\n__all__ = [\\\"StaticWindowMapManager\\\", \\\"SlidingWindowMapManager\\\", \\\"WindowCursor\\\"]\\n#{ Utilities\\n\\n#}END utilities\\n\\n\\nclass WindowCursor:\\n\\n \\\"\\\"\\\"\\n Pointer into the mapped region of the memory manager, keeping the map\\n alive until it is destroyed and no other client uses it.\\n\\n Cursors should not be created manually, but are instead returned by the SlidingWindowMapManager\\n\\n **Note:**: The current implementation is suited for static and sliding window managers, but it also means\\n that it must be suited for the somewhat quite different sliding manager. It could be improved, but\\n I see no real need to do so.\\\"\\\"\\\"\\n __slots__ = (\\n '_manager', # the manager keeping all file regions\\n '_rlist', # a regions list with regions for our file\\n '_region', # our current class:`MapRegion` or None\\n '_ofs', # relative offset from the actually mapped area to our start area\\n '_size' # maximum size we should provide\\n )\\n\\n def __init__(self, manager=None, regions=None):\\n self._manager = manager\\n self._rlist = regions\\n self._region = None\\n self._ofs = 0\\n self._size = 0\\n\\n def __del__(self):\\n self._destroy()\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self._destroy()\\n\\n def _destroy(self):\\n \\\"\\\"\\\"Destruction code to decrement counters\\\"\\\"\\\"\\n self.unuse_region()\\n\\n if self._rlist is not None:\\n # Actual client count, which doesn't include the reference kept by the manager, nor ours\\n # as we are about to be deleted\\n try:\\n if len(self._rlist) == 0:\\n # Free all resources associated with the mapped file\\n self._manager._fdict.pop(self._rlist.path_or_fd())\\n # END remove regions list from manager\\n except (TypeError, KeyError):\\n # sometimes, during shutdown, getrefcount is None. Its possible\\n # to re-import it, however, its probably better to just ignore\\n # this python problem (for now).\\n # The next step is to get rid of the error prone getrefcount altogether.\\n pass\\n # END exception handling\\n # END handle regions\\n\\n def _copy_from(self, rhs):\\n \\\"\\\"\\\"Copy all data from rhs into this instance, handles usage count\\\"\\\"\\\"\\n self._manager = rhs._manager\\n self._rlist = type(rhs._rlist)(rhs._rlist)\\n self._region = rhs._region\\n self._ofs = rhs._ofs\\n self._size = rhs._size\\n\\n for region in self._rlist:\\n region.increment_client_count()\\n\\n if self._region is not None:\\n self._region.increment_client_count()\\n # END handle regions\\n\\n def __copy__(self):\\n \\\"\\\"\\\"copy module interface\\\"\\\"\\\"\\n cpy = type(self)()\\n cpy._copy_from(self)\\n return cpy\\n\\n #{ Interface\\n def assign(self, rhs):\\n \\\"\\\"\\\"Assign rhs to this instance. This is required in order to get a real copy.\\n Alternatively, you can copy an existing instance using the copy module\\\"\\\"\\\"\\n self._destroy()\\n self._copy_from(rhs)\\n\\n def use_region(self, offset=0, size=0, flags=0):\\n \\\"\\\"\\\"Assure we point to a window which allows access to the given offset into the file\\n\\n :param offset: absolute offset in bytes into the file\\n :param size: amount of bytes to map. If 0, all available bytes will be mapped\\n :param flags: additional flags to be given to os.open in case a file handle is initially opened\\n for mapping. Has no effect if a region can actually be reused.\\n :return: this instance - it should be queried for whether it points to a valid memory region.\\n This is not the case if the mapping failed because we reached the end of the file\\n\\n **Note:**: The size actually mapped may be smaller than the given size. If that is the case,\\n either the file has reached its end, or the map was created between two existing regions\\\"\\\"\\\"\\n need_region = True\\n man = self._manager\\n fsize = self._rlist.file_size()\\n size = min(size or fsize, man.window_size() or fsize) # clamp size to window size\\n\\n if self._region is not None:\\n if self._region.includes_ofs(offset):\\n need_region = False\\n else:\\n self.unuse_region()\\n # END handle existing region\\n # END check existing region\\n\\n # offset too large ?\\n if offset >= fsize:\\n return self\\n # END handle offset\\n\\n if need_region:\\n self._region = man._obtain_region(self._rlist, offset, size, flags, False)\\n self._region.increment_client_count()\\n # END need region handling\\n\\n self._ofs = offset - self._region._b\\n self._size = min(size, self._region.ofs_end() - offset)\\n\\n return self\\n\\n def unuse_region(self):\\n \\\"\\\"\\\"Unuse the current region. Does nothing if we have no current region\\n\\n **Note:** the cursor unuses the region automatically upon destruction. It is recommended\\n to un-use the region once you are done reading from it in persistent cursors as it\\n helps to free up resource more quickly\\\"\\\"\\\"\\n if self._region is not None:\\n self._region.increment_client_count(-1)\\n self._region = None\\n # note: should reset ofs and size, but we spare that for performance. Its not\\n # allowed to query information if we are not valid !\\n\\n def buffer(self):\\n \\\"\\\"\\\"Return a buffer object which allows access to our memory region from our offset\\n to the window size. Please note that it might be smaller than you requested when calling use_region()\\n\\n **Note:** You can only obtain a buffer if this instance is_valid() !\\n\\n **Note:** buffers should not be cached passed the duration of your access as it will\\n prevent resources from being freed even though they might not be accounted for anymore !\\\"\\\"\\\"\\n return memoryview(self._region.buffer())[self._ofs:self._ofs+self._size]\\n\\n def map(self):\\n \\\"\\\"\\\"\\n :return: the underlying raw memory map. Please not that the offset and size is likely to be different\\n to what you set as offset and size. Use it only if you are sure about the region it maps, which is the whole\\n file in case of StaticWindowMapManager\\\"\\\"\\\"\\n return self._region.map()\\n\\n def is_valid(self):\\n \\\"\\\"\\\":return: True if we have a valid and usable region\\\"\\\"\\\"\\n return self._region is not None\\n\\n def is_associated(self):\\n \\\"\\\"\\\":return: True if we are associated with a specific file already\\\"\\\"\\\"\\n return self._rlist is not None\\n\\n def ofs_begin(self):\\n \\\"\\\"\\\":return: offset to the first byte pointed to by our cursor\\n\\n **Note:** only if is_valid() is True\\\"\\\"\\\"\\n return self._region._b + self._ofs\\n\\n def ofs_end(self):\\n \\\"\\\"\\\":return: offset to one past the last available byte\\\"\\\"\\\"\\n # unroll method calls for performance !\\n return self._region._b + self._ofs + self._size\\n\\n def size(self):\\n \\\"\\\"\\\":return: amount of bytes we point to\\\"\\\"\\\"\\n return self._size\\n\\n def region(self):\\n \\\"\\\"\\\":return: our mapped region, or None if nothing is mapped yet\\n :raise AssertionError: if we have no current region. This is only useful for debugging\\\"\\\"\\\"\\n return self._region\\n\\n def includes_ofs(self, ofs):\\n \\\"\\\"\\\":return: True if the given absolute offset is contained in the cursors\\n current region\\n\\n **Note:** cursor must be valid for this to work\\\"\\\"\\\"\\n # unroll methods\\n return (self._region._b + self._ofs) <= ofs < (self._region._b + self._ofs + self._size)\\n\\n def file_size(self):\\n \\\"\\\"\\\":return: size of the underlying file\\\"\\\"\\\"\\n return self._rlist.file_size()\\n\\n def path_or_fd(self):\\n \\\"\\\"\\\":return: path or file descriptor of the underlying mapped file\\\"\\\"\\\"\\n return self._rlist.path_or_fd()\\n\\n def path(self):\\n \\\"\\\"\\\":return: path of the underlying mapped file\\n :raise ValueError: if attached path is not a path\\\"\\\"\\\"\\n if isinstance(self._rlist.path_or_fd(), int):\\n raise ValueError(\\\"Path queried although mapping was applied to a file descriptor\\\")\\n # END handle type\\n return self._rlist.path_or_fd()\\n\\n def fd(self):\\n \\\"\\\"\\\":return: file descriptor used to create the underlying mapping.\\n\\n **Note:** it is not required to be valid anymore\\n :raise ValueError: if the mapping was not created by a file descriptor\\\"\\\"\\\"\\n if isinstance(self._rlist.path_or_fd(), str):\\n raise ValueError(\\\"File descriptor queried although mapping was generated from path\\\")\\n # END handle type\\n return self._rlist.path_or_fd()\\n\\n #} END interface\\n\\n\\nclass StaticWindowMapManager:\\n\\n \\\"\\\"\\\"Provides a manager which will produce single size cursors that are allowed\\n to always map the whole file.\\n\\n Clients must be written to specifically know that they are accessing their data\\n through a StaticWindowMapManager, as they otherwise have to deal with their window size.\\n\\n These clients would have to use a SlidingWindowMapBuffer to hide this fact.\\n\\n This type will always use a maximum window size, and optimize certain methods to\\n accommodate this fact\\\"\\\"\\\"\\n\\n __slots__ = [\\n '_fdict', # mapping of path -> StorageHelper (of some kind\\n '_window_size', # maximum size of a window\\n '_max_memory_size', # maximum amount of memory we may allocate\\n '_max_handle_count', # maximum amount of handles to keep open\\n '_memory_size', # currently allocated memory size\\n '_handle_count', # amount of currently allocated file handles\\n ]\\n\\n #{ Configuration\\n MapRegionListCls = MapRegionList\\n MapWindowCls = MapWindow\\n MapRegionCls = MapRegion\\n WindowCursorCls = WindowCursor\\n #} END configuration\\n\\n _MB_in_bytes = 1024 * 1024\\n\\n def __init__(self, window_size=0, max_memory_size=0, max_open_handles=sys.maxsize):\\n \\\"\\\"\\\"initialize the manager with the given parameters.\\n :param window_size: if -1, a default window size will be chosen depending on\\n the operating system's architecture. It will internally be quantified to a multiple of the page size\\n If 0, the window may have any size, which basically results in mapping the whole file at one\\n :param max_memory_size: maximum amount of memory we may map at once before releasing mapped regions.\\n If 0, a viable default will be set depending on the system's architecture.\\n It is a soft limit that is tried to be kept, but nothing bad happens if we have to over-allocate\\n :param max_open_handles: if not maxint, limit the amount of open file handles to the given number.\\n Otherwise the amount is only limited by the system itself. If a system or soft limit is hit,\\n the manager will free as many handles as possible\\\"\\\"\\\"\\n self._fdict = dict()\\n self._window_size = window_size\\n self._max_memory_size = max_memory_size\\n self._max_handle_count = max_open_handles\\n self._memory_size = 0\\n self._handle_count = 0\\n\\n if window_size < 0:\\n coeff = 64\\n if is_64_bit():\\n coeff = 1024\\n # END handle arch\\n self._window_size = coeff * self._MB_in_bytes\\n # END handle max window size\\n\\n if max_memory_size == 0:\\n coeff = 1024\\n if is_64_bit():\\n coeff = 8192\\n # END handle arch\\n self._max_memory_size = coeff * self._MB_in_bytes\\n # END handle max memory size\\n\\n #{ Internal Methods\\n\\n def _collect_lru_region(self, size):\\n \\\"\\\"\\\"Unmap the region which was least-recently used and has no client\\n :param size: size of the region we want to map next (assuming its not already mapped partially or full\\n if 0, we try to free any available region\\n :return: Amount of freed regions\\n\\n .. Note::\\n We don't raise exceptions anymore, in order to keep the system working, allowing temporary overallocation.\\n If the system runs out of memory, it will tell.\\n\\n .. TODO::\\n implement a case where all unusued regions are discarded efficiently.\\n Currently its only brute force\\n \\\"\\\"\\\"\\n num_found = 0\\n while (size == 0) or (self._memory_size + size > self._max_memory_size):\\n lru_region = None\\n lru_list = None\\n for regions in self._fdict.values():\\n for region in regions:\\n # check client count - if it's 1, it's just us\\n if (region.client_count() == 1 and\\n (lru_region is None or region._uc < lru_region._uc)):\\n lru_region = region\\n lru_list = regions\\n # END update lru_region\\n # END for each region\\n # END for each regions list\\n\\n if lru_region is None:\\n break\\n # END handle region not found\\n\\n num_found += 1\\n del(lru_list[lru_list.index(lru_region)])\\n lru_region.increment_client_count(-1)\\n self._memory_size -= lru_region.size()\\n self._handle_count -= 1\\n # END while there is more memory to free\\n return num_found\\n\\n def _obtain_region(self, a, offset, size, flags, is_recursive):\\n \\\"\\\"\\\"Utility to create a new region - for more information on the parameters,\\n see MapCursor.use_region.\\n :param a: A regions (a)rray\\n :return: The newly created region\\\"\\\"\\\"\\n if self._memory_size + size > self._max_memory_size:\\n self._collect_lru_region(size)\\n # END handle collection\\n\\n r = None\\n if a:\\n assert len(a) == 1\\n r = a[0]\\n else:\\n try:\\n r = self.MapRegionCls(a.path_or_fd(), 0, sys.maxsize, flags)\\n except Exception:\\n # apparently we are out of system resources or hit a limit\\n # As many more operations are likely to fail in that condition (\\n # like reading a file from disk, etc) we free up as much as possible\\n # As this invalidates our insert position, we have to recurse here\\n if is_recursive:\\n # we already tried this, and still have no success in obtaining\\n # a mapping. This is an exception, so we propagate it\\n raise\\n # END handle existing recursion\\n self._collect_lru_region(0)\\n return self._obtain_region(a, offset, size, flags, True)\\n # END handle exceptions\\n\\n self._handle_count += 1\\n self._memory_size += r.size()\\n a.append(r)\\n # END handle array\\n\\n assert r.includes_ofs(offset)\\n return r\\n\\n #}END internal methods\\n\\n #{ Interface\\n def make_cursor(self, path_or_fd):\\n \\\"\\\"\\\"\\n :return: a cursor pointing to the given path or file descriptor.\\n It can be used to map new regions of the file into memory\\n\\n **Note:** if a file descriptor is given, it is assumed to be open and valid,\\n but may be closed afterwards. To refer to the same file, you may reuse\\n your existing file descriptor, but keep in mind that new windows can only\\n be mapped as long as it stays valid. This is why the using actual file paths\\n are preferred unless you plan to keep the file descriptor open.\\n\\n **Note:** file descriptors are problematic as they are not necessarily unique, as two\\n different files opened and closed in succession might have the same file descriptor id.\\n\\n **Note:** Using file descriptors directly is faster once new windows are mapped as it\\n prevents the file to be opened again just for the purpose of mapping it.\\\"\\\"\\\"\\n regions = self._fdict.get(path_or_fd)\\n if regions is None:\\n regions = self.MapRegionListCls(path_or_fd)\\n self._fdict[path_or_fd] = regions\\n # END obtain region for path\\n return self.WindowCursorCls(self, regions)\\n\\n def collect(self):\\n \\\"\\\"\\\"Collect all available free-to-collect mapped regions\\n :return: Amount of freed handles\\\"\\\"\\\"\\n return self._collect_lru_region(0)\\n\\n def num_file_handles(self):\\n \\\"\\\"\\\":return: amount of file handles in use. Each mapped region uses one file handle\\\"\\\"\\\"\\n return self._handle_count\\n\\n def num_open_files(self):\\n \\\"\\\"\\\"Amount of opened files in the system\\\"\\\"\\\"\\n return reduce(lambda x, y: x + y, (1 for rlist in self._fdict.values() if len(rlist) > 0), 0)\\n\\n def window_size(self):\\n \\\"\\\"\\\":return: size of each window when allocating new regions\\\"\\\"\\\"\\n return self._window_size\\n\\n def mapped_memory_size(self):\\n \\\"\\\"\\\":return: amount of bytes currently mapped in total\\\"\\\"\\\"\\n return self._memory_size\\n\\n def max_file_handles(self):\\n \\\"\\\"\\\":return: maximum amount of handles we may have opened\\\"\\\"\\\"\\n return self._max_handle_count\\n\\n def max_mapped_memory_size(self):\\n \\\"\\\"\\\":return: maximum amount of memory we may allocate\\\"\\\"\\\"\\n return self._max_memory_size\\n\\n #} END interface\\n\\n #{ Special Purpose Interface\\n\\n def force_map_handle_removal_win(self, base_path):\\n \\\"\\\"\\\"ONLY AVAILABLE ON WINDOWS\\n On windows removing files is not allowed if anybody still has it opened.\\n If this process is ourselves, and if the whole process uses this memory\\n manager (as far as the parent framework is concerned) we can enforce\\n closing all memory maps whose path matches the given base path to\\n allow the respective operation after all.\\n The respective system must NOT access the closed memory regions anymore !\\n This really may only be used if you know that the items which keep\\n the cursors alive will not be using it anymore. They need to be recreated !\\n :return: Amount of closed handles\\n\\n **Note:** does nothing on non-windows platforms\\\"\\\"\\\"\\n if sys.platform != 'win32':\\n return\\n # END early bailout\\n\\n num_closed = 0\\n for path, rlist in self._fdict.items():\\n if path.startswith(base_path):\\n for region in rlist:\\n region.release()\\n num_closed += 1\\n # END path matches\\n # END for each path\\n return num_closed\\n #} END special purpose interface\\n\\n\\nclass SlidingWindowMapManager(StaticWindowMapManager):\\n\\n \\\"\\\"\\\"Maintains a list of ranges of mapped memory regions in one or more files and allows to easily\\n obtain additional regions assuring there is no overlap.\\n Once a certain memory limit is reached globally, or if there cannot be more open file handles\\n which result from each mmap call, the least recently used, and currently unused mapped regions\\n are unloaded automatically.\\n\\n **Note:** currently not thread-safe !\\n\\n **Note:** in the current implementation, we will automatically unload windows if we either cannot\\n create more memory maps (as the open file handles limit is hit) or if we have allocated more than\\n a safe amount of memory already, which would possibly cause memory allocations to fail as our address\\n space is full.\\\"\\\"\\\"\\n\\n __slots__ = tuple()\\n\\n def __init__(self, window_size=-1, max_memory_size=0, max_open_handles=sys.maxsize):\\n \\\"\\\"\\\"Adjusts the default window size to -1\\\"\\\"\\\"\\n super().__init__(window_size, max_memory_size, max_open_handles)\\n\\n def _obtain_region(self, a, offset, size, flags, is_recursive):\\n # bisect to find an existing region. The c++ implementation cannot\\n # do that as it uses a linked list for regions.\\n r = None\\n lo = 0\\n hi = len(a)\\n while lo < hi:\\n mid = (lo + hi) // 2\\n ofs = a[mid]._b\\n if ofs <= offset:\\n if a[mid].includes_ofs(offset):\\n r = a[mid]\\n break\\n # END have region\\n lo = mid + 1\\n else:\\n hi = mid\\n # END handle position\\n # END while bisecting\\n\\n if r is None:\\n window_size = self._window_size\\n left = self.MapWindowCls(0, 0)\\n mid = self.MapWindowCls(offset, size)\\n right = self.MapWindowCls(a.file_size(), 0)\\n\\n # we want to honor the max memory size, and assure we have anough\\n # memory available\\n # Save calls !\\n if self._memory_size + window_size > self._max_memory_size:\\n self._collect_lru_region(window_size)\\n # END handle collection\\n\\n # we assume the list remains sorted by offset\\n insert_pos = 0\\n len_regions = len(a)\\n if len_regions == 1:\\n if a[0]._b <= offset:\\n insert_pos = 1\\n # END maintain sort\\n else:\\n # find insert position\\n insert_pos = len_regions\\n for i, region in enumerate(a):\\n if region._b > offset:\\n insert_pos = i\\n break\\n # END if insert position is correct\\n # END for each region\\n # END obtain insert pos\\n\\n # adjust the actual offset and size values to create the largest\\n # possible mapping\\n if insert_pos == 0:\\n if len_regions:\\n right = self.MapWindowCls.from_region(a[insert_pos])\\n # END adjust right side\\n else:\\n if insert_pos != len_regions:\\n right = self.MapWindowCls.from_region(a[insert_pos])\\n # END adjust right window\\n left = self.MapWindowCls.from_region(a[insert_pos - 1])\\n # END adjust surrounding windows\\n\\n mid.extend_left_to(left, window_size)\\n mid.extend_right_to(right, window_size)\\n mid.align()\\n\\n # it can happen that we align beyond the end of the file\\n if mid.ofs_end() > right.ofs:\\n mid.size = right.ofs - mid.ofs\\n # END readjust size\\n\\n # insert new region at the right offset to keep the order\\n try:\\n if self._handle_count >= self._max_handle_count:\\n raise Exception\\n # END assert own imposed max file handles\\n r = self.MapRegionCls(a.path_or_fd(), mid.ofs, mid.size, flags)\\n except Exception:\\n # apparently we are out of system resources or hit a limit\\n # As many more operations are likely to fail in that condition (\\n # like reading a file from disk, etc) we free up as much as possible\\n # As this invalidates our insert position, we have to recurse here\\n if is_recursive:\\n # we already tried this, and still have no success in obtaining\\n # a mapping. This is an exception, so we propagate it\\n raise\\n # END handle existing recursion\\n self._collect_lru_region(0)\\n return self._obtain_region(a, offset, size, flags, True)\\n # END handle exceptions\\n\\n self._handle_count += 1\\n self._memory_size += r.size()\\n a.insert(insert_pos, r)\\n # END create new region\\n return r\\n\\n[end of smmap/mman.py]\",\n \"filename\": \"smmap/mman.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module with a simple buffer implementation using the memory manager\\\"\\\"\\\"\\nimport sys\\n\\n__all__ = [\\\"SlidingWindowMapBuffer\\\"]\\n\\n\\nclass SlidingWindowMapBuffer:\\n\\n \\\"\\\"\\\"A buffer like object which allows direct byte-wise object and slicing into\\n memory of a mapped file. The mapping is controlled by the provided cursor.\\n\\n The buffer is relative, that is if you map an offset, index 0 will map to the\\n first byte at the offset you used during initialization or begin_access\\n\\n **Note:** Although this type effectively hides the fact that there are mapped windows\\n underneath, it can unfortunately not be used in any non-pure python method which\\n needs a buffer or string\\\"\\\"\\\"\\n __slots__ = (\\n '_c', # our cursor\\n '_size', # our supposed size\\n )\\n\\n def __init__(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\\n \\\"\\\"\\\"Initialize the instance to operate on the given cursor.\\n :param cursor: if not None, the associated cursor to the file you want to access\\n If None, you have call begin_access before using the buffer and provide a cursor\\n :param offset: absolute offset in bytes\\n :param size: the total size of the mapping. Defaults to the maximum possible size\\n From that point on, the __len__ of the buffer will be the given size or the file size.\\n If the size is larger than the mappable area, you can only access the actually available\\n area, although the length of the buffer is reported to be your given size.\\n Hence it is in your own interest to provide a proper size !\\n :param flags: Additional flags to be passed to os.open\\n :raise ValueError: if the buffer could not achieve a valid state\\\"\\\"\\\"\\n self._c = cursor\\n if cursor and not self.begin_access(cursor, offset, size, flags):\\n raise ValueError(\\\"Failed to allocate the buffer - probably the given offset is out of bounds\\\")\\n # END handle offset\\n\\n def __del__(self):\\n self.end_access()\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self.end_access()\\n\\n def __len__(self):\\n return self._size\\n\\n def __getitem__(self, i):\\n if isinstance(i, slice):\\n return self.__getslice__(i.start or 0, i.stop or self._size)\\n c = self._c\\n assert c.is_valid()\\n if i < 0:\\n i = self._size + i\\n if not c.includes_ofs(i):\\n c.use_region(i, 1)\\n # END handle region usage\\n return c.buffer()[i - c.ofs_begin()]\\n\\n def __getslice__(self, i, j):\\n c = self._c\\n # fast path, slice fully included - safes a concatenate operation and\\n # should be the default\\n assert c.is_valid()\\n if i < 0:\\n i = self._size + i\\n if j == sys.maxsize:\\n j = self._size\\n if j < 0:\\n j = self._size + j\\n if (c.ofs_begin() <= i) and (j < c.ofs_end()):\\n b = c.ofs_begin()\\n return c.buffer()[i - b:j - b]\\n else:\\n l = j - i # total length\\n ofs = i\\n # It's fastest to keep tokens and join later, especially in py3, which was 7 times slower\\n # in the previous iteration of this code\\n md = list()\\n while l:\\n c.use_region(ofs, l)\\n assert c.is_valid()\\n d = c.buffer()[:l]\\n ofs += len(d)\\n l -= len(d)\\n # Make sure we don't keep references, as c.use_region() might attempt to free resources, but\\n # can't unless we use pure bytes\\n if hasattr(d, 'tobytes'):\\n d = d.tobytes()\\n md.append(d)\\n # END while there are bytes to read\\n return b''.join(md)\\n # END fast or slow path\\n #{ Interface\\n\\n def begin_access(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\\n \\\"\\\"\\\"Call this before the first use of this instance. The method was already\\n called by the constructor in case sufficient information was provided.\\n\\n For more information no the parameters, see the __init__ method\\n :param path: if cursor is None the existing one will be used.\\n :return: True if the buffer can be used\\\"\\\"\\\"\\n if cursor:\\n self._c = cursor\\n # END update our cursor\\n\\n # reuse existing cursors if possible\\n if self._c is not None and self._c.is_associated():\\n res = self._c.use_region(offset, size, flags).is_valid()\\n if res:\\n # if given size is too large or default, we computer a proper size\\n # If its smaller, we assume the combination between offset and size\\n # as chosen by the user is correct and use it !\\n # If not, the user is in trouble.\\n if size > self._c.file_size():\\n size = self._c.file_size() - offset\\n # END handle size\\n self._size = size\\n # END set size\\n return res\\n # END use our cursor\\n return False\\n\\n def end_access(self):\\n \\\"\\\"\\\"Call this method once you are done using the instance. It is automatically\\n called on destruction, and should be called just in time to allow system\\n resources to be freed.\\n\\n Once you called end_access, you must call begin access before reusing this instance!\\\"\\\"\\\"\\n self._size = 0\\n if self._c is not None:\\n self._c.unuse_region()\\n # END unuse region\\n\\n def cursor(self):\\n \\\"\\\"\\\":return: the currently set cursor which provides access to the data\\\"\\\"\\\"\\n return self._c\\n\\n #}END interface\\n\\n[end of smmap/buf.py]\",\n \"filename\": \"smmap/buf.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\\\"\\\"\\\"\\nimport os\\nimport sys\\n\\nfrom mmap import mmap, ACCESS_READ\\nfrom mmap import ALLOCATIONGRANULARITY\\n\\n__all__ = [\\\"align_to_mmap\\\", \\\"is_64_bit\\\",\\n \\\"MapWindow\\\", \\\"MapRegion\\\", \\\"MapRegionList\\\", \\\"ALLOCATIONGRANULARITY\\\"]\\n\\n#{ Utilities\\n\\n\\ndef align_to_mmap(num, round_up):\\n \\\"\\\"\\\"\\n Align the given integer number to the closest page offset, which usually is 4096 bytes.\\n\\n :param round_up: if True, the next higher multiple of page size is used, otherwise\\n the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)\\n :return: num rounded to closest page\\\"\\\"\\\"\\n res = (num // ALLOCATIONGRANULARITY) * ALLOCATIONGRANULARITY\\n if round_up and (res != num):\\n res += ALLOCATIONGRANULARITY\\n # END handle size\\n return res\\n\\n\\ndef is_64_bit():\\n \\\"\\\"\\\":return: True if the system is 64 bit. Otherwise it can be assumed to be 32 bit\\\"\\\"\\\"\\n return sys.maxsize > (1 << 32) - 1\\n\\n#}END utilities\\n\\n\\n#{ Utility Classes\\n\\nclass MapWindow:\\n\\n \\\"\\\"\\\"Utility type which is used to snap windows towards each other, and to adjust their size\\\"\\\"\\\"\\n __slots__ = (\\n 'ofs', # offset into the file in bytes\\n 'size' # size of the window in bytes\\n )\\n\\n def __init__(self, offset, size):\\n self.ofs = offset\\n self.size = size\\n\\n def __repr__(self):\\n return \\\"MapWindow(%i, %i)\\\" % (self.ofs, self.size)\\n\\n @classmethod\\n def from_region(cls, region):\\n \\\"\\\"\\\":return: new window from a region\\\"\\\"\\\"\\n return cls(region._b, region.size())\\n\\n def ofs_end(self):\\n return self.ofs + self.size\\n\\n def align(self):\\n \\\"\\\"\\\"Assures the previous window area is contained in the new one\\\"\\\"\\\"\\n nofs = align_to_mmap(self.ofs, 0)\\n self.size += self.ofs - nofs # keep size constant\\n self.ofs = nofs\\n self.size = align_to_mmap(self.size, 1)\\n\\n def extend_left_to(self, window, max_size):\\n \\\"\\\"\\\"Adjust the offset to start where the given window on our left ends if possible,\\n but don't make yourself larger than max_size.\\n The resize will assure that the new window still contains the old window area\\\"\\\"\\\"\\n rofs = self.ofs - window.ofs_end()\\n nsize = rofs + self.size\\n rofs -= nsize - min(nsize, max_size)\\n self.ofs -= rofs\\n self.size += rofs\\n\\n def extend_right_to(self, window, max_size):\\n \\\"\\\"\\\"Adjust the size to make our window end where the right window begins, but don't\\n get larger than max_size\\\"\\\"\\\"\\n self.size = min(self.size + (window.ofs - self.ofs_end()), max_size)\\n\\n\\nclass MapRegion:\\n\\n \\\"\\\"\\\"Defines a mapped region of memory, aligned to pagesizes\\n\\n **Note:** deallocates used region automatically on destruction\\\"\\\"\\\"\\n __slots__ = [\\n '_b', # beginning of mapping\\n '_mf', # mapped memory chunk (as returned by mmap)\\n '_uc', # total amount of usages\\n '_size', # cached size of our memory map\\n '__weakref__'\\n ]\\n\\n #{ Configuration\\n #} END configuration\\n\\n def __init__(self, path_or_fd, ofs, size, flags=0):\\n \\\"\\\"\\\"Initialize a region, allocate the memory map\\n :param path_or_fd: path to the file to map, or the opened file descriptor\\n :param ofs: **aligned** offset into the file to be mapped\\n :param size: if size is larger then the file on disk, the whole file will be\\n allocated the the size automatically adjusted\\n :param flags: additional flags to be given when opening the file.\\n :raise Exception: if no memory can be allocated\\\"\\\"\\\"\\n self._b = ofs\\n self._size = 0\\n self._uc = 0\\n\\n if isinstance(path_or_fd, int):\\n fd = path_or_fd\\n else:\\n fd = os.open(path_or_fd, os.O_RDONLY | getattr(os, 'O_BINARY', 0) | flags)\\n # END handle fd\\n\\n try:\\n kwargs = dict(access=ACCESS_READ, offset=ofs)\\n corrected_size = size\\n sizeofs = ofs\\n\\n # have to correct size, otherwise (instead of the c version) it will\\n # bark that the size is too large ... many extra file accesses because\\n # if this ... argh !\\n actual_size = min(os.fstat(fd).st_size - sizeofs, corrected_size)\\n self._mf = mmap(fd, actual_size, **kwargs)\\n # END handle memory mode\\n\\n self._size = len(self._mf)\\n finally:\\n if isinstance(path_or_fd, str):\\n os.close(fd)\\n # END only close it if we opened it\\n # END close file handle\\n # We assume the first one to use us keeps us around\\n self.increment_client_count()\\n\\n def __repr__(self):\\n return \\\"MapRegion<%i, %i>\\\" % (self._b, self.size())\\n\\n #{ Interface\\n\\n def buffer(self):\\n \\\"\\\"\\\":return: a buffer containing the memory\\\"\\\"\\\"\\n return self._mf\\n\\n def map(self):\\n \\\"\\\"\\\":return: a memory map containing the memory\\\"\\\"\\\"\\n return self._mf\\n\\n def ofs_begin(self):\\n \\\"\\\"\\\":return: absolute byte offset to the first byte of the mapping\\\"\\\"\\\"\\n return self._b\\n\\n def size(self):\\n \\\"\\\"\\\":return: total size of the mapped region in bytes\\\"\\\"\\\"\\n return self._size\\n\\n def ofs_end(self):\\n \\\"\\\"\\\":return: Absolute offset to one byte beyond the mapping into the file\\\"\\\"\\\"\\n return self._b + self._size\\n\\n def includes_ofs(self, ofs):\\n \\\"\\\"\\\":return: True if the given offset can be read in our mapped region\\\"\\\"\\\"\\n return self._b <= ofs < self._b + self._size\\n\\n def client_count(self):\\n \\\"\\\"\\\":return: number of clients currently using this region\\\"\\\"\\\"\\n return self._uc\\n\\n def increment_client_count(self, ofs = 1):\\n \\\"\\\"\\\"Adjust the usage count by the given positive or negative offset.\\n If usage count equals 0, we will auto-release our resources\\n :return: True if we released resources, False otherwise. In the latter case, we can still be used\\\"\\\"\\\"\\n self._uc += ofs\\n assert self._uc > -1, \\\"Increments must match decrements, usage counter negative: %i\\\" % self._uc\\n\\n if self.client_count() == 0:\\n self.release()\\n return True\\n else:\\n return False\\n # end handle release\\n\\n def release(self):\\n \\\"\\\"\\\"Release all resources this instance might hold. Must only be called if there usage_count() is zero\\\"\\\"\\\"\\n self._mf.close()\\n\\n #} END interface\\n\\n\\nclass MapRegionList(list):\\n\\n \\\"\\\"\\\"List of MapRegion instances associating a path with a list of regions.\\\"\\\"\\\"\\n __slots__ = (\\n '_path_or_fd', # path or file descriptor which is mapped by all our regions\\n '_file_size' # total size of the file we map\\n )\\n\\n def __new__(cls, path):\\n return super().__new__(cls)\\n\\n def __init__(self, path_or_fd):\\n self._path_or_fd = path_or_fd\\n self._file_size = None\\n\\n def path_or_fd(self):\\n \\\"\\\"\\\":return: path or file descriptor we are attached to\\\"\\\"\\\"\\n return self._path_or_fd\\n\\n def file_size(self):\\n \\\"\\\"\\\":return: size of file we manager\\\"\\\"\\\"\\n if self._file_size is None:\\n if isinstance(self._path_or_fd, str):\\n self._file_size = os.stat(self._path_or_fd).st_size\\n else:\\n self._file_size = os.fstat(self._path_or_fd).st_size\\n # END handle path type\\n # END update file size\\n return self._file_size\\n\\n#} END utility classes\\n\\n[end of smmap/util.py]\",\n \"filename\": \"smmap/util.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Initialize the smmap package\\\"\\\"\\\"\\n\\n__author__ = \\\"Sebastian Thiel\\\"\\n__contact__ = \\\"byronimo@gmail.com\\\"\\n__homepage__ = \\\"https://github.com/gitpython-developers/smmap\\\"\\nversion_info = (5, 0, 2)\\n__version__ = '.'.join(str(i) for i in version_info)\\n\\n# make everything available in root package for convenience\\nfrom .mman import *\\nfrom .buf import *\\n\\n[end of smmap/__init__.py]\",\n \"filename\": \"smmap/__init__.py\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = build\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\\n\\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\t-rm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make all-pdf' or \\\\`make all-ps' in that directory to\\\" \\\\\\n\\t \\\"run these through (pdf)latex.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\n[end of doc/Makefile]\",\n \"filename\": \"doc/Makefile\",\n \"id\": \"14\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\nREM Command file for Sphinx documentation\\n\\nset SPHINXBUILD=sphinx-build\\nset BUILDDIR=build\\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\\nif NOT \\\"%PAPER%\\\" == \\\"\\\" (\\n\\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\\n)\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\nif \\\"%1\\\" == \\\"help\\\" (\\n\\t:help\\n\\techo.Please use `make ^<target^>` where ^<target^> is one of\\n\\techo. html to make standalone HTML files\\n\\techo. dirhtml to make HTML files named index.html in directories\\n\\techo. pickle to make pickle files\\n\\techo. json to make JSON files\\n\\techo. htmlhelp to make HTML files and a HTML help project\\n\\techo. qthelp to make HTML files and a qthelp project\\n\\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\n\\techo. changes to make an overview over all changed/added/deprecated items\\n\\techo. linkcheck to check all external links for integrity\\n\\techo. doctest to run all doctests embedded in the documentation if enabled\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"clean\\\" (\\n\\tfor /d %%i in (%BUILDDIR%\\\\*) do rmdir /q /s %%i\\n\\tdel /q /s %BUILDDIR%\\\\*\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"html\\\" (\\n\\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\\n\\techo.\\n\\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"dirhtml\\\" (\\n\\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\\n\\techo.\\n\\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"pickle\\\" (\\n\\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\\n\\techo.\\n\\techo.Build finished; now you can process the pickle files.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"json\\\" (\\n\\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\\n\\techo.\\n\\techo.Build finished; now you can process the JSON files.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"htmlhelp\\\" (\\n\\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\\n\\techo.\\n\\techo.Build finished; now you can run HTML Help Workshop with the ^\\n.hhp project file in %BUILDDIR%/htmlhelp.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"qthelp\\\" (\\n\\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\\n\\techo.\\n\\techo.Build finished; now you can run \\\"qcollectiongenerator\\\" with the ^\\n.qhcp project file in %BUILDDIR%/qthelp, like this:\\n\\techo.^> qcollectiongenerator %BUILDDIR%\\\\qthelp\\\\smmap.qhcp\\n\\techo.To view the help file:\\n\\techo.^> assistant -collectionFile %BUILDDIR%\\\\qthelp\\\\smmap.ghc\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"latex\\\" (\\n\\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\\n\\techo.\\n\\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"changes\\\" (\\n\\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\\n\\techo.\\n\\techo.The overview file is in %BUILDDIR%/changes.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"linkcheck\\\" (\\n\\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\\n\\techo.\\n\\techo.Link check complete; look for any errors in the above output ^\\nor in %BUILDDIR%/linkcheck/output.txt.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"doctest\\\" (\\n\\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\\n\\techo.\\n\\techo.Testing of doctests in the sources finished, look at the ^\\nresults in %BUILDDIR%/doctest/output.txt.\\n\\tgoto end\\n)\\n\\n:end\\n\\n[end of doc/make.bat]\",\n \"filename\": \"doc/make.bat\",\n \"id\": \"15\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.mman import (\\n WindowCursor,\\n SlidingWindowMapManager,\\n StaticWindowMapManager\\n)\\nfrom smmap.util import align_to_mmap\\n\\nfrom random import randint\\nfrom time import time\\nimport os\\nimport sys\\nfrom copy import copy\\n\\n\\nclass TestMMan(TestBase):\\n\\n def test_cursor(self):\\n with FileCreator(self.k_window_test_size, \\\"cursor_test\\\") as fc:\\n man = SlidingWindowMapManager()\\n ci = WindowCursor(man) # invalid cursor\\n assert not ci.is_valid()\\n assert not ci.is_associated()\\n assert ci.size() == 0 # this is cached, so we can query it in invalid state\\n\\n cv = man.make_cursor(fc.path)\\n assert not cv.is_valid() # no region mapped yet\\n assert cv.is_associated() # but it know where to map it from\\n assert cv.file_size() == fc.size\\n assert cv.path() == fc.path\\n\\n # copy module\\n cio = copy(cv)\\n assert not cio.is_valid() and cio.is_associated()\\n\\n # assign method\\n assert not ci.is_associated()\\n ci.assign(cv)\\n assert not ci.is_valid() and ci.is_associated()\\n\\n # unuse non-existing region is fine\\n cv.unuse_region()\\n cv.unuse_region()\\n\\n # destruction is fine (even multiple times)\\n cv._destroy()\\n WindowCursor(man)._destroy()\\n\\n def test_memory_manager(self):\\n slide_man = SlidingWindowMapManager()\\n static_man = StaticWindowMapManager()\\n\\n for man in (static_man, slide_man):\\n assert man.num_file_handles() == 0\\n assert man.num_open_files() == 0\\n winsize_cmp_val = 0\\n if isinstance(man, StaticWindowMapManager):\\n winsize_cmp_val = -1\\n # END handle window size\\n assert man.window_size() > winsize_cmp_val\\n assert man.mapped_memory_size() == 0\\n assert man.max_mapped_memory_size() > 0\\n\\n # collection doesn't raise in 'any' mode\\n man._collect_lru_region(0)\\n # doesn't raise if we are within the limit\\n man._collect_lru_region(10)\\n\\n # doesn't fail if we over-allocate\\n assert man._collect_lru_region(sys.maxsize) == 0\\n\\n # use a region, verify most basic functionality\\n with FileCreator(self.k_window_test_size, \\\"manager_test\\\") as fc:\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n for item in (fc.path, fd):\\n c = man.make_cursor(item)\\n assert c.path_or_fd() is item\\n assert c.use_region(10, 10).is_valid()\\n assert c.ofs_begin() == 10\\n assert c.size() == 10\\n with open(fc.path, 'rb') as fp:\\n assert c.buffer()[:] == fp.read(20)[10:]\\n\\n if isinstance(item, int):\\n self.assertRaises(ValueError, c.path)\\n else:\\n self.assertRaises(ValueError, c.fd)\\n # END handle value error\\n # END for each input\\n finally:\\n os.close(fd)\\n # END for each manasger type\\n\\n def test_memman_operation(self):\\n # test more access, force it to actually unmap regions\\n with FileCreator(self.k_window_test_size, \\\"manager_operation_test\\\") as fc:\\n with open(fc.path, 'rb') as fp:\\n data = fp.read()\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n max_num_handles = 15\\n # small_size =\\n for mtype, args in ((StaticWindowMapManager, (0, fc.size // 3, max_num_handles)),\\n (SlidingWindowMapManager, (fc.size // 100, fc.size // 3, max_num_handles)),):\\n for item in (fc.path, fd):\\n assert len(data) == fc.size\\n\\n # small windows, a reasonable max memory. Not too many regions at once\\n man = mtype(window_size=args[0], max_memory_size=args[1], max_open_handles=args[2])\\n c = man.make_cursor(item)\\n\\n # still empty (more about that is tested in test_memory_manager()\\n assert man.num_open_files() == 0\\n assert man.mapped_memory_size() == 0\\n\\n base_offset = 5000\\n # window size is 0 for static managers, hence size will be 0. We take that into consideration\\n size = man.window_size() // 2\\n assert c.use_region(base_offset, size).is_valid()\\n rr = c.region()\\n assert rr.client_count() == 2 # the manager and the cursor and us\\n\\n assert man.num_open_files() == 1\\n assert man.num_file_handles() == 1\\n assert man.mapped_memory_size() == rr.size()\\n\\n # assert c.size() == size # the cursor may overallocate in its static version\\n assert c.ofs_begin() == base_offset\\n assert rr.ofs_begin() == 0 # it was aligned and expanded\\n if man.window_size():\\n # but isn't larger than the max window (aligned)\\n assert rr.size() == align_to_mmap(man.window_size(), True)\\n else:\\n assert rr.size() == fc.size\\n # END ignore static managers which dont use windows and are aligned to file boundaries\\n\\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\\n\\n # obtain second window, which spans the first part of the file - it is a still the same window\\n nsize = (size or fc.size) - 10\\n assert c.use_region(0, nsize).is_valid()\\n assert c.region() == rr\\n assert man.num_file_handles() == 1\\n assert c.size() == nsize\\n assert c.ofs_begin() == 0\\n assert c.buffer()[:] == data[:nsize]\\n\\n # map some part at the end, our requested size cannot be kept\\n overshoot = 4000\\n base_offset = fc.size - (size or c.size()) + overshoot\\n assert c.use_region(base_offset, size).is_valid()\\n if man.window_size():\\n assert man.num_file_handles() == 2\\n assert c.size() < size\\n assert c.region() is not rr # old region is still available, but has not cursor ref anymore\\n assert rr.client_count() == 1 # only held by manager\\n else:\\n assert c.size() < fc.size\\n # END ignore static managers which only have one handle per file\\n rr = c.region()\\n assert rr.client_count() == 2 # manager + cursor\\n assert rr.ofs_begin() < c.ofs_begin() # it should have extended itself to the left\\n assert rr.ofs_end() <= fc.size # it cannot be larger than the file\\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\\n\\n # unising a region makes the cursor invalid\\n c.unuse_region()\\n assert not c.is_valid()\\n if man.window_size():\\n # but doesn't change anything regarding the handle count - we cache it and only\\n # remove mapped regions if we have to\\n assert man.num_file_handles() == 2\\n # END ignore this for static managers\\n\\n # iterate through the windows, verify data contents\\n # this will trigger map collection after a while\\n max_random_accesses = 5000\\n num_random_accesses = max_random_accesses\\n memory_read = 0\\n st = time()\\n\\n # cache everything to get some more performance\\n includes_ofs = c.includes_ofs\\n max_mapped_memory_size = man.max_mapped_memory_size()\\n max_file_handles = man.max_file_handles()\\n mapped_memory_size = man.mapped_memory_size\\n num_file_handles = man.num_file_handles\\n while num_random_accesses:\\n num_random_accesses -= 1\\n base_offset = randint(0, fc.size - 1)\\n\\n # precondition\\n if man.window_size():\\n assert max_mapped_memory_size >= mapped_memory_size()\\n # END statistics will overshoot, which is fine\\n assert max_file_handles >= num_file_handles()\\n assert c.use_region(base_offset, (size or c.size())).is_valid()\\n csize = c.size()\\n assert c.buffer()[:] == data[base_offset:base_offset + csize]\\n memory_read += csize\\n\\n assert includes_ofs(base_offset)\\n assert includes_ofs(base_offset + csize - 1)\\n assert not includes_ofs(base_offset + csize)\\n # END while we should do an access\\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\\n mb = float(1000 * 1000)\\n print(\\\"%s: Read %i mb of memory with %i random on cursor initialized with %s accesses in %fs (%f mb/s)\\\\n\\\"\\n % (mtype, memory_read / mb, max_random_accesses, type(item), elapsed, (memory_read / mb) / elapsed),\\n file=sys.stderr)\\n\\n # an offset as large as the size doesn't work !\\n assert not c.use_region(fc.size, size).is_valid()\\n\\n # collection - it should be able to collect all\\n assert man.num_file_handles()\\n assert man.collect()\\n assert man.num_file_handles() == 0\\n # END for each item\\n # END for each manager type\\n finally:\\n os.close(fd)\\n\\n[end of smmap/test/test_mman.py]\",\n \"filename\": \"smmap/test/test_mman.py\",\n \"id\": \"16\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Provide base classes for the test system\\\"\\\"\\\"\\nfrom unittest import TestCase\\nimport os\\nimport tempfile\\n\\n__all__ = ['TestBase', 'FileCreator']\\n\\n\\n#{ Utilities\\n\\nclass FileCreator:\\n\\n \\\"\\\"\\\"A instance which creates a temporary file with a prefix and a given size\\n and provides this info to the user.\\n Once it gets deleted, it will remove the temporary file as well.\\\"\\\"\\\"\\n __slots__ = (\\\"_size\\\", \\\"_path\\\")\\n\\n def __init__(self, size, prefix=''):\\n assert size, \\\"Require size to be larger 0\\\"\\n\\n self._size = size\\n\\n with tempfile.NamedTemporaryFile(\\\"wb\\\", prefix=prefix, delete=False) as file:\\n self._path = file.name\\n file.seek(size - 1)\\n file.write(b'1')\\n\\n assert os.path.getsize(self.path) == size\\n\\n def __del__(self):\\n try:\\n os.remove(self.path)\\n except OSError:\\n pass\\n # END exception handling\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self.__del__()\\n\\n @property\\n def path(self):\\n return self._path\\n\\n @property\\n def size(self):\\n return self._size\\n\\n#} END utilities\\n\\n\\nclass TestBase(TestCase):\\n\\n \\\"\\\"\\\"Foundation used by all tests\\\"\\\"\\\"\\n\\n #{ Configuration\\n k_window_test_size = 1000 * 1000 * 8 + 5195\\n #} END configuration\\n\\n #{ Overrides\\n @classmethod\\n def setUpAll(cls):\\n # nothing for now\\n pass\\n\\n # END overrides\\n\\n #{ Interface\\n\\n #} END interface\\n\\n[end of smmap/test/lib.py]\",\n \"filename\": \"smmap/test/lib.py\",\n \"id\": \"17\"\n },\n {\n \"content\": \"[end of smmap/test/__init__.py]\",\n \"filename\": \"smmap/test/__init__.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.mman import (\\n SlidingWindowMapManager,\\n StaticWindowMapManager\\n)\\nfrom smmap.buf import SlidingWindowMapBuffer\\n\\nfrom random import randint\\nfrom time import time\\nimport sys\\nimport os\\n\\n\\nman_optimal = SlidingWindowMapManager()\\nman_worst_case = SlidingWindowMapManager(\\n window_size=TestBase.k_window_test_size // 100,\\n max_memory_size=TestBase.k_window_test_size // 3,\\n max_open_handles=15)\\nstatic_man = StaticWindowMapManager()\\n\\n\\nclass TestBuf(TestBase):\\n\\n def test_basics(self):\\n with FileCreator(self.k_window_test_size, \\\"buffer_test\\\") as fc:\\n\\n # invalid paths fail upon construction\\n c = man_optimal.make_cursor(fc.path)\\n self.assertRaises(ValueError, SlidingWindowMapBuffer, type(c)()) # invalid cursor\\n self.assertRaises(ValueError, SlidingWindowMapBuffer, c, fc.size) # offset too large\\n\\n buf = SlidingWindowMapBuffer() # can create uninitialized buffers\\n assert buf.cursor() is None\\n\\n # can call end access any time\\n buf.end_access()\\n buf.end_access()\\n assert len(buf) == 0\\n\\n # begin access can revive it, if the offset is suitable\\n offset = 100\\n assert buf.begin_access(c, fc.size) == False\\n assert buf.begin_access(c, offset) == True\\n assert len(buf) == fc.size - offset\\n assert buf.cursor().is_valid()\\n\\n # empty begin access keeps it valid on the same path, but alters the offset\\n assert buf.begin_access() == True\\n assert len(buf) == fc.size\\n assert buf.cursor().is_valid()\\n\\n # simple access\\n with open(fc.path, 'rb') as fp:\\n data = fp.read()\\n assert data[offset] == buf[0]\\n assert data[offset:offset * 2] == buf[0:offset]\\n\\n # negative indices, partial slices\\n assert buf[-1] == buf[len(buf) - 1]\\n assert buf[-10:] == buf[len(buf) - 10:len(buf)]\\n\\n # end access makes its cursor invalid\\n buf.end_access()\\n assert not buf.cursor().is_valid()\\n assert buf.cursor().is_associated() # but it remains associated\\n\\n # an empty begin access fixes it up again\\n assert buf.begin_access() == True and buf.cursor().is_valid()\\n del(buf) # ends access automatically\\n del(c)\\n\\n assert man_optimal.num_file_handles() == 1\\n\\n # PERFORMANCE\\n # blast away with random access and a full mapping - we don't want to\\n # exaggerate the manager's overhead, but measure the buffer overhead\\n # We do it once with an optimal setting, and with a worse manager which\\n # will produce small mappings only !\\n max_num_accesses = 100\\n fd = os.open(fc.path, os.O_RDONLY)\\n for item in (fc.path, fd):\\n for manager, man_id in ((man_optimal, 'optimal'),\\n (man_worst_case, 'worst case'),\\n (static_man, 'static optimal')):\\n buf = SlidingWindowMapBuffer(manager.make_cursor(item))\\n assert manager.num_file_handles() == 1\\n for access_mode in range(2): # single, multi\\n num_accesses_left = max_num_accesses\\n num_bytes = 0\\n fsize = fc.size\\n\\n st = time()\\n buf.begin_access()\\n while num_accesses_left:\\n num_accesses_left -= 1\\n if access_mode: # multi\\n ofs_start = randint(0, fsize)\\n ofs_end = randint(ofs_start, fsize)\\n d = buf[ofs_start:ofs_end]\\n assert len(d) == ofs_end - ofs_start\\n assert d == data[ofs_start:ofs_end]\\n num_bytes += len(d)\\n del d\\n else:\\n pos = randint(0, fsize)\\n assert buf[pos] == data[pos]\\n num_bytes += 1\\n # END handle mode\\n # END handle num accesses\\n\\n buf.end_access()\\n assert manager.num_file_handles()\\n assert manager.collect()\\n assert manager.num_file_handles() == 0\\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\\n mb = float(1000 * 1000)\\n mode_str = (access_mode and \\\"slice\\\") or \\\"single byte\\\"\\n print(\\\"%s: Made %i random %s accesses to buffer created from %s reading a total of %f mb in %f s (%f mb/s)\\\"\\n % (man_id, max_num_accesses, mode_str, type(item), num_bytes / mb, elapsed, (num_bytes / mb) / elapsed),\\n file=sys.stderr)\\n # END handle access mode\\n del buf\\n # END for each manager\\n # END for each input\\n os.close(fd)\\n\\n[end of smmap/test/test_buf.py]\",\n \"filename\": \"smmap/test/test_buf.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.util import (\\n MapWindow,\\n MapRegion,\\n MapRegionList,\\n ALLOCATIONGRANULARITY,\\n is_64_bit,\\n align_to_mmap\\n)\\n\\nimport os\\nimport sys\\n\\n\\nclass TestMMan(TestBase):\\n\\n def test_window(self):\\n wl = MapWindow(0, 1) # left\\n wc = MapWindow(1, 1) # center\\n wc2 = MapWindow(10, 5) # another center\\n wr = MapWindow(8000, 50) # right\\n\\n assert wl.ofs_end() == 1\\n assert wc.ofs_end() == 2\\n assert wr.ofs_end() == 8050\\n\\n # extension does nothing if already in place\\n maxsize = 100\\n wc.extend_left_to(wl, maxsize)\\n assert wc.ofs == 1 and wc.size == 1\\n wl.extend_right_to(wc, maxsize)\\n wl.extend_right_to(wc, maxsize)\\n assert wl.ofs == 0 and wl.size == 1\\n\\n # an actual left extension\\n pofs_end = wc2.ofs_end()\\n wc2.extend_left_to(wc, maxsize)\\n assert wc2.ofs == wc.ofs_end() and pofs_end == wc2.ofs_end()\\n\\n # respects maxsize\\n wc.extend_right_to(wr, maxsize)\\n assert wc.ofs == 1 and wc.size == maxsize\\n wc.extend_right_to(wr, maxsize)\\n assert wc.ofs == 1 and wc.size == maxsize\\n\\n # without maxsize\\n wc.extend_right_to(wr, sys.maxsize)\\n assert wc.ofs_end() == wr.ofs and wc.ofs == 1\\n\\n # extend left\\n wr.extend_left_to(wc2, maxsize)\\n wr.extend_left_to(wc2, maxsize)\\n assert wr.size == maxsize\\n\\n wr.extend_left_to(wc2, sys.maxsize)\\n assert wr.ofs == wc2.ofs_end()\\n\\n wc.align()\\n assert wc.ofs == 0 and wc.size == align_to_mmap(wc.size, True)\\n\\n def test_region(self):\\n with FileCreator(self.k_window_test_size, \\\"window_test\\\") as fc:\\n half_size = fc.size // 2\\n rofs = align_to_mmap(4200, False)\\n rfull = MapRegion(fc.path, 0, fc.size)\\n rhalfofs = MapRegion(fc.path, rofs, fc.size)\\n rhalfsize = MapRegion(fc.path, 0, half_size)\\n\\n # offsets\\n assert rfull.ofs_begin() == 0 and rfull.size() == fc.size\\n assert rfull.ofs_end() == fc.size # if this method works, it works always\\n\\n assert rhalfofs.ofs_begin() == rofs and rhalfofs.size() == fc.size - rofs\\n assert rhalfsize.ofs_begin() == 0 and rhalfsize.size() == half_size\\n\\n assert rfull.includes_ofs(0) and rfull.includes_ofs(fc.size - 1) and rfull.includes_ofs(half_size)\\n assert not rfull.includes_ofs(-1) and not rfull.includes_ofs(sys.maxsize)\\n\\n # auto-refcount\\n assert rfull.client_count() == 1\\n rfull2 = rfull\\n assert rfull.client_count() == 1, \\\"no auto-counting\\\"\\n\\n # window constructor\\n w = MapWindow.from_region(rfull)\\n assert w.ofs == rfull.ofs_begin() and w.ofs_end() == rfull.ofs_end()\\n\\n def test_region_list(self):\\n with FileCreator(100, \\\"sample_file\\\") as fc:\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n for item in (fc.path, fd):\\n ml = MapRegionList(item)\\n\\n assert len(ml) == 0\\n assert ml.path_or_fd() == item\\n assert ml.file_size() == fc.size\\n finally:\\n os.close(fd)\\n\\n def test_util(self):\\n assert isinstance(is_64_bit(), bool) # just call it\\n assert align_to_mmap(1, False) == 0\\n assert align_to_mmap(1, True) == ALLOCATIONGRANULARITY\\n\\n[end of smmap/test/test_util.py]\",\n \"filename\": \"smmap/test/test_util.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"from .lib import TestBase\\n\\n\\nclass TestTutorial(TestBase):\\n\\n def test_example(self):\\n # Memory Managers\\n ##################\\n import smmap\\n # This instance should be globally available in your application\\n # It is configured to be well suitable for 32-bit or 64 bit applications.\\n mman = smmap.SlidingWindowMapManager()\\n\\n # the manager provides much useful information about its current state\\n # like the amount of open file handles or the amount of mapped memory\\n assert mman.num_file_handles() == 0\\n assert mman.mapped_memory_size() == 0\\n # and many more ...\\n\\n # Cursors\\n ##########\\n import smmap.test.lib\\n with smmap.test.lib.FileCreator(1024 * 1024 * 8, \\\"test_file\\\") as fc:\\n # obtain a cursor to access some file.\\n c = mman.make_cursor(fc.path)\\n\\n # the cursor is now associated with the file, but not yet usable\\n assert c.is_associated()\\n assert not c.is_valid()\\n\\n # before you can use the cursor, you have to specify a window you want to\\n # access. The following just says you want as much data as possible starting\\n # from offset 0.\\n # To be sure your region could be mapped, query for validity\\n assert c.use_region().is_valid() # use_region returns self\\n\\n # once a region was mapped, you must query its dimension regularly\\n # to assure you don't try to access its buffer out of its bounds\\n assert c.size()\\n c.buffer()[0] # first byte\\n c.buffer()[1:10] # first 9 bytes\\n c.buffer()[c.size() - 1] # last byte\\n\\n # you can query absolute offsets, and check whether an offset is included\\n # in the cursor's data.\\n assert c.ofs_begin() < c.ofs_end()\\n assert c.includes_ofs(100)\\n\\n # If you are over out of bounds with one of your region requests, the\\n # cursor will be come invalid. It cannot be used in that state\\n assert not c.use_region(fc.size, 100).is_valid()\\n # map as much as possible after skipping the first 100 bytes\\n assert c.use_region(100).is_valid()\\n\\n # You can explicitly free cursor resources by unusing the cursor's region\\n c.unuse_region()\\n assert not c.is_valid()\\n\\n # Buffers\\n #########\\n # Create a default buffer which can operate on the whole file\\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\\n\\n # you can use it right away\\n assert buf.cursor().is_valid()\\n\\n buf[0] # access the first byte\\n buf[-1] # access the last ten bytes on the file\\n buf[-10:] # access the last ten bytes\\n\\n # If you want to keep the instance between different accesses, use the\\n # dedicated methods\\n buf.end_access()\\n assert not buf.cursor().is_valid() # you cannot use the buffer anymore\\n assert buf.begin_access(offset=10) # start using the buffer at an offset\\n\\n[end of smmap/test/test_tutorial.py]\",\n \"filename\": \"smmap/test/test_tutorial.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. smmap documentation master file, created by\\n sphinx-quickstart on Wed Jun 8 15:14:25 2011.\\n You can adapt this file completely to your liking, but it should at least\\n contain the root `toctree` directive.\\n\\nWelcome to smmap's documentation!\\n=================================\\n**smmap** is a pure python implementation of a sliding memory map to help unifying memory mapped access on 32 and 64 bit systems and to help managing resources more efficiently.\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n \\n intro\\n tutorial\\n api\\n changes\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of doc/source/index.rst]\",\n \"filename\": \"doc/source/index.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"###########\\nMotivation\\n###########\\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\\n\\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\\n\\n########\\nOverview\\n########\\n\\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\\n\\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\\n\\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\\n\\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\\n\\n#############\\nPrerequisites\\n#############\\n* Python 3.7+\\n* OSX, Windows or Linux\\n\\nThe package was tested on all of the previously mentioned configurations.\\n\\n###########\\nLimitations\\n###########\\n* The memory access is read-only by design.\\n\\n################\\nInstalling smmap\\n################\\nIts easiest to install smmap using the *pip* program::\\n \\n $ pip install smmap\\n \\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\\n\\nIf you have downloaded the source archive, the package can be installed by running the ``setup.py`` script::\\n \\n $ python setup.py install\\n\\nIt is advised to have a look at the :ref:`Usage Guide <tutorial-label>` for a brief introduction on the different database implementations.\\n\\n##################\\nHomepage and Links\\n##################\\nThe project is home on github at `https://github.com/gitpython-developers/smmap <https://github.com/gitpython-developers/smmap>`_.\\n\\nThe latest source can be cloned from github as well:\\n\\n * git://github.com/gitpython-developers/smmap.git\\n \\n \\nFor support, please use the git-python mailing list:\\n\\n * http://groups.google.com/group/git-python\\n \\n\\nIssues can be filed on github:\\n\\n * https://github.com/gitpython-developers/smmap/issues\\n \\n###################\\nLicense Information\\n###################\\n*smmap* is licensed under the New BSD License.\\n\\n.. _pip: http://www.pip-installer.org/en/latest/\\n\\n[end of doc/source/intro.rst]\",\n \"filename\": \"doc/source/intro.rst\",\n \"id\": \"23\"\n },\n {\n \"content\": \"#\\n# smmap documentation build configuration file, created by\\n# sphinx-quickstart on Wed Jun 8 15:14:25 2011.\\n#\\n# This file is execfile()d with the current directory set to its containing dir.\\n#\\n# Note that not all possible configuration values are present in this\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.append(os.path.abspath('../../'))\\n\\n# -- General configuration -----------------------------------------------------\\n\\n# Add any Sphinx extension module names here, as strings. They can be extensions\\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['.templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = 'smmap'\\ncopyright = '2011, Sebastian Thiel'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.8.0'\\n# The full version, including alpha/beta/rc tags.\\nrelease = '0.8.0'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of documents that shouldn't be included in the build.\\n#unused_docs = []\\n\\n# List of directories, relative to source directory, that shouldn't be searched\\n# for source files.\\nexclude_trees = []\\n\\n# The reST default role (used for this markup: `text`) to use for all documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n\\n# -- Options for HTML output ---------------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. Major themes that come with\\n# Sphinx are currently 'default' and 'sphinxdoc'.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['.static']\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_use_modindex = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# If nonempty, this is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = ''\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'smmapdoc'\\n\\n\\n# -- Options for LaTeX output --------------------------------------------------\\n\\n# The paper size ('letter' or 'a4').\\n#latex_paper_size = 'letter'\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#latex_font_size = '10pt'\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title, author, documentclass [howto/manual]).\\nlatex_documents = [\\n ('index', 'smmap.tex', 'smmap Documentation',\\n 'Sebastian Thiel', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# Additional stuff for the LaTeX preamble.\\n#latex_preamble = ''\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_use_modindex = True\\n\\n[end of doc/source/conf.py]\",\n \"filename\": \"doc/source/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \".. _tutorial-label:\\n\\n###########\\nUsage Guide\\n###########\\nThis text briefly introduces you to the basic design decisions and accompanying classes.\\n\\n******\\nDesign\\n******\\nPer application, there is *MemoryManager* which is held as static instance and used throughout the application. It can be configured to keep your resources within certain limits.\\n\\nTo access mapped regions, you require a cursor. Cursors point to exactly one file and serve as handles into it. As long as it exists, the respective memory region will remain available.\\n\\nFor convenience, a buffer implementation is provided which handles cursors and resource allocation behind its simple buffer like interface.\\n\\n***************\\nMemory Managers\\n***************\\nThere are two types of memory managers, one uses *static* windows, the other one uses *sliding* windows. A window is a region of a file mapped into memory. Although the names might be somewhat misleading as technically windows are always static, the *sliding* version will allocate relatively small windows whereas the *static* version will always map the whole file.\\n\\nThe *static* manager does nothing more than keeping a client count on the respective memory maps which always map the whole file, which allows to make some assumptions that can lead to simplified data access and increased performance, but reduces the compatibility to 32 bit systems or giant files.\\n\\nThe *sliding* memory manager therefore should be the default manager when preparing an application for handling huge amounts of data on 32 bit and 64 bit platforms::\\n\\n import smmap\\n # This instance should be globally available in your application\\n # It is configured to be well suitable for 32-bit or 64 bit applications.\\n mman = smmap.SlidingWindowMapManager()\\n \\n # the manager provides much useful information about its current state\\n # like the amount of open file handles or the amount of mapped memory\\n mman.num_file_handles()\\n mman.mapped_memory_size()\\n # and many more ...\\n\\n\\nCursors\\n*******\\n*Cursors* are handles that point onto a window, i.e. a region of a file mapped into memory. From them you may obtain a buffer through which the data of that window can actually be accessed::\\n\\n import smmap.test.lib\\n fc = smmap.test.lib.FileCreator(1024*1024*8, \\\"test_file\\\")\\n \\n # obtain a cursor to access some file.\\n c = mman.make_cursor(fc.path)\\n \\n # the cursor is now associated with the file, but not yet usable\\n assert c.is_associated()\\n assert not c.is_valid()\\n \\n # before you can use the cursor, you have to specify a window you want to \\n # access. The following just says you want as much data as possible starting\\n # from offset 0.\\n # To be sure your region could be mapped, query for validity\\n assert c.use_region().is_valid()\\t\\t# use_region returns self\\n \\n # once a region was mapped, you must query its dimension regularly\\n # to assure you don't try to access its buffer out of its bounds\\n assert c.size()\\n c.buffer()[0]\\t\\t\\t# first byte\\n c.buffer()[1:10]\\t\\t\\t# first 9 bytes\\n c.buffer()[c.size()-1] \\t# last byte\\n \\n # its recommended not to create big slices when feeding the buffer\\n # into consumers (e.g. struct or zlib). \\n # Instead, either give the buffer directly, or use pythons buffer command.\\n buffer(c.buffer(), 1, 9)\\t# first 9 bytes without copying them\\n \\n # you can query absolute offsets, and check whether an offset is included\\n # in the cursor's data.\\n assert c.ofs_begin() < c.ofs_end()\\n assert c.includes_ofs(100)\\n \\n # If you are over out of bounds with one of your region requests, the \\n # cursor will be come invalid. It cannot be used in that state\\n assert not c.use_region(fc.size, 100).is_valid()\\n # map as much as possible after skipping the first 100 bytes\\n assert c.use_region(100).is_valid()\\n \\n # You can explicitly free cursor resources by unusing the cursor's region\\n c.unuse_region()\\n assert not c.is_valid()\\n \\n\\nNow you would have to write your algorithms around this interface to properly slide through huge amounts of data. \\n \\nAlternatively you can use a convenience interface.\\n\\n*******\\nBuffers\\n*******\\nTo make first use easier, at the expense of performance, there is a Buffer implementation which uses a cursor underneath.\\n\\nWith it, you can access all data in a possibly huge file without having to take care of setting the cursor to different regions yourself::\\n\\n # Create a default buffer which can operate on the whole file\\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\\n \\n # you can use it right away\\n assert buf.cursor().is_valid()\\n \\n buf[0]\\t# access the first byte\\n buf[-1]\\t# access the last ten bytes on the file\\n buf[-10:]# access the last ten bytes\\n \\n # If you want to keep the instance between different accesses, use the\\n # dedicated methods\\n buf.end_access()\\n assert not buf.cursor().is_valid()\\t# you cannot use the buffer anymore\\n assert buf.begin_access(offset=10)\\t# start using the buffer at an offset\\n \\n # it will stop using resources automatically once it goes out of scope\\n \\nDisadvantages\\n*************\\nBuffers cannot be used in place of strings or maps, hence you have to slice them to have valid input for the sorts of struct and zlib. A slice means a lot of data handling overhead which makes buffers slower compared to using cursors directly. \\n\\n\\n[end of doc/source/tutorial.rst]\",\n \"filename\": \"doc/source/tutorial.rst\",\n \"id\": \"25\"\n },\n {\n \"content\": \"#########\\nChangelog\\n#########\\n\\n******\\nv5.0.2\\n******\\n\\n- remove a usage of mktemp\\n\\n******\\nv5.0.1\\n******\\n\\n- Added support for Python 3.12\\n\\n******\\nv6.0.0\\n******\\n\\nYANKED\\n\\n- Dropped support 3.6 and 3.7\\n- Declared support for Python 3.11 and 3.12\\n\\n******\\nv5.0.0\\n******\\n\\n- Dropped support 3.5\\n- Added support for Python 3.10\\n\\n******\\nv4.0.0\\n******\\n\\n- Dropped support for Python 2.7 and 3.4\\n- Added support for Python 3.7, 3.8, and 3.9\\n- Removed unused exc.MemoryManagerError and exc.RegionCollectionError\\n\\n******\\nv3.0.5\\n******\\n\\n- Restored Python 2 support removed in v3.0.2\\n- Changed release signature key to 27C50E7F590947D7273A741E85194C08421980C9.\\n See https://keybase.io/byronbates for proof of ownership.\\n\\n******\\nv3.0.4\\n******\\n\\n- Signed release (with correct key this time)\\n\\n******\\nv3.0.2\\n******\\n\\n- Signed release\\n- Switched to GitHub Actions for CI\\n\\n******\\nv3.0.1\\n******\\n- Switched back to the smmap package name on PyPI and fixed the smmap2 mirror package\\n (`#44 <https://github.com/gitpython-developers/smmap/issues/44>`_)\\n- Fixed setup.py ``long_description`` rendering\\n (`#40 <https://github.com/gitpython-developers/smmap/pull/40>`_)\\n\\n**********\\nv0.9.0\\n**********\\n- Fixed issue with resources never being freed as mmaps were never closed.\\n- Client counting is now done manually, instead of relying on pyton's reference count\\n\\n**********\\nv0.8.5\\n**********\\n- Fixed Python 3.0-3.3 regression, which also causes smmap to become about 3 times slower depending on the code path. It's related to this bug (http://bugs.python.org/issue15958), which was fixed in python 3.4\\n\\n**********\\nv0.8.4\\n**********\\n- Fixed Python 3 performance regression\\n\\n**********\\nv0.8.3\\n**********\\n- Cleaned up code and assured it works sufficiently well with python 3\\n\\n**********\\nv0.8.1\\n**********\\n- A single bugfix\\n\\n**********\\nv0.8.0 \\n**********\\n\\n- Initial Release\\n\\n[end of doc/source/changes.rst]\",\n \"filename\": \"doc/source/changes.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \".. _api-label:\\n\\n#############\\nAPI Reference\\n#############\\n\\n***********************\\nMapped Memory Managers\\n***********************\\n\\n.. automodule:: smmap.mman\\n :members:\\n :undoc-members:\\n\\n*******\\nBuffers\\n*******\\n\\n.. automodule:: smmap.buf\\n :members:\\n :undoc-members:\\n\\n*********\\nUtilities\\n*********\\n\\n.. automodule:: smmap.util\\n :members:\\n :undoc-members:\\n\\n\\n\\n\\n\\n\\n[end of doc/source/api.rst]\",\n \"filename\": \"doc/source/api.rst\",\n \"id\": \"27\"\n }\n]","isConversational":false}}},{"rowIdx":70,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 70,\n \"num_files\": 28,\n \"repo_id\": \"repo_0070\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"Copyright (C) 2010, 2011 Sebastian Thiel and contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions \nare met:\n\n* Redistributions of source code must retain the above copyright \nnotice, this list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright \nnotice, this list of conditions and the following disclaimer in the \ndocumentation and/or other materials provided with the distribution.\n\n* Neither the name of the async project nor the names of \nits contributors may be used to endorse or promote products derived \nfrom this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED \nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR \nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING \nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":".PHONY: all clean release force_release\n\nall:\n\t@grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all\n\nclean:\n\trm -rf build/ dist/ .eggs/ .tox/\n\nforce_release: clean\n\t./build-release.sh\n\ttwine upload dist/*\n\tgit push --tags origin master\n\n[end of Makefile]","filename":"Makefile","id":"1"},{"content":"# Include the license file\ninclude LICENSE\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"2"},{"content":"[run]\nsource = smmap\n\n; to make nosetests happy\n[report]\nomit = \n\t*/yaml*\n\t*/tests/*\n */python?.?/*\n */site-packages/nose/*\n[end of .coveragerc]","filename":".coveragerc","id":"3"},{"content":"## Motivation\n\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\n\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\n\n\n## Limitations\n\n* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.\n* The memory access is read-only by design.\n\n\n## Overview\n\n\n\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\n\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\n\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\n\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\n\n\n\n## Prerequisites\n\n* Python 3.7+\n* OSX, Windows or Linux\n\nThe package was tested on all of the previously mentioned configurations.\n\n## Installing smmap\n\n[](https://readthedocs.org/projects/smmap/?badge=latest)\n\nIts easiest to install smmap using the [pip](http://www.pip-installer.org/en/latest) program:\n\n```bash\n$ pip install smmap\n```\n\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\n\nIf you have downloaded the source archive, the package can be installed by running the `setup.py` script:\n\n```bash\n$ python setup.py install\n```\n\nIt is advised to have a look at the **Usage Guide** for a brief introduction on the different database implementations.\n\n\n\n## Homepage and Links\n\nThe project is home on github at https://github.com/gitpython-developers/smmap .\n\nThe latest source can be cloned from github as well:\n\n* git://github.com/gitpython-developers/smmap.git\n\n\nFor support, please use the git-python mailing list:\n\n* http://groups.google.com/group/git-python\n\n\nIssues can be filed on github:\n\n* https://github.com/gitpython-developers/smmap/issues\n\nA link to the pypi page related to this repository:\n\n* https://pypi.org/project/smmap/\n\n\n## License Information\n\n*smmap* is licensed under the New BSD License.\n\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"#!/usr/bin/env python\nimport os\n\ntry:\n from setuptools import setup, find_packages\nexcept ImportError:\n from ez_setup import use_setuptools\n use_setuptools()\n from setuptools import setup, find_packages\n\nimport smmap\n\nif os.path.exists(\"README.md\"):\n long_description = open('README.md', encoding=\"utf-8\").read().replace('\\r\\n', '\\n')\nelse:\n long_description = \"See https://github.com/gitpython-developers/smmap\"\n\nsetup(\n name=\"smmap\",\n version=smmap.__version__,\n description=\"A pure Python implementation of a sliding window memory map manager\",\n author=smmap.__author__,\n author_email=smmap.__contact__,\n url=smmap.__homepage__,\n platforms=[\"any\"],\n license=\"BSD-3-Clause\",\n packages=find_packages(),\n zip_safe=True,\n python_requires=\">=3.7\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Operating System :: POSIX\",\n \"Operating System :: Microsoft :: Windows\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.7\",\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 \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3 :: Only\",\n ],\n long_description=long_description,\n long_description_content_type='text/markdown',\n)\n\n[end of setup.py]","filename":"setup.py","id":"5"},{"content":"# Tox (http://tox.testrun.org/) is a tool for running tests\n# in multiple virtualenvs. This configuration file will run the\n# test suite on all supported python versions. To use it, \"pip install tox\"\n# and then run \"tox\" from this directory.\n\n[tox]\nenvlist = flake8, py{37, 38, 39, 310, 311, 312}\n\n[testenv]\ncommands = {envpython} -m pytest --cov smmap --cov-report xml {posargs}\ndeps =\n pytest\n pytest-cov\n\n[testenv:flake8]\ncommands = flake8 {posargs}\ndeps = flake8\n\n[end of tox.ini]","filename":"tox.ini","id":"6"},{"content":"[flake8]\nexclude = .tox,.venv,build,dist,doc\n\n[end of setup.cfg]","filename":"setup.cfg","id":"7"},{"content":"#!/bin/bash\n#\n# This script builds a release. If run in a venv, it auto-installs its tools.\n# You may want to run \"make release\" instead of running this script directly.\n\nset -eEu\n\nfunction release_with() {\n $1 -m build --sdist --wheel\n}\n\nif test -n \"${VIRTUAL_ENV:-}\"; then\n deps=(build twine) # Install twine along with build, as we need it later.\n echo \"Virtual environment detected. Adding packages: ${deps[*]}\"\n pip install --quiet --upgrade \"${deps[@]}\"\n echo 'Starting the build.'\n release_with python\nelse\n function suggest_venv() {\n venv_cmd='python -m venv env && source env/bin/activate'\n printf \"HELP: To avoid this error, use a virtual-env with '%s' instead.\\n\" \"$venv_cmd\"\n }\n trap suggest_venv ERR # This keeps the original exit (error) code.\n echo 'Starting the build.'\n release_with python3 # Outside a venv, use python3.\nfi\n\n[end of build-release.sh]","filename":"build-release.sh","id":"8"},{"content":"# Security Policy\n\nSee [GitPython](https://github.com/gitpython-developers/GitPython/blob/main/SECURITY.md). Vulnerabilities found in `smmap` can be reported there.\n\n[end of SECURITY.md]","filename":"SECURITY.md","id":"9"},{"content":"\"\"\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\"\"\"\nfrom .util import (\n MapWindow,\n MapRegion,\n MapRegionList,\n is_64_bit,\n)\n\nimport sys\nfrom functools import reduce\n\n__all__ = [\"StaticWindowMapManager\", \"SlidingWindowMapManager\", \"WindowCursor\"]\n#{ Utilities\n\n#}END utilities\n\n\nclass WindowCursor:\n\n \"\"\"\n Pointer into the mapped region of the memory manager, keeping the map\n alive until it is destroyed and no other client uses it.\n\n Cursors should not be created manually, but are instead returned by the SlidingWindowMapManager\n\n **Note:**: The current implementation is suited for static and sliding window managers, but it also means\n that it must be suited for the somewhat quite different sliding manager. It could be improved, but\n I see no real need to do so.\"\"\"\n __slots__ = (\n '_manager', # the manager keeping all file regions\n '_rlist', # a regions list with regions for our file\n '_region', # our current class:`MapRegion` or None\n '_ofs', # relative offset from the actually mapped area to our start area\n '_size' # maximum size we should provide\n )\n\n def __init__(self, manager=None, regions=None):\n self._manager = manager\n self._rlist = regions\n self._region = None\n self._ofs = 0\n self._size = 0\n\n def __del__(self):\n self._destroy()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self._destroy()\n\n def _destroy(self):\n \"\"\"Destruction code to decrement counters\"\"\"\n self.unuse_region()\n\n if self._rlist is not None:\n # Actual client count, which doesn't include the reference kept by the manager, nor ours\n # as we are about to be deleted\n try:\n if len(self._rlist) == 0:\n # Free all resources associated with the mapped file\n self._manager._fdict.pop(self._rlist.path_or_fd())\n # END remove regions list from manager\n except (TypeError, KeyError):\n # sometimes, during shutdown, getrefcount is None. Its possible\n # to re-import it, however, its probably better to just ignore\n # this python problem (for now).\n # The next step is to get rid of the error prone getrefcount altogether.\n pass\n # END exception handling\n # END handle regions\n\n def _copy_from(self, rhs):\n \"\"\"Copy all data from rhs into this instance, handles usage count\"\"\"\n self._manager = rhs._manager\n self._rlist = type(rhs._rlist)(rhs._rlist)\n self._region = rhs._region\n self._ofs = rhs._ofs\n self._size = rhs._size\n\n for region in self._rlist:\n region.increment_client_count()\n\n if self._region is not None:\n self._region.increment_client_count()\n # END handle regions\n\n def __copy__(self):\n \"\"\"copy module interface\"\"\"\n cpy = type(self)()\n cpy._copy_from(self)\n return cpy\n\n #{ Interface\n def assign(self, rhs):\n \"\"\"Assign rhs to this instance. This is required in order to get a real copy.\n Alternatively, you can copy an existing instance using the copy module\"\"\"\n self._destroy()\n self._copy_from(rhs)\n\n def use_region(self, offset=0, size=0, flags=0):\n \"\"\"Assure we point to a window which allows access to the given offset into the file\n\n :param offset: absolute offset in bytes into the file\n :param size: amount of bytes to map. If 0, all available bytes will be mapped\n :param flags: additional flags to be given to os.open in case a file handle is initially opened\n for mapping. Has no effect if a region can actually be reused.\n :return: this instance - it should be queried for whether it points to a valid memory region.\n This is not the case if the mapping failed because we reached the end of the file\n\n **Note:**: The size actually mapped may be smaller than the given size. If that is the case,\n either the file has reached its end, or the map was created between two existing regions\"\"\"\n need_region = True\n man = self._manager\n fsize = self._rlist.file_size()\n size = min(size or fsize, man.window_size() or fsize) # clamp size to window size\n\n if self._region is not None:\n if self._region.includes_ofs(offset):\n need_region = False\n else:\n self.unuse_region()\n # END handle existing region\n # END check existing region\n\n # offset too large ?\n if offset >= fsize:\n return self\n # END handle offset\n\n if need_region:\n self._region = man._obtain_region(self._rlist, offset, size, flags, False)\n self._region.increment_client_count()\n # END need region handling\n\n self._ofs = offset - self._region._b\n self._size = min(size, self._region.ofs_end() - offset)\n\n return self\n\n def unuse_region(self):\n \"\"\"Unuse the current region. Does nothing if we have no current region\n\n **Note:** the cursor unuses the region automatically upon destruction. It is recommended\n to un-use the region once you are done reading from it in persistent cursors as it\n helps to free up resource more quickly\"\"\"\n if self._region is not None:\n self._region.increment_client_count(-1)\n self._region = None\n # note: should reset ofs and size, but we spare that for performance. Its not\n # allowed to query information if we are not valid !\n\n def buffer(self):\n \"\"\"Return a buffer object which allows access to our memory region from our offset\n to the window size. Please note that it might be smaller than you requested when calling use_region()\n\n **Note:** You can only obtain a buffer if this instance is_valid() !\n\n **Note:** buffers should not be cached passed the duration of your access as it will\n prevent resources from being freed even though they might not be accounted for anymore !\"\"\"\n return memoryview(self._region.buffer())[self._ofs:self._ofs+self._size]\n\n def map(self):\n \"\"\"\n :return: the underlying raw memory map. Please not that the offset and size is likely to be different\n to what you set as offset and size. Use it only if you are sure about the region it maps, which is the whole\n file in case of StaticWindowMapManager\"\"\"\n return self._region.map()\n\n def is_valid(self):\n \"\"\":return: True if we have a valid and usable region\"\"\"\n return self._region is not None\n\n def is_associated(self):\n \"\"\":return: True if we are associated with a specific file already\"\"\"\n return self._rlist is not None\n\n def ofs_begin(self):\n \"\"\":return: offset to the first byte pointed to by our cursor\n\n **Note:** only if is_valid() is True\"\"\"\n return self._region._b + self._ofs\n\n def ofs_end(self):\n \"\"\":return: offset to one past the last available byte\"\"\"\n # unroll method calls for performance !\n return self._region._b + self._ofs + self._size\n\n def size(self):\n \"\"\":return: amount of bytes we point to\"\"\"\n return self._size\n\n def region(self):\n \"\"\":return: our mapped region, or None if nothing is mapped yet\n :raise AssertionError: if we have no current region. This is only useful for debugging\"\"\"\n return self._region\n\n def includes_ofs(self, ofs):\n \"\"\":return: True if the given absolute offset is contained in the cursors\n current region\n\n **Note:** cursor must be valid for this to work\"\"\"\n # unroll methods\n return (self._region._b + self._ofs) <= ofs < (self._region._b + self._ofs + self._size)\n\n def file_size(self):\n \"\"\":return: size of the underlying file\"\"\"\n return self._rlist.file_size()\n\n def path_or_fd(self):\n \"\"\":return: path or file descriptor of the underlying mapped file\"\"\"\n return self._rlist.path_or_fd()\n\n def path(self):\n \"\"\":return: path of the underlying mapped file\n :raise ValueError: if attached path is not a path\"\"\"\n if isinstance(self._rlist.path_or_fd(), int):\n raise ValueError(\"Path queried although mapping was applied to a file descriptor\")\n # END handle type\n return self._rlist.path_or_fd()\n\n def fd(self):\n \"\"\":return: file descriptor used to create the underlying mapping.\n\n **Note:** it is not required to be valid anymore\n :raise ValueError: if the mapping was not created by a file descriptor\"\"\"\n if isinstance(self._rlist.path_or_fd(), str):\n raise ValueError(\"File descriptor queried although mapping was generated from path\")\n # END handle type\n return self._rlist.path_or_fd()\n\n #} END interface\n\n\nclass StaticWindowMapManager:\n\n \"\"\"Provides a manager which will produce single size cursors that are allowed\n to always map the whole file.\n\n Clients must be written to specifically know that they are accessing their data\n through a StaticWindowMapManager, as they otherwise have to deal with their window size.\n\n These clients would have to use a SlidingWindowMapBuffer to hide this fact.\n\n This type will always use a maximum window size, and optimize certain methods to\n accommodate this fact\"\"\"\n\n __slots__ = [\n '_fdict', # mapping of path -> StorageHelper (of some kind\n '_window_size', # maximum size of a window\n '_max_memory_size', # maximum amount of memory we may allocate\n '_max_handle_count', # maximum amount of handles to keep open\n '_memory_size', # currently allocated memory size\n '_handle_count', # amount of currently allocated file handles\n ]\n\n #{ Configuration\n MapRegionListCls = MapRegionList\n MapWindowCls = MapWindow\n MapRegionCls = MapRegion\n WindowCursorCls = WindowCursor\n #} END configuration\n\n _MB_in_bytes = 1024 * 1024\n\n def __init__(self, window_size=0, max_memory_size=0, max_open_handles=sys.maxsize):\n \"\"\"initialize the manager with the given parameters.\n :param window_size: if -1, a default window size will be chosen depending on\n the operating system's architecture. It will internally be quantified to a multiple of the page size\n If 0, the window may have any size, which basically results in mapping the whole file at one\n :param max_memory_size: maximum amount of memory we may map at once before releasing mapped regions.\n If 0, a viable default will be set depending on the system's architecture.\n It is a soft limit that is tried to be kept, but nothing bad happens if we have to over-allocate\n :param max_open_handles: if not maxint, limit the amount of open file handles to the given number.\n Otherwise the amount is only limited by the system itself. If a system or soft limit is hit,\n the manager will free as many handles as possible\"\"\"\n self._fdict = dict()\n self._window_size = window_size\n self._max_memory_size = max_memory_size\n self._max_handle_count = max_open_handles\n self._memory_size = 0\n self._handle_count = 0\n\n if window_size < 0:\n coeff = 64\n if is_64_bit():\n coeff = 1024\n # END handle arch\n self._window_size = coeff * self._MB_in_bytes\n # END handle max window size\n\n if max_memory_size == 0:\n coeff = 1024\n if is_64_bit():\n coeff = 8192\n # END handle arch\n self._max_memory_size = coeff * self._MB_in_bytes\n # END handle max memory size\n\n #{ Internal Methods\n\n def _collect_lru_region(self, size):\n \"\"\"Unmap the region which was least-recently used and has no client\n :param size: size of the region we want to map next (assuming its not already mapped partially or full\n if 0, we try to free any available region\n :return: Amount of freed regions\n\n .. Note::\n We don't raise exceptions anymore, in order to keep the system working, allowing temporary overallocation.\n If the system runs out of memory, it will tell.\n\n .. TODO::\n implement a case where all unusued regions are discarded efficiently.\n Currently its only brute force\n \"\"\"\n num_found = 0\n while (size == 0) or (self._memory_size + size > self._max_memory_size):\n lru_region = None\n lru_list = None\n for regions in self._fdict.values():\n for region in regions:\n # check client count - if it's 1, it's just us\n if (region.client_count() == 1 and\n (lru_region is None or region._uc < lru_region._uc)):\n lru_region = region\n lru_list = regions\n # END update lru_region\n # END for each region\n # END for each regions list\n\n if lru_region is None:\n break\n # END handle region not found\n\n num_found += 1\n del(lru_list[lru_list.index(lru_region)])\n lru_region.increment_client_count(-1)\n self._memory_size -= lru_region.size()\n self._handle_count -= 1\n # END while there is more memory to free\n return num_found\n\n def _obtain_region(self, a, offset, size, flags, is_recursive):\n \"\"\"Utility to create a new region - for more information on the parameters,\n see MapCursor.use_region.\n :param a: A regions (a)rray\n :return: The newly created region\"\"\"\n if self._memory_size + size > self._max_memory_size:\n self._collect_lru_region(size)\n # END handle collection\n\n r = None\n if a:\n assert len(a) == 1\n r = a[0]\n else:\n try:\n r = self.MapRegionCls(a.path_or_fd(), 0, sys.maxsize, flags)\n except Exception:\n # apparently we are out of system resources or hit a limit\n # As many more operations are likely to fail in that condition (\n # like reading a file from disk, etc) we free up as much as possible\n # As this invalidates our insert position, we have to recurse here\n if is_recursive:\n # we already tried this, and still have no success in obtaining\n # a mapping. This is an exception, so we propagate it\n raise\n # END handle existing recursion\n self._collect_lru_region(0)\n return self._obtain_region(a, offset, size, flags, True)\n # END handle exceptions\n\n self._handle_count += 1\n self._memory_size += r.size()\n a.append(r)\n # END handle array\n\n assert r.includes_ofs(offset)\n return r\n\n #}END internal methods\n\n #{ Interface\n def make_cursor(self, path_or_fd):\n \"\"\"\n :return: a cursor pointing to the given path or file descriptor.\n It can be used to map new regions of the file into memory\n\n **Note:** if a file descriptor is given, it is assumed to be open and valid,\n but may be closed afterwards. To refer to the same file, you may reuse\n your existing file descriptor, but keep in mind that new windows can only\n be mapped as long as it stays valid. This is why the using actual file paths\n are preferred unless you plan to keep the file descriptor open.\n\n **Note:** file descriptors are problematic as they are not necessarily unique, as two\n different files opened and closed in succession might have the same file descriptor id.\n\n **Note:** Using file descriptors directly is faster once new windows are mapped as it\n prevents the file to be opened again just for the purpose of mapping it.\"\"\"\n regions = self._fdict.get(path_or_fd)\n if regions is None:\n regions = self.MapRegionListCls(path_or_fd)\n self._fdict[path_or_fd] = regions\n # END obtain region for path\n return self.WindowCursorCls(self, regions)\n\n def collect(self):\n \"\"\"Collect all available free-to-collect mapped regions\n :return: Amount of freed handles\"\"\"\n return self._collect_lru_region(0)\n\n def num_file_handles(self):\n \"\"\":return: amount of file handles in use. Each mapped region uses one file handle\"\"\"\n return self._handle_count\n\n def num_open_files(self):\n \"\"\"Amount of opened files in the system\"\"\"\n return reduce(lambda x, y: x + y, (1 for rlist in self._fdict.values() if len(rlist) > 0), 0)\n\n def window_size(self):\n \"\"\":return: size of each window when allocating new regions\"\"\"\n return self._window_size\n\n def mapped_memory_size(self):\n \"\"\":return: amount of bytes currently mapped in total\"\"\"\n return self._memory_size\n\n def max_file_handles(self):\n \"\"\":return: maximum amount of handles we may have opened\"\"\"\n return self._max_handle_count\n\n def max_mapped_memory_size(self):\n \"\"\":return: maximum amount of memory we may allocate\"\"\"\n return self._max_memory_size\n\n #} END interface\n\n #{ Special Purpose Interface\n\n def force_map_handle_removal_win(self, base_path):\n \"\"\"ONLY AVAILABLE ON WINDOWS\n On windows removing files is not allowed if anybody still has it opened.\n If this process is ourselves, and if the whole process uses this memory\n manager (as far as the parent framework is concerned) we can enforce\n closing all memory maps whose path matches the given base path to\n allow the respective operation after all.\n The respective system must NOT access the closed memory regions anymore !\n This really may only be used if you know that the items which keep\n the cursors alive will not be using it anymore. They need to be recreated !\n :return: Amount of closed handles\n\n **Note:** does nothing on non-windows platforms\"\"\"\n if sys.platform != 'win32':\n return\n # END early bailout\n\n num_closed = 0\n for path, rlist in self._fdict.items():\n if path.startswith(base_path):\n for region in rlist:\n region.release()\n num_closed += 1\n # END path matches\n # END for each path\n return num_closed\n #} END special purpose interface\n\n\nclass SlidingWindowMapManager(StaticWindowMapManager):\n\n \"\"\"Maintains a list of ranges of mapped memory regions in one or more files and allows to easily\n obtain additional regions assuring there is no overlap.\n Once a certain memory limit is reached globally, or if there cannot be more open file handles\n which result from each mmap call, the least recently used, and currently unused mapped regions\n are unloaded automatically.\n\n **Note:** currently not thread-safe !\n\n **Note:** in the current implementation, we will automatically unload windows if we either cannot\n create more memory maps (as the open file handles limit is hit) or if we have allocated more than\n a safe amount of memory already, which would possibly cause memory allocations to fail as our address\n space is full.\"\"\"\n\n __slots__ = tuple()\n\n def __init__(self, window_size=-1, max_memory_size=0, max_open_handles=sys.maxsize):\n \"\"\"Adjusts the default window size to -1\"\"\"\n super().__init__(window_size, max_memory_size, max_open_handles)\n\n def _obtain_region(self, a, offset, size, flags, is_recursive):\n # bisect to find an existing region. The c++ implementation cannot\n # do that as it uses a linked list for regions.\n r = None\n lo = 0\n hi = len(a)\n while lo < hi:\n mid = (lo + hi) // 2\n ofs = a[mid]._b\n if ofs <= offset:\n if a[mid].includes_ofs(offset):\n r = a[mid]\n break\n # END have region\n lo = mid + 1\n else:\n hi = mid\n # END handle position\n # END while bisecting\n\n if r is None:\n window_size = self._window_size\n left = self.MapWindowCls(0, 0)\n mid = self.MapWindowCls(offset, size)\n right = self.MapWindowCls(a.file_size(), 0)\n\n # we want to honor the max memory size, and assure we have anough\n # memory available\n # Save calls !\n if self._memory_size + window_size > self._max_memory_size:\n self._collect_lru_region(window_size)\n # END handle collection\n\n # we assume the list remains sorted by offset\n insert_pos = 0\n len_regions = len(a)\n if len_regions == 1:\n if a[0]._b <= offset:\n insert_pos = 1\n # END maintain sort\n else:\n # find insert position\n insert_pos = len_regions\n for i, region in enumerate(a):\n if region._b > offset:\n insert_pos = i\n break\n # END if insert position is correct\n # END for each region\n # END obtain insert pos\n\n # adjust the actual offset and size values to create the largest\n # possible mapping\n if insert_pos == 0:\n if len_regions:\n right = self.MapWindowCls.from_region(a[insert_pos])\n # END adjust right side\n else:\n if insert_pos != len_regions:\n right = self.MapWindowCls.from_region(a[insert_pos])\n # END adjust right window\n left = self.MapWindowCls.from_region(a[insert_pos - 1])\n # END adjust surrounding windows\n\n mid.extend_left_to(left, window_size)\n mid.extend_right_to(right, window_size)\n mid.align()\n\n # it can happen that we align beyond the end of the file\n if mid.ofs_end() > right.ofs:\n mid.size = right.ofs - mid.ofs\n # END readjust size\n\n # insert new region at the right offset to keep the order\n try:\n if self._handle_count >= self._max_handle_count:\n raise Exception\n # END assert own imposed max file handles\n r = self.MapRegionCls(a.path_or_fd(), mid.ofs, mid.size, flags)\n except Exception:\n # apparently we are out of system resources or hit a limit\n # As many more operations are likely to fail in that condition (\n # like reading a file from disk, etc) we free up as much as possible\n # As this invalidates our insert position, we have to recurse here\n if is_recursive:\n # we already tried this, and still have no success in obtaining\n # a mapping. This is an exception, so we propagate it\n raise\n # END handle existing recursion\n self._collect_lru_region(0)\n return self._obtain_region(a, offset, size, flags, True)\n # END handle exceptions\n\n self._handle_count += 1\n self._memory_size += r.size()\n a.insert(insert_pos, r)\n # END create new region\n return r\n\n[end of smmap/mman.py]","filename":"smmap/mman.py","id":"10"},{"content":"\"\"\"Module with a simple buffer implementation using the memory manager\"\"\"\nimport sys\n\n__all__ = [\"SlidingWindowMapBuffer\"]\n\n\nclass SlidingWindowMapBuffer:\n\n \"\"\"A buffer like object which allows direct byte-wise object and slicing into\n memory of a mapped file. The mapping is controlled by the provided cursor.\n\n The buffer is relative, that is if you map an offset, index 0 will map to the\n first byte at the offset you used during initialization or begin_access\n\n **Note:** Although this type effectively hides the fact that there are mapped windows\n underneath, it can unfortunately not be used in any non-pure python method which\n needs a buffer or string\"\"\"\n __slots__ = (\n '_c', # our cursor\n '_size', # our supposed size\n )\n\n def __init__(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\n \"\"\"Initialize the instance to operate on the given cursor.\n :param cursor: if not None, the associated cursor to the file you want to access\n If None, you have call begin_access before using the buffer and provide a cursor\n :param offset: absolute offset in bytes\n :param size: the total size of the mapping. Defaults to the maximum possible size\n From that point on, the __len__ of the buffer will be the given size or the file size.\n If the size is larger than the mappable area, you can only access the actually available\n area, although the length of the buffer is reported to be your given size.\n Hence it is in your own interest to provide a proper size !\n :param flags: Additional flags to be passed to os.open\n :raise ValueError: if the buffer could not achieve a valid state\"\"\"\n self._c = cursor\n if cursor and not self.begin_access(cursor, offset, size, flags):\n raise ValueError(\"Failed to allocate the buffer - probably the given offset is out of bounds\")\n # END handle offset\n\n def __del__(self):\n self.end_access()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self.end_access()\n\n def __len__(self):\n return self._size\n\n def __getitem__(self, i):\n if isinstance(i, slice):\n return self.__getslice__(i.start or 0, i.stop or self._size)\n c = self._c\n assert c.is_valid()\n if i < 0:\n i = self._size + i\n if not c.includes_ofs(i):\n c.use_region(i, 1)\n # END handle region usage\n return c.buffer()[i - c.ofs_begin()]\n\n def __getslice__(self, i, j):\n c = self._c\n # fast path, slice fully included - safes a concatenate operation and\n # should be the default\n assert c.is_valid()\n if i < 0:\n i = self._size + i\n if j == sys.maxsize:\n j = self._size\n if j < 0:\n j = self._size + j\n if (c.ofs_begin() <= i) and (j < c.ofs_end()):\n b = c.ofs_begin()\n return c.buffer()[i - b:j - b]\n else:\n l = j - i # total length\n ofs = i\n # It's fastest to keep tokens and join later, especially in py3, which was 7 times slower\n # in the previous iteration of this code\n md = list()\n while l:\n c.use_region(ofs, l)\n assert c.is_valid()\n d = c.buffer()[:l]\n ofs += len(d)\n l -= len(d)\n # Make sure we don't keep references, as c.use_region() might attempt to free resources, but\n # can't unless we use pure bytes\n if hasattr(d, 'tobytes'):\n d = d.tobytes()\n md.append(d)\n # END while there are bytes to read\n return b''.join(md)\n # END fast or slow path\n #{ Interface\n\n def begin_access(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\n \"\"\"Call this before the first use of this instance. The method was already\n called by the constructor in case sufficient information was provided.\n\n For more information no the parameters, see the __init__ method\n :param path: if cursor is None the existing one will be used.\n :return: True if the buffer can be used\"\"\"\n if cursor:\n self._c = cursor\n # END update our cursor\n\n # reuse existing cursors if possible\n if self._c is not None and self._c.is_associated():\n res = self._c.use_region(offset, size, flags).is_valid()\n if res:\n # if given size is too large or default, we computer a proper size\n # If its smaller, we assume the combination between offset and size\n # as chosen by the user is correct and use it !\n # If not, the user is in trouble.\n if size > self._c.file_size():\n size = self._c.file_size() - offset\n # END handle size\n self._size = size\n # END set size\n return res\n # END use our cursor\n return False\n\n def end_access(self):\n \"\"\"Call this method once you are done using the instance. It is automatically\n called on destruction, and should be called just in time to allow system\n resources to be freed.\n\n Once you called end_access, you must call begin access before reusing this instance!\"\"\"\n self._size = 0\n if self._c is not None:\n self._c.unuse_region()\n # END unuse region\n\n def cursor(self):\n \"\"\":return: the currently set cursor which provides access to the data\"\"\"\n return self._c\n\n #}END interface\n\n[end of smmap/buf.py]","filename":"smmap/buf.py","id":"11"},{"content":"\"\"\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\"\"\"\nimport os\nimport sys\n\nfrom mmap import mmap, ACCESS_READ\nfrom mmap import ALLOCATIONGRANULARITY\n\n__all__ = [\"align_to_mmap\", \"is_64_bit\",\n \"MapWindow\", \"MapRegion\", \"MapRegionList\", \"ALLOCATIONGRANULARITY\"]\n\n#{ Utilities\n\n\ndef align_to_mmap(num, round_up):\n \"\"\"\n Align the given integer number to the closest page offset, which usually is 4096 bytes.\n\n :param round_up: if True, the next higher multiple of page size is used, otherwise\n the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)\n :return: num rounded to closest page\"\"\"\n res = (num // ALLOCATIONGRANULARITY) * ALLOCATIONGRANULARITY\n if round_up and (res != num):\n res += ALLOCATIONGRANULARITY\n # END handle size\n return res\n\n\ndef is_64_bit():\n \"\"\":return: True if the system is 64 bit. Otherwise it can be assumed to be 32 bit\"\"\"\n return sys.maxsize > (1 << 32) - 1\n\n#}END utilities\n\n\n#{ Utility Classes\n\nclass MapWindow:\n\n \"\"\"Utility type which is used to snap windows towards each other, and to adjust their size\"\"\"\n __slots__ = (\n 'ofs', # offset into the file in bytes\n 'size' # size of the window in bytes\n )\n\n def __init__(self, offset, size):\n self.ofs = offset\n self.size = size\n\n def __repr__(self):\n return \"MapWindow(%i, %i)\" % (self.ofs, self.size)\n\n @classmethod\n def from_region(cls, region):\n \"\"\":return: new window from a region\"\"\"\n return cls(region._b, region.size())\n\n def ofs_end(self):\n return self.ofs + self.size\n\n def align(self):\n \"\"\"Assures the previous window area is contained in the new one\"\"\"\n nofs = align_to_mmap(self.ofs, 0)\n self.size += self.ofs - nofs # keep size constant\n self.ofs = nofs\n self.size = align_to_mmap(self.size, 1)\n\n def extend_left_to(self, window, max_size):\n \"\"\"Adjust the offset to start where the given window on our left ends if possible,\n but don't make yourself larger than max_size.\n The resize will assure that the new window still contains the old window area\"\"\"\n rofs = self.ofs - window.ofs_end()\n nsize = rofs + self.size\n rofs -= nsize - min(nsize, max_size)\n self.ofs -= rofs\n self.size += rofs\n\n def extend_right_to(self, window, max_size):\n \"\"\"Adjust the size to make our window end where the right window begins, but don't\n get larger than max_size\"\"\"\n self.size = min(self.size + (window.ofs - self.ofs_end()), max_size)\n\n\nclass MapRegion:\n\n \"\"\"Defines a mapped region of memory, aligned to pagesizes\n\n **Note:** deallocates used region automatically on destruction\"\"\"\n __slots__ = [\n '_b', # beginning of mapping\n '_mf', # mapped memory chunk (as returned by mmap)\n '_uc', # total amount of usages\n '_size', # cached size of our memory map\n '__weakref__'\n ]\n\n #{ Configuration\n #} END configuration\n\n def __init__(self, path_or_fd, ofs, size, flags=0):\n \"\"\"Initialize a region, allocate the memory map\n :param path_or_fd: path to the file to map, or the opened file descriptor\n :param ofs: **aligned** offset into the file to be mapped\n :param size: if size is larger then the file on disk, the whole file will be\n allocated the the size automatically adjusted\n :param flags: additional flags to be given when opening the file.\n :raise Exception: if no memory can be allocated\"\"\"\n self._b = ofs\n self._size = 0\n self._uc = 0\n\n if isinstance(path_or_fd, int):\n fd = path_or_fd\n else:\n fd = os.open(path_or_fd, os.O_RDONLY | getattr(os, 'O_BINARY', 0) | flags)\n # END handle fd\n\n try:\n kwargs = dict(access=ACCESS_READ, offset=ofs)\n corrected_size = size\n sizeofs = ofs\n\n # have to correct size, otherwise (instead of the c version) it will\n # bark that the size is too large ... many extra file accesses because\n # if this ... argh !\n actual_size = min(os.fstat(fd).st_size - sizeofs, corrected_size)\n self._mf = mmap(fd, actual_size, **kwargs)\n # END handle memory mode\n\n self._size = len(self._mf)\n finally:\n if isinstance(path_or_fd, str):\n os.close(fd)\n # END only close it if we opened it\n # END close file handle\n # We assume the first one to use us keeps us around\n self.increment_client_count()\n\n def __repr__(self):\n return \"MapRegion<%i, %i>\" % (self._b, self.size())\n\n #{ Interface\n\n def buffer(self):\n \"\"\":return: a buffer containing the memory\"\"\"\n return self._mf\n\n def map(self):\n \"\"\":return: a memory map containing the memory\"\"\"\n return self._mf\n\n def ofs_begin(self):\n \"\"\":return: absolute byte offset to the first byte of the mapping\"\"\"\n return self._b\n\n def size(self):\n \"\"\":return: total size of the mapped region in bytes\"\"\"\n return self._size\n\n def ofs_end(self):\n \"\"\":return: Absolute offset to one byte beyond the mapping into the file\"\"\"\n return self._b + self._size\n\n def includes_ofs(self, ofs):\n \"\"\":return: True if the given offset can be read in our mapped region\"\"\"\n return self._b <= ofs < self._b + self._size\n\n def client_count(self):\n \"\"\":return: number of clients currently using this region\"\"\"\n return self._uc\n\n def increment_client_count(self, ofs = 1):\n \"\"\"Adjust the usage count by the given positive or negative offset.\n If usage count equals 0, we will auto-release our resources\n :return: True if we released resources, False otherwise. In the latter case, we can still be used\"\"\"\n self._uc += ofs\n assert self._uc > -1, \"Increments must match decrements, usage counter negative: %i\" % self._uc\n\n if self.client_count() == 0:\n self.release()\n return True\n else:\n return False\n # end handle release\n\n def release(self):\n \"\"\"Release all resources this instance might hold. Must only be called if there usage_count() is zero\"\"\"\n self._mf.close()\n\n #} END interface\n\n\nclass MapRegionList(list):\n\n \"\"\"List of MapRegion instances associating a path with a list of regions.\"\"\"\n __slots__ = (\n '_path_or_fd', # path or file descriptor which is mapped by all our regions\n '_file_size' # total size of the file we map\n )\n\n def __new__(cls, path):\n return super().__new__(cls)\n\n def __init__(self, path_or_fd):\n self._path_or_fd = path_or_fd\n self._file_size = None\n\n def path_or_fd(self):\n \"\"\":return: path or file descriptor we are attached to\"\"\"\n return self._path_or_fd\n\n def file_size(self):\n \"\"\":return: size of file we manager\"\"\"\n if self._file_size is None:\n if isinstance(self._path_or_fd, str):\n self._file_size = os.stat(self._path_or_fd).st_size\n else:\n self._file_size = os.fstat(self._path_or_fd).st_size\n # END handle path type\n # END update file size\n return self._file_size\n\n#} END utility classes\n\n[end of smmap/util.py]","filename":"smmap/util.py","id":"12"},{"content":"\"\"\"Initialize the smmap package\"\"\"\n\n__author__ = \"Sebastian Thiel\"\n__contact__ = \"byronimo@gmail.com\"\n__homepage__ = \"https://github.com/gitpython-developers/smmap\"\nversion_info = (5, 0, 2)\n__version__ = '.'.join(str(i) for i in version_info)\n\n# make everything available in root package for convenience\nfrom .mman import *\nfrom .buf import *\n\n[end of smmap/__init__.py]","filename":"smmap/__init__.py","id":"13"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = build\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\n\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\t-rm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make all-pdf' or \\`make all-ps' in that directory to\" \\\n\t \"run these through (pdf)latex.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\n[end of doc/Makefile]","filename":"doc/Makefile","id":"14"},{"content":"@ECHO OFF\n\nREM Command file for Sphinx documentation\n\nset SPHINXBUILD=sphinx-build\nset BUILDDIR=build\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\nif NOT \"%PAPER%\" == \"\" (\n\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\n)\n\nif \"%1\" == \"\" goto help\n\nif \"%1\" == \"help\" (\n\t:help\n\techo.Please use `make ^<target^>` where ^<target^> is one of\n\techo. html to make standalone HTML files\n\techo. dirhtml to make HTML files named index.html in directories\n\techo. pickle to make pickle files\n\techo. json to make JSON files\n\techo. htmlhelp to make HTML files and a HTML help project\n\techo. qthelp to make HTML files and a qthelp project\n\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\n\techo. changes to make an overview over all changed/added/deprecated items\n\techo. linkcheck to check all external links for integrity\n\techo. doctest to run all doctests embedded in the documentation if enabled\n\tgoto end\n)\n\nif \"%1\" == \"clean\" (\n\tfor /d %%i in (%BUILDDIR%\\*) do rmdir /q /s %%i\n\tdel /q /s %BUILDDIR%\\*\n\tgoto end\n)\n\nif \"%1\" == \"html\" (\n\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\n\tgoto end\n)\n\nif \"%1\" == \"dirhtml\" (\n\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\n\tgoto end\n)\n\nif \"%1\" == \"pickle\" (\n\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\n\techo.\n\techo.Build finished; now you can process the pickle files.\n\tgoto end\n)\n\nif \"%1\" == \"json\" (\n\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\n\techo.\n\techo.Build finished; now you can process the JSON files.\n\tgoto end\n)\n\nif \"%1\" == \"htmlhelp\" (\n\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\n\techo.\n\techo.Build finished; now you can run HTML Help Workshop with the ^\n.hhp project file in %BUILDDIR%/htmlhelp.\n\tgoto end\n)\n\nif \"%1\" == \"qthelp\" (\n\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\n\techo.\n\techo.Build finished; now you can run \"qcollectiongenerator\" with the ^\n.qhcp project file in %BUILDDIR%/qthelp, like this:\n\techo.^> qcollectiongenerator %BUILDDIR%\\qthelp\\smmap.qhcp\n\techo.To view the help file:\n\techo.^> assistant -collectionFile %BUILDDIR%\\qthelp\\smmap.ghc\n\tgoto end\n)\n\nif \"%1\" == \"latex\" (\n\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\n\techo.\n\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\n\tgoto end\n)\n\nif \"%1\" == \"changes\" (\n\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\n\techo.\n\techo.The overview file is in %BUILDDIR%/changes.\n\tgoto end\n)\n\nif \"%1\" == \"linkcheck\" (\n\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\n\techo.\n\techo.Link check complete; look for any errors in the above output ^\nor in %BUILDDIR%/linkcheck/output.txt.\n\tgoto end\n)\n\nif \"%1\" == \"doctest\" (\n\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\n\techo.\n\techo.Testing of doctests in the sources finished, look at the ^\nresults in %BUILDDIR%/doctest/output.txt.\n\tgoto end\n)\n\n:end\n\n[end of doc/make.bat]","filename":"doc/make.bat","id":"15"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.mman import (\n WindowCursor,\n SlidingWindowMapManager,\n StaticWindowMapManager\n)\nfrom smmap.util import align_to_mmap\n\nfrom random import randint\nfrom time import time\nimport os\nimport sys\nfrom copy import copy\n\n\nclass TestMMan(TestBase):\n\n def test_cursor(self):\n with FileCreator(self.k_window_test_size, \"cursor_test\") as fc:\n man = SlidingWindowMapManager()\n ci = WindowCursor(man) # invalid cursor\n assert not ci.is_valid()\n assert not ci.is_associated()\n assert ci.size() == 0 # this is cached, so we can query it in invalid state\n\n cv = man.make_cursor(fc.path)\n assert not cv.is_valid() # no region mapped yet\n assert cv.is_associated() # but it know where to map it from\n assert cv.file_size() == fc.size\n assert cv.path() == fc.path\n\n # copy module\n cio = copy(cv)\n assert not cio.is_valid() and cio.is_associated()\n\n # assign method\n assert not ci.is_associated()\n ci.assign(cv)\n assert not ci.is_valid() and ci.is_associated()\n\n # unuse non-existing region is fine\n cv.unuse_region()\n cv.unuse_region()\n\n # destruction is fine (even multiple times)\n cv._destroy()\n WindowCursor(man)._destroy()\n\n def test_memory_manager(self):\n slide_man = SlidingWindowMapManager()\n static_man = StaticWindowMapManager()\n\n for man in (static_man, slide_man):\n assert man.num_file_handles() == 0\n assert man.num_open_files() == 0\n winsize_cmp_val = 0\n if isinstance(man, StaticWindowMapManager):\n winsize_cmp_val = -1\n # END handle window size\n assert man.window_size() > winsize_cmp_val\n assert man.mapped_memory_size() == 0\n assert man.max_mapped_memory_size() > 0\n\n # collection doesn't raise in 'any' mode\n man._collect_lru_region(0)\n # doesn't raise if we are within the limit\n man._collect_lru_region(10)\n\n # doesn't fail if we over-allocate\n assert man._collect_lru_region(sys.maxsize) == 0\n\n # use a region, verify most basic functionality\n with FileCreator(self.k_window_test_size, \"manager_test\") as fc:\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n for item in (fc.path, fd):\n c = man.make_cursor(item)\n assert c.path_or_fd() is item\n assert c.use_region(10, 10).is_valid()\n assert c.ofs_begin() == 10\n assert c.size() == 10\n with open(fc.path, 'rb') as fp:\n assert c.buffer()[:] == fp.read(20)[10:]\n\n if isinstance(item, int):\n self.assertRaises(ValueError, c.path)\n else:\n self.assertRaises(ValueError, c.fd)\n # END handle value error\n # END for each input\n finally:\n os.close(fd)\n # END for each manasger type\n\n def test_memman_operation(self):\n # test more access, force it to actually unmap regions\n with FileCreator(self.k_window_test_size, \"manager_operation_test\") as fc:\n with open(fc.path, 'rb') as fp:\n data = fp.read()\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n max_num_handles = 15\n # small_size =\n for mtype, args in ((StaticWindowMapManager, (0, fc.size // 3, max_num_handles)),\n (SlidingWindowMapManager, (fc.size // 100, fc.size // 3, max_num_handles)),):\n for item in (fc.path, fd):\n assert len(data) == fc.size\n\n # small windows, a reasonable max memory. Not too many regions at once\n man = mtype(window_size=args[0], max_memory_size=args[1], max_open_handles=args[2])\n c = man.make_cursor(item)\n\n # still empty (more about that is tested in test_memory_manager()\n assert man.num_open_files() == 0\n assert man.mapped_memory_size() == 0\n\n base_offset = 5000\n # window size is 0 for static managers, hence size will be 0. We take that into consideration\n size = man.window_size() // 2\n assert c.use_region(base_offset, size).is_valid()\n rr = c.region()\n assert rr.client_count() == 2 # the manager and the cursor and us\n\n assert man.num_open_files() == 1\n assert man.num_file_handles() == 1\n assert man.mapped_memory_size() == rr.size()\n\n # assert c.size() == size # the cursor may overallocate in its static version\n assert c.ofs_begin() == base_offset\n assert rr.ofs_begin() == 0 # it was aligned and expanded\n if man.window_size():\n # but isn't larger than the max window (aligned)\n assert rr.size() == align_to_mmap(man.window_size(), True)\n else:\n assert rr.size() == fc.size\n # END ignore static managers which dont use windows and are aligned to file boundaries\n\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\n\n # obtain second window, which spans the first part of the file - it is a still the same window\n nsize = (size or fc.size) - 10\n assert c.use_region(0, nsize).is_valid()\n assert c.region() == rr\n assert man.num_file_handles() == 1\n assert c.size() == nsize\n assert c.ofs_begin() == 0\n assert c.buffer()[:] == data[:nsize]\n\n # map some part at the end, our requested size cannot be kept\n overshoot = 4000\n base_offset = fc.size - (size or c.size()) + overshoot\n assert c.use_region(base_offset, size).is_valid()\n if man.window_size():\n assert man.num_file_handles() == 2\n assert c.size() < size\n assert c.region() is not rr # old region is still available, but has not cursor ref anymore\n assert rr.client_count() == 1 # only held by manager\n else:\n assert c.size() < fc.size\n # END ignore static managers which only have one handle per file\n rr = c.region()\n assert rr.client_count() == 2 # manager + cursor\n assert rr.ofs_begin() < c.ofs_begin() # it should have extended itself to the left\n assert rr.ofs_end() <= fc.size # it cannot be larger than the file\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\n\n # unising a region makes the cursor invalid\n c.unuse_region()\n assert not c.is_valid()\n if man.window_size():\n # but doesn't change anything regarding the handle count - we cache it and only\n # remove mapped regions if we have to\n assert man.num_file_handles() == 2\n # END ignore this for static managers\n\n # iterate through the windows, verify data contents\n # this will trigger map collection after a while\n max_random_accesses = 5000\n num_random_accesses = max_random_accesses\n memory_read = 0\n st = time()\n\n # cache everything to get some more performance\n includes_ofs = c.includes_ofs\n max_mapped_memory_size = man.max_mapped_memory_size()\n max_file_handles = man.max_file_handles()\n mapped_memory_size = man.mapped_memory_size\n num_file_handles = man.num_file_handles\n while num_random_accesses:\n num_random_accesses -= 1\n base_offset = randint(0, fc.size - 1)\n\n # precondition\n if man.window_size():\n assert max_mapped_memory_size >= mapped_memory_size()\n # END statistics will overshoot, which is fine\n assert max_file_handles >= num_file_handles()\n assert c.use_region(base_offset, (size or c.size())).is_valid()\n csize = c.size()\n assert c.buffer()[:] == data[base_offset:base_offset + csize]\n memory_read += csize\n\n assert includes_ofs(base_offset)\n assert includes_ofs(base_offset + csize - 1)\n assert not includes_ofs(base_offset + csize)\n # END while we should do an access\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\n mb = float(1000 * 1000)\n print(\"%s: Read %i mb of memory with %i random on cursor initialized with %s accesses in %fs (%f mb/s)\\n\"\n % (mtype, memory_read / mb, max_random_accesses, type(item), elapsed, (memory_read / mb) / elapsed),\n file=sys.stderr)\n\n # an offset as large as the size doesn't work !\n assert not c.use_region(fc.size, size).is_valid()\n\n # collection - it should be able to collect all\n assert man.num_file_handles()\n assert man.collect()\n assert man.num_file_handles() == 0\n # END for each item\n # END for each manager type\n finally:\n os.close(fd)\n\n[end of smmap/test/test_mman.py]","filename":"smmap/test/test_mman.py","id":"16"},{"content":"\"\"\"Provide base classes for the test system\"\"\"\nfrom unittest import TestCase\nimport os\nimport tempfile\n\n__all__ = ['TestBase', 'FileCreator']\n\n\n#{ Utilities\n\nclass FileCreator:\n\n \"\"\"A instance which creates a temporary file with a prefix and a given size\n and provides this info to the user.\n Once it gets deleted, it will remove the temporary file as well.\"\"\"\n __slots__ = (\"_size\", \"_path\")\n\n def __init__(self, size, prefix=''):\n assert size, \"Require size to be larger 0\"\n\n self._size = size\n\n with tempfile.NamedTemporaryFile(\"wb\", prefix=prefix, delete=False) as file:\n self._path = file.name\n file.seek(size - 1)\n file.write(b'1')\n\n assert os.path.getsize(self.path) == size\n\n def __del__(self):\n try:\n os.remove(self.path)\n except OSError:\n pass\n # END exception handling\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self.__del__()\n\n @property\n def path(self):\n return self._path\n\n @property\n def size(self):\n return self._size\n\n#} END utilities\n\n\nclass TestBase(TestCase):\n\n \"\"\"Foundation used by all tests\"\"\"\n\n #{ Configuration\n k_window_test_size = 1000 * 1000 * 8 + 5195\n #} END configuration\n\n #{ Overrides\n @classmethod\n def setUpAll(cls):\n # nothing for now\n pass\n\n # END overrides\n\n #{ Interface\n\n #} END interface\n\n[end of smmap/test/lib.py]","filename":"smmap/test/lib.py","id":"17"},{"content":"[end of smmap/test/__init__.py]","filename":"smmap/test/__init__.py","id":"18"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.mman import (\n SlidingWindowMapManager,\n StaticWindowMapManager\n)\nfrom smmap.buf import SlidingWindowMapBuffer\n\nfrom random import randint\nfrom time import time\nimport sys\nimport os\n\n\nman_optimal = SlidingWindowMapManager()\nman_worst_case = SlidingWindowMapManager(\n window_size=TestBase.k_window_test_size // 100,\n max_memory_size=TestBase.k_window_test_size // 3,\n max_open_handles=15)\nstatic_man = StaticWindowMapManager()\n\n\nclass TestBuf(TestBase):\n\n def test_basics(self):\n with FileCreator(self.k_window_test_size, \"buffer_test\") as fc:\n\n # invalid paths fail upon construction\n c = man_optimal.make_cursor(fc.path)\n self.assertRaises(ValueError, SlidingWindowMapBuffer, type(c)()) # invalid cursor\n self.assertRaises(ValueError, SlidingWindowMapBuffer, c, fc.size) # offset too large\n\n buf = SlidingWindowMapBuffer() # can create uninitialized buffers\n assert buf.cursor() is None\n\n # can call end access any time\n buf.end_access()\n buf.end_access()\n assert len(buf) == 0\n\n # begin access can revive it, if the offset is suitable\n offset = 100\n assert buf.begin_access(c, fc.size) == False\n assert buf.begin_access(c, offset) == True\n assert len(buf) == fc.size - offset\n assert buf.cursor().is_valid()\n\n # empty begin access keeps it valid on the same path, but alters the offset\n assert buf.begin_access() == True\n assert len(buf) == fc.size\n assert buf.cursor().is_valid()\n\n # simple access\n with open(fc.path, 'rb') as fp:\n data = fp.read()\n assert data[offset] == buf[0]\n assert data[offset:offset * 2] == buf[0:offset]\n\n # negative indices, partial slices\n assert buf[-1] == buf[len(buf) - 1]\n assert buf[-10:] == buf[len(buf) - 10:len(buf)]\n\n # end access makes its cursor invalid\n buf.end_access()\n assert not buf.cursor().is_valid()\n assert buf.cursor().is_associated() # but it remains associated\n\n # an empty begin access fixes it up again\n assert buf.begin_access() == True and buf.cursor().is_valid()\n del(buf) # ends access automatically\n del(c)\n\n assert man_optimal.num_file_handles() == 1\n\n # PERFORMANCE\n # blast away with random access and a full mapping - we don't want to\n # exaggerate the manager's overhead, but measure the buffer overhead\n # We do it once with an optimal setting, and with a worse manager which\n # will produce small mappings only !\n max_num_accesses = 100\n fd = os.open(fc.path, os.O_RDONLY)\n for item in (fc.path, fd):\n for manager, man_id in ((man_optimal, 'optimal'),\n (man_worst_case, 'worst case'),\n (static_man, 'static optimal')):\n buf = SlidingWindowMapBuffer(manager.make_cursor(item))\n assert manager.num_file_handles() == 1\n for access_mode in range(2): # single, multi\n num_accesses_left = max_num_accesses\n num_bytes = 0\n fsize = fc.size\n\n st = time()\n buf.begin_access()\n while num_accesses_left:\n num_accesses_left -= 1\n if access_mode: # multi\n ofs_start = randint(0, fsize)\n ofs_end = randint(ofs_start, fsize)\n d = buf[ofs_start:ofs_end]\n assert len(d) == ofs_end - ofs_start\n assert d == data[ofs_start:ofs_end]\n num_bytes += len(d)\n del d\n else:\n pos = randint(0, fsize)\n assert buf[pos] == data[pos]\n num_bytes += 1\n # END handle mode\n # END handle num accesses\n\n buf.end_access()\n assert manager.num_file_handles()\n assert manager.collect()\n assert manager.num_file_handles() == 0\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\n mb = float(1000 * 1000)\n mode_str = (access_mode and \"slice\") or \"single byte\"\n print(\"%s: Made %i random %s accesses to buffer created from %s reading a total of %f mb in %f s (%f mb/s)\"\n % (man_id, max_num_accesses, mode_str, type(item), num_bytes / mb, elapsed, (num_bytes / mb) / elapsed),\n file=sys.stderr)\n # END handle access mode\n del buf\n # END for each manager\n # END for each input\n os.close(fd)\n\n[end of smmap/test/test_buf.py]","filename":"smmap/test/test_buf.py","id":"19"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.util import (\n MapWindow,\n MapRegion,\n MapRegionList,\n ALLOCATIONGRANULARITY,\n is_64_bit,\n align_to_mmap\n)\n\nimport os\nimport sys\n\n\nclass TestMMan(TestBase):\n\n def test_window(self):\n wl = MapWindow(0, 1) # left\n wc = MapWindow(1, 1) # center\n wc2 = MapWindow(10, 5) # another center\n wr = MapWindow(8000, 50) # right\n\n assert wl.ofs_end() == 1\n assert wc.ofs_end() == 2\n assert wr.ofs_end() == 8050\n\n # extension does nothing if already in place\n maxsize = 100\n wc.extend_left_to(wl, maxsize)\n assert wc.ofs == 1 and wc.size == 1\n wl.extend_right_to(wc, maxsize)\n wl.extend_right_to(wc, maxsize)\n assert wl.ofs == 0 and wl.size == 1\n\n # an actual left extension\n pofs_end = wc2.ofs_end()\n wc2.extend_left_to(wc, maxsize)\n assert wc2.ofs == wc.ofs_end() and pofs_end == wc2.ofs_end()\n\n # respects maxsize\n wc.extend_right_to(wr, maxsize)\n assert wc.ofs == 1 and wc.size == maxsize\n wc.extend_right_to(wr, maxsize)\n assert wc.ofs == 1 and wc.size == maxsize\n\n # without maxsize\n wc.extend_right_to(wr, sys.maxsize)\n assert wc.ofs_end() == wr.ofs and wc.ofs == 1\n\n # extend left\n wr.extend_left_to(wc2, maxsize)\n wr.extend_left_to(wc2, maxsize)\n assert wr.size == maxsize\n\n wr.extend_left_to(wc2, sys.maxsize)\n assert wr.ofs == wc2.ofs_end()\n\n wc.align()\n assert wc.ofs == 0 and wc.size == align_to_mmap(wc.size, True)\n\n def test_region(self):\n with FileCreator(self.k_window_test_size, \"window_test\") as fc:\n half_size = fc.size // 2\n rofs = align_to_mmap(4200, False)\n rfull = MapRegion(fc.path, 0, fc.size)\n rhalfofs = MapRegion(fc.path, rofs, fc.size)\n rhalfsize = MapRegion(fc.path, 0, half_size)\n\n # offsets\n assert rfull.ofs_begin() == 0 and rfull.size() == fc.size\n assert rfull.ofs_end() == fc.size # if this method works, it works always\n\n assert rhalfofs.ofs_begin() == rofs and rhalfofs.size() == fc.size - rofs\n assert rhalfsize.ofs_begin() == 0 and rhalfsize.size() == half_size\n\n assert rfull.includes_ofs(0) and rfull.includes_ofs(fc.size - 1) and rfull.includes_ofs(half_size)\n assert not rfull.includes_ofs(-1) and not rfull.includes_ofs(sys.maxsize)\n\n # auto-refcount\n assert rfull.client_count() == 1\n rfull2 = rfull\n assert rfull.client_count() == 1, \"no auto-counting\"\n\n # window constructor\n w = MapWindow.from_region(rfull)\n assert w.ofs == rfull.ofs_begin() and w.ofs_end() == rfull.ofs_end()\n\n def test_region_list(self):\n with FileCreator(100, \"sample_file\") as fc:\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n for item in (fc.path, fd):\n ml = MapRegionList(item)\n\n assert len(ml) == 0\n assert ml.path_or_fd() == item\n assert ml.file_size() == fc.size\n finally:\n os.close(fd)\n\n def test_util(self):\n assert isinstance(is_64_bit(), bool) # just call it\n assert align_to_mmap(1, False) == 0\n assert align_to_mmap(1, True) == ALLOCATIONGRANULARITY\n\n[end of smmap/test/test_util.py]","filename":"smmap/test/test_util.py","id":"20"},{"content":"from .lib import TestBase\n\n\nclass TestTutorial(TestBase):\n\n def test_example(self):\n # Memory Managers\n ##################\n import smmap\n # This instance should be globally available in your application\n # It is configured to be well suitable for 32-bit or 64 bit applications.\n mman = smmap.SlidingWindowMapManager()\n\n # the manager provides much useful information about its current state\n # like the amount of open file handles or the amount of mapped memory\n assert mman.num_file_handles() == 0\n assert mman.mapped_memory_size() == 0\n # and many more ...\n\n # Cursors\n ##########\n import smmap.test.lib\n with smmap.test.lib.FileCreator(1024 * 1024 * 8, \"test_file\") as fc:\n # obtain a cursor to access some file.\n c = mman.make_cursor(fc.path)\n\n # the cursor is now associated with the file, but not yet usable\n assert c.is_associated()\n assert not c.is_valid()\n\n # before you can use the cursor, you have to specify a window you want to\n # access. The following just says you want as much data as possible starting\n # from offset 0.\n # To be sure your region could be mapped, query for validity\n assert c.use_region().is_valid() # use_region returns self\n\n # once a region was mapped, you must query its dimension regularly\n # to assure you don't try to access its buffer out of its bounds\n assert c.size()\n c.buffer()[0] # first byte\n c.buffer()[1:10] # first 9 bytes\n c.buffer()[c.size() - 1] # last byte\n\n # you can query absolute offsets, and check whether an offset is included\n # in the cursor's data.\n assert c.ofs_begin() < c.ofs_end()\n assert c.includes_ofs(100)\n\n # If you are over out of bounds with one of your region requests, the\n # cursor will be come invalid. It cannot be used in that state\n assert not c.use_region(fc.size, 100).is_valid()\n # map as much as possible after skipping the first 100 bytes\n assert c.use_region(100).is_valid()\n\n # You can explicitly free cursor resources by unusing the cursor's region\n c.unuse_region()\n assert not c.is_valid()\n\n # Buffers\n #########\n # Create a default buffer which can operate on the whole file\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\n\n # you can use it right away\n assert buf.cursor().is_valid()\n\n buf[0] # access the first byte\n buf[-1] # access the last ten bytes on the file\n buf[-10:] # access the last ten bytes\n\n # If you want to keep the instance between different accesses, use the\n # dedicated methods\n buf.end_access()\n assert not buf.cursor().is_valid() # you cannot use the buffer anymore\n assert buf.begin_access(offset=10) # start using the buffer at an offset\n\n[end of smmap/test/test_tutorial.py]","filename":"smmap/test/test_tutorial.py","id":"21"},{"content":".. smmap documentation master file, created by\n sphinx-quickstart on Wed Jun 8 15:14:25 2011.\n You can adapt this file completely to your liking, but it should at least\n contain the root `toctree` directive.\n\nWelcome to smmap's documentation!\n=================================\n**smmap** is a pure python implementation of a sliding memory map to help unifying memory mapped access on 32 and 64 bit systems and to help managing resources more efficiently.\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n \n intro\n tutorial\n api\n changes\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of doc/source/index.rst]","filename":"doc/source/index.rst","id":"22"},{"content":"###########\nMotivation\n###########\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\n\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\n\n########\nOverview\n########\n\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\n\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\n\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\n\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\n\n#############\nPrerequisites\n#############\n* Python 3.7+\n* OSX, Windows or Linux\n\nThe package was tested on all of the previously mentioned configurations.\n\n###########\nLimitations\n###########\n* The memory access is read-only by design.\n\n################\nInstalling smmap\n################\nIts easiest to install smmap using the *pip* program::\n \n $ pip install smmap\n \nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\n\nIf you have downloaded the source archive, the package can be installed by running the ``setup.py`` script::\n \n $ python setup.py install\n\nIt is advised to have a look at the :ref:`Usage Guide <tutorial-label>` for a brief introduction on the different database implementations.\n\n##################\nHomepage and Links\n##################\nThe project is home on github at `https://github.com/gitpython-developers/smmap <https://github.com/gitpython-developers/smmap>`_.\n\nThe latest source can be cloned from github as well:\n\n * git://github.com/gitpython-developers/smmap.git\n \n \nFor support, please use the git-python mailing list:\n\n * http://groups.google.com/group/git-python\n \n\nIssues can be filed on github:\n\n * https://github.com/gitpython-developers/smmap/issues\n \n###################\nLicense Information\n###################\n*smmap* is licensed under the New BSD License.\n\n.. _pip: http://www.pip-installer.org/en/latest/\n\n[end of doc/source/intro.rst]","filename":"doc/source/intro.rst","id":"23"},{"content":"#\n# smmap documentation build configuration file, created by\n# sphinx-quickstart on Wed Jun 8 15:14:25 2011.\n#\n# This file is execfile()d with the current directory set to its containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.append(os.path.abspath('../../'))\n\n# -- General configuration -----------------------------------------------------\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['.templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'smmap'\ncopyright = '2011, Sebastian Thiel'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.8.0'\n# The full version, including alpha/beta/rc tags.\nrelease = '0.8.0'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of documents that shouldn't be included in the build.\n#unused_docs = []\n\n# List of directories, relative to source directory, that shouldn't be searched\n# for source files.\nexclude_trees = []\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. Major themes that come with\n# Sphinx are currently 'default' and 'sphinxdoc'.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['.static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_use_modindex = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# If nonempty, this is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = ''\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'smmapdoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\n# The paper size ('letter' or 'a4').\n#latex_paper_size = 'letter'\n\n# The font size ('10pt', '11pt' or '12pt').\n#latex_font_size = '10pt'\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'smmap.tex', 'smmap Documentation',\n 'Sebastian Thiel', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# Additional stuff for the LaTeX preamble.\n#latex_preamble = ''\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_use_modindex = True\n\n[end of doc/source/conf.py]","filename":"doc/source/conf.py","id":"24"},{"content":".. _tutorial-label:\n\n###########\nUsage Guide\n###########\nThis text briefly introduces you to the basic design decisions and accompanying classes.\n\n******\nDesign\n******\nPer application, there is *MemoryManager* which is held as static instance and used throughout the application. It can be configured to keep your resources within certain limits.\n\nTo access mapped regions, you require a cursor. Cursors point to exactly one file and serve as handles into it. As long as it exists, the respective memory region will remain available.\n\nFor convenience, a buffer implementation is provided which handles cursors and resource allocation behind its simple buffer like interface.\n\n***************\nMemory Managers\n***************\nThere are two types of memory managers, one uses *static* windows, the other one uses *sliding* windows. A window is a region of a file mapped into memory. Although the names might be somewhat misleading as technically windows are always static, the *sliding* version will allocate relatively small windows whereas the *static* version will always map the whole file.\n\nThe *static* manager does nothing more than keeping a client count on the respective memory maps which always map the whole file, which allows to make some assumptions that can lead to simplified data access and increased performance, but reduces the compatibility to 32 bit systems or giant files.\n\nThe *sliding* memory manager therefore should be the default manager when preparing an application for handling huge amounts of data on 32 bit and 64 bit platforms::\n\n import smmap\n # This instance should be globally available in your application\n # It is configured to be well suitable for 32-bit or 64 bit applications.\n mman = smmap.SlidingWindowMapManager()\n \n # the manager provides much useful information about its current state\n # like the amount of open file handles or the amount of mapped memory\n mman.num_file_handles()\n mman.mapped_memory_size()\n # and many more ...\n\n\nCursors\n*******\n*Cursors* are handles that point onto a window, i.e. a region of a file mapped into memory. From them you may obtain a buffer through which the data of that window can actually be accessed::\n\n import smmap.test.lib\n fc = smmap.test.lib.FileCreator(1024*1024*8, \"test_file\")\n \n # obtain a cursor to access some file.\n c = mman.make_cursor(fc.path)\n \n # the cursor is now associated with the file, but not yet usable\n assert c.is_associated()\n assert not c.is_valid()\n \n # before you can use the cursor, you have to specify a window you want to \n # access. The following just says you want as much data as possible starting\n # from offset 0.\n # To be sure your region could be mapped, query for validity\n assert c.use_region().is_valid()\t\t# use_region returns self\n \n # once a region was mapped, you must query its dimension regularly\n # to assure you don't try to access its buffer out of its bounds\n assert c.size()\n c.buffer()[0]\t\t\t# first byte\n c.buffer()[1:10]\t\t\t# first 9 bytes\n c.buffer()[c.size()-1] \t# last byte\n \n # its recommended not to create big slices when feeding the buffer\n # into consumers (e.g. struct or zlib). \n # Instead, either give the buffer directly, or use pythons buffer command.\n buffer(c.buffer(), 1, 9)\t# first 9 bytes without copying them\n \n # you can query absolute offsets, and check whether an offset is included\n # in the cursor's data.\n assert c.ofs_begin() < c.ofs_end()\n assert c.includes_ofs(100)\n \n # If you are over out of bounds with one of your region requests, the \n # cursor will be come invalid. It cannot be used in that state\n assert not c.use_region(fc.size, 100).is_valid()\n # map as much as possible after skipping the first 100 bytes\n assert c.use_region(100).is_valid()\n \n # You can explicitly free cursor resources by unusing the cursor's region\n c.unuse_region()\n assert not c.is_valid()\n \n\nNow you would have to write your algorithms around this interface to properly slide through huge amounts of data. \n \nAlternatively you can use a convenience interface.\n\n*******\nBuffers\n*******\nTo make first use easier, at the expense of performance, there is a Buffer implementation which uses a cursor underneath.\n\nWith it, you can access all data in a possibly huge file without having to take care of setting the cursor to different regions yourself::\n\n # Create a default buffer which can operate on the whole file\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\n \n # you can use it right away\n assert buf.cursor().is_valid()\n \n buf[0]\t# access the first byte\n buf[-1]\t# access the last ten bytes on the file\n buf[-10:]# access the last ten bytes\n \n # If you want to keep the instance between different accesses, use the\n # dedicated methods\n buf.end_access()\n assert not buf.cursor().is_valid()\t# you cannot use the buffer anymore\n assert buf.begin_access(offset=10)\t# start using the buffer at an offset\n \n # it will stop using resources automatically once it goes out of scope\n \nDisadvantages\n*************\nBuffers cannot be used in place of strings or maps, hence you have to slice them to have valid input for the sorts of struct and zlib. A slice means a lot of data handling overhead which makes buffers slower compared to using cursors directly. \n\n\n[end of doc/source/tutorial.rst]","filename":"doc/source/tutorial.rst","id":"25"},{"content":"#########\nChangelog\n#########\n\n******\nv5.0.2\n******\n\n- remove a usage of mktemp\n\n******\nv5.0.1\n******\n\n- Added support for Python 3.12\n\n******\nv6.0.0\n******\n\nYANKED\n\n- Dropped support 3.6 and 3.7\n- Declared support for Python 3.11 and 3.12\n\n******\nv5.0.0\n******\n\n- Dropped support 3.5\n- Added support for Python 3.10\n\n******\nv4.0.0\n******\n\n- Dropped support for Python 2.7 and 3.4\n- Added support for Python 3.7, 3.8, and 3.9\n- Removed unused exc.MemoryManagerError and exc.RegionCollectionError\n\n******\nv3.0.5\n******\n\n- Restored Python 2 support removed in v3.0.2\n- Changed release signature key to 27C50E7F590947D7273A741E85194C08421980C9.\n See https://keybase.io/byronbates for proof of ownership.\n\n******\nv3.0.4\n******\n\n- Signed release (with correct key this time)\n\n******\nv3.0.2\n******\n\n- Signed release\n- Switched to GitHub Actions for CI\n\n******\nv3.0.1\n******\n- Switched back to the smmap package name on PyPI and fixed the smmap2 mirror package\n (`#44 <https://github.com/gitpython-developers/smmap/issues/44>`_)\n- Fixed setup.py ``long_description`` rendering\n (`#40 <https://github.com/gitpython-developers/smmap/pull/40>`_)\n\n**********\nv0.9.0\n**********\n- Fixed issue with resources never being freed as mmaps were never closed.\n- Client counting is now done manually, instead of relying on pyton's reference count\n\n**********\nv0.8.5\n**********\n- Fixed Python 3.0-3.3 regression, which also causes smmap to become about 3 times slower depending on the code path. It's related to this bug (http://bugs.python.org/issue15958), which was fixed in python 3.4\n\n**********\nv0.8.4\n**********\n- Fixed Python 3 performance regression\n\n**********\nv0.8.3\n**********\n- Cleaned up code and assured it works sufficiently well with python 3\n\n**********\nv0.8.1\n**********\n- A single bugfix\n\n**********\nv0.8.0 \n**********\n\n- Initial Release\n\n[end of doc/source/changes.rst]","filename":"doc/source/changes.rst","id":"26"},{"content":".. _api-label:\n\n#############\nAPI Reference\n#############\n\n***********************\nMapped Memory Managers\n***********************\n\n.. automodule:: smmap.mman\n :members:\n :undoc-members:\n\n*******\nBuffers\n*******\n\n.. automodule:: smmap.buf\n :members:\n :undoc-members:\n\n*********\nUtilities\n*********\n\n.. automodule:: smmap.util\n :members:\n :undoc-members:\n\n\n\n\n\n\n[end of doc/source/api.rst]","filename":"doc/source/api.rst","id":"27"}],"string":"[\n {\n \"content\": \"Copyright (C) 2010, 2011 Sebastian Thiel and contributors\\nAll rights reserved.\\n\\nRedistribution and use in source and binary forms, with or without \\nmodification, are permitted provided that the following conditions \\nare met:\\n\\n* Redistributions of source code must retain the above copyright \\nnotice, this list of conditions and the following disclaimer.\\n\\n* Redistributions in binary form must reproduce the above copyright \\nnotice, this list of conditions and the following disclaimer in the \\ndocumentation and/or other materials provided with the distribution.\\n\\n* Neither the name of the async project nor the names of \\nits contributors may be used to endorse or promote products derived \\nfrom this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED \\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR \\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING \\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \".PHONY: all clean release force_release\\n\\nall:\\n\\t@grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all\\n\\nclean:\\n\\trm -rf build/ dist/ .eggs/ .tox/\\n\\nforce_release: clean\\n\\t./build-release.sh\\n\\ttwine upload dist/*\\n\\tgit push --tags origin master\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"1\"\n },\n {\n \"content\": \"# Include the license file\\ninclude LICENSE\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[run]\\nsource = smmap\\n\\n; to make nosetests happy\\n[report]\\nomit = \\n\\t*/yaml*\\n\\t*/tests/*\\n */python?.?/*\\n */site-packages/nose/*\\n[end of .coveragerc]\",\n \"filename\": \".coveragerc\",\n \"id\": \"3\"\n },\n {\n \"content\": \"## Motivation\\n\\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\\n\\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\\n\\n\\n## Limitations\\n\\n* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.\\n* The memory access is read-only by design.\\n\\n\\n## Overview\\n\\n\\n\\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\\n\\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\\n\\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\\n\\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\\n\\n\\n\\n## Prerequisites\\n\\n* Python 3.7+\\n* OSX, Windows or Linux\\n\\nThe package was tested on all of the previously mentioned configurations.\\n\\n## Installing smmap\\n\\n[](https://readthedocs.org/projects/smmap/?badge=latest)\\n\\nIts easiest to install smmap using the [pip](http://www.pip-installer.org/en/latest) program:\\n\\n```bash\\n$ pip install smmap\\n```\\n\\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\\n\\nIf you have downloaded the source archive, the package can be installed by running the `setup.py` script:\\n\\n```bash\\n$ python setup.py install\\n```\\n\\nIt is advised to have a look at the **Usage Guide** for a brief introduction on the different database implementations.\\n\\n\\n\\n## Homepage and Links\\n\\nThe project is home on github at https://github.com/gitpython-developers/smmap .\\n\\nThe latest source can be cloned from github as well:\\n\\n* git://github.com/gitpython-developers/smmap.git\\n\\n\\nFor support, please use the git-python mailing list:\\n\\n* http://groups.google.com/group/git-python\\n\\n\\nIssues can be filed on github:\\n\\n* https://github.com/gitpython-developers/smmap/issues\\n\\nA link to the pypi page related to this repository:\\n\\n* https://pypi.org/project/smmap/\\n\\n\\n## License Information\\n\\n*smmap* is licensed under the New BSD License.\\n\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"#!/usr/bin/env python\\nimport os\\n\\ntry:\\n from setuptools import setup, find_packages\\nexcept ImportError:\\n from ez_setup import use_setuptools\\n use_setuptools()\\n from setuptools import setup, find_packages\\n\\nimport smmap\\n\\nif os.path.exists(\\\"README.md\\\"):\\n long_description = open('README.md', encoding=\\\"utf-8\\\").read().replace('\\\\r\\\\n', '\\\\n')\\nelse:\\n long_description = \\\"See https://github.com/gitpython-developers/smmap\\\"\\n\\nsetup(\\n name=\\\"smmap\\\",\\n version=smmap.__version__,\\n description=\\\"A pure Python implementation of a sliding window memory map manager\\\",\\n author=smmap.__author__,\\n author_email=smmap.__contact__,\\n url=smmap.__homepage__,\\n platforms=[\\\"any\\\"],\\n license=\\\"BSD-3-Clause\\\",\\n packages=find_packages(),\\n zip_safe=True,\\n python_requires=\\\">=3.7\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: Microsoft :: Windows\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.7\\\",\\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 \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: 3 :: Only\\\",\\n ],\\n long_description=long_description,\\n long_description_content_type='text/markdown',\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# Tox (http://tox.testrun.org/) is a tool for running tests\\n# in multiple virtualenvs. This configuration file will run the\\n# test suite on all supported python versions. To use it, \\\"pip install tox\\\"\\n# and then run \\\"tox\\\" from this directory.\\n\\n[tox]\\nenvlist = flake8, py{37, 38, 39, 310, 311, 312}\\n\\n[testenv]\\ncommands = {envpython} -m pytest --cov smmap --cov-report xml {posargs}\\ndeps =\\n pytest\\n pytest-cov\\n\\n[testenv:flake8]\\ncommands = flake8 {posargs}\\ndeps = flake8\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"6\"\n },\n {\n \"content\": \"[flake8]\\nexclude = .tox,.venv,build,dist,doc\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"7\"\n },\n {\n \"content\": \"#!/bin/bash\\n#\\n# This script builds a release. If run in a venv, it auto-installs its tools.\\n# You may want to run \\\"make release\\\" instead of running this script directly.\\n\\nset -eEu\\n\\nfunction release_with() {\\n $1 -m build --sdist --wheel\\n}\\n\\nif test -n \\\"${VIRTUAL_ENV:-}\\\"; then\\n deps=(build twine) # Install twine along with build, as we need it later.\\n echo \\\"Virtual environment detected. Adding packages: ${deps[*]}\\\"\\n pip install --quiet --upgrade \\\"${deps[@]}\\\"\\n echo 'Starting the build.'\\n release_with python\\nelse\\n function suggest_venv() {\\n venv_cmd='python -m venv env && source env/bin/activate'\\n printf \\\"HELP: To avoid this error, use a virtual-env with '%s' instead.\\\\n\\\" \\\"$venv_cmd\\\"\\n }\\n trap suggest_venv ERR # This keeps the original exit (error) code.\\n echo 'Starting the build.'\\n release_with python3 # Outside a venv, use python3.\\nfi\\n\\n[end of build-release.sh]\",\n \"filename\": \"build-release.sh\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# Security Policy\\n\\nSee [GitPython](https://github.com/gitpython-developers/GitPython/blob/main/SECURITY.md). Vulnerabilities found in `smmap` can be reported there.\\n\\n[end of SECURITY.md]\",\n \"filename\": \"SECURITY.md\",\n \"id\": \"9\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\\\"\\\"\\\"\\nfrom .util import (\\n MapWindow,\\n MapRegion,\\n MapRegionList,\\n is_64_bit,\\n)\\n\\nimport sys\\nfrom functools import reduce\\n\\n__all__ = [\\\"StaticWindowMapManager\\\", \\\"SlidingWindowMapManager\\\", \\\"WindowCursor\\\"]\\n#{ Utilities\\n\\n#}END utilities\\n\\n\\nclass WindowCursor:\\n\\n \\\"\\\"\\\"\\n Pointer into the mapped region of the memory manager, keeping the map\\n alive until it is destroyed and no other client uses it.\\n\\n Cursors should not be created manually, but are instead returned by the SlidingWindowMapManager\\n\\n **Note:**: The current implementation is suited for static and sliding window managers, but it also means\\n that it must be suited for the somewhat quite different sliding manager. It could be improved, but\\n I see no real need to do so.\\\"\\\"\\\"\\n __slots__ = (\\n '_manager', # the manager keeping all file regions\\n '_rlist', # a regions list with regions for our file\\n '_region', # our current class:`MapRegion` or None\\n '_ofs', # relative offset from the actually mapped area to our start area\\n '_size' # maximum size we should provide\\n )\\n\\n def __init__(self, manager=None, regions=None):\\n self._manager = manager\\n self._rlist = regions\\n self._region = None\\n self._ofs = 0\\n self._size = 0\\n\\n def __del__(self):\\n self._destroy()\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self._destroy()\\n\\n def _destroy(self):\\n \\\"\\\"\\\"Destruction code to decrement counters\\\"\\\"\\\"\\n self.unuse_region()\\n\\n if self._rlist is not None:\\n # Actual client count, which doesn't include the reference kept by the manager, nor ours\\n # as we are about to be deleted\\n try:\\n if len(self._rlist) == 0:\\n # Free all resources associated with the mapped file\\n self._manager._fdict.pop(self._rlist.path_or_fd())\\n # END remove regions list from manager\\n except (TypeError, KeyError):\\n # sometimes, during shutdown, getrefcount is None. Its possible\\n # to re-import it, however, its probably better to just ignore\\n # this python problem (for now).\\n # The next step is to get rid of the error prone getrefcount altogether.\\n pass\\n # END exception handling\\n # END handle regions\\n\\n def _copy_from(self, rhs):\\n \\\"\\\"\\\"Copy all data from rhs into this instance, handles usage count\\\"\\\"\\\"\\n self._manager = rhs._manager\\n self._rlist = type(rhs._rlist)(rhs._rlist)\\n self._region = rhs._region\\n self._ofs = rhs._ofs\\n self._size = rhs._size\\n\\n for region in self._rlist:\\n region.increment_client_count()\\n\\n if self._region is not None:\\n self._region.increment_client_count()\\n # END handle regions\\n\\n def __copy__(self):\\n \\\"\\\"\\\"copy module interface\\\"\\\"\\\"\\n cpy = type(self)()\\n cpy._copy_from(self)\\n return cpy\\n\\n #{ Interface\\n def assign(self, rhs):\\n \\\"\\\"\\\"Assign rhs to this instance. This is required in order to get a real copy.\\n Alternatively, you can copy an existing instance using the copy module\\\"\\\"\\\"\\n self._destroy()\\n self._copy_from(rhs)\\n\\n def use_region(self, offset=0, size=0, flags=0):\\n \\\"\\\"\\\"Assure we point to a window which allows access to the given offset into the file\\n\\n :param offset: absolute offset in bytes into the file\\n :param size: amount of bytes to map. If 0, all available bytes will be mapped\\n :param flags: additional flags to be given to os.open in case a file handle is initially opened\\n for mapping. Has no effect if a region can actually be reused.\\n :return: this instance - it should be queried for whether it points to a valid memory region.\\n This is not the case if the mapping failed because we reached the end of the file\\n\\n **Note:**: The size actually mapped may be smaller than the given size. If that is the case,\\n either the file has reached its end, or the map was created between two existing regions\\\"\\\"\\\"\\n need_region = True\\n man = self._manager\\n fsize = self._rlist.file_size()\\n size = min(size or fsize, man.window_size() or fsize) # clamp size to window size\\n\\n if self._region is not None:\\n if self._region.includes_ofs(offset):\\n need_region = False\\n else:\\n self.unuse_region()\\n # END handle existing region\\n # END check existing region\\n\\n # offset too large ?\\n if offset >= fsize:\\n return self\\n # END handle offset\\n\\n if need_region:\\n self._region = man._obtain_region(self._rlist, offset, size, flags, False)\\n self._region.increment_client_count()\\n # END need region handling\\n\\n self._ofs = offset - self._region._b\\n self._size = min(size, self._region.ofs_end() - offset)\\n\\n return self\\n\\n def unuse_region(self):\\n \\\"\\\"\\\"Unuse the current region. Does nothing if we have no current region\\n\\n **Note:** the cursor unuses the region automatically upon destruction. It is recommended\\n to un-use the region once you are done reading from it in persistent cursors as it\\n helps to free up resource more quickly\\\"\\\"\\\"\\n if self._region is not None:\\n self._region.increment_client_count(-1)\\n self._region = None\\n # note: should reset ofs and size, but we spare that for performance. Its not\\n # allowed to query information if we are not valid !\\n\\n def buffer(self):\\n \\\"\\\"\\\"Return a buffer object which allows access to our memory region from our offset\\n to the window size. Please note that it might be smaller than you requested when calling use_region()\\n\\n **Note:** You can only obtain a buffer if this instance is_valid() !\\n\\n **Note:** buffers should not be cached passed the duration of your access as it will\\n prevent resources from being freed even though they might not be accounted for anymore !\\\"\\\"\\\"\\n return memoryview(self._region.buffer())[self._ofs:self._ofs+self._size]\\n\\n def map(self):\\n \\\"\\\"\\\"\\n :return: the underlying raw memory map. Please not that the offset and size is likely to be different\\n to what you set as offset and size. Use it only if you are sure about the region it maps, which is the whole\\n file in case of StaticWindowMapManager\\\"\\\"\\\"\\n return self._region.map()\\n\\n def is_valid(self):\\n \\\"\\\"\\\":return: True if we have a valid and usable region\\\"\\\"\\\"\\n return self._region is not None\\n\\n def is_associated(self):\\n \\\"\\\"\\\":return: True if we are associated with a specific file already\\\"\\\"\\\"\\n return self._rlist is not None\\n\\n def ofs_begin(self):\\n \\\"\\\"\\\":return: offset to the first byte pointed to by our cursor\\n\\n **Note:** only if is_valid() is True\\\"\\\"\\\"\\n return self._region._b + self._ofs\\n\\n def ofs_end(self):\\n \\\"\\\"\\\":return: offset to one past the last available byte\\\"\\\"\\\"\\n # unroll method calls for performance !\\n return self._region._b + self._ofs + self._size\\n\\n def size(self):\\n \\\"\\\"\\\":return: amount of bytes we point to\\\"\\\"\\\"\\n return self._size\\n\\n def region(self):\\n \\\"\\\"\\\":return: our mapped region, or None if nothing is mapped yet\\n :raise AssertionError: if we have no current region. This is only useful for debugging\\\"\\\"\\\"\\n return self._region\\n\\n def includes_ofs(self, ofs):\\n \\\"\\\"\\\":return: True if the given absolute offset is contained in the cursors\\n current region\\n\\n **Note:** cursor must be valid for this to work\\\"\\\"\\\"\\n # unroll methods\\n return (self._region._b + self._ofs) <= ofs < (self._region._b + self._ofs + self._size)\\n\\n def file_size(self):\\n \\\"\\\"\\\":return: size of the underlying file\\\"\\\"\\\"\\n return self._rlist.file_size()\\n\\n def path_or_fd(self):\\n \\\"\\\"\\\":return: path or file descriptor of the underlying mapped file\\\"\\\"\\\"\\n return self._rlist.path_or_fd()\\n\\n def path(self):\\n \\\"\\\"\\\":return: path of the underlying mapped file\\n :raise ValueError: if attached path is not a path\\\"\\\"\\\"\\n if isinstance(self._rlist.path_or_fd(), int):\\n raise ValueError(\\\"Path queried although mapping was applied to a file descriptor\\\")\\n # END handle type\\n return self._rlist.path_or_fd()\\n\\n def fd(self):\\n \\\"\\\"\\\":return: file descriptor used to create the underlying mapping.\\n\\n **Note:** it is not required to be valid anymore\\n :raise ValueError: if the mapping was not created by a file descriptor\\\"\\\"\\\"\\n if isinstance(self._rlist.path_or_fd(), str):\\n raise ValueError(\\\"File descriptor queried although mapping was generated from path\\\")\\n # END handle type\\n return self._rlist.path_or_fd()\\n\\n #} END interface\\n\\n\\nclass StaticWindowMapManager:\\n\\n \\\"\\\"\\\"Provides a manager which will produce single size cursors that are allowed\\n to always map the whole file.\\n\\n Clients must be written to specifically know that they are accessing their data\\n through a StaticWindowMapManager, as they otherwise have to deal with their window size.\\n\\n These clients would have to use a SlidingWindowMapBuffer to hide this fact.\\n\\n This type will always use a maximum window size, and optimize certain methods to\\n accommodate this fact\\\"\\\"\\\"\\n\\n __slots__ = [\\n '_fdict', # mapping of path -> StorageHelper (of some kind\\n '_window_size', # maximum size of a window\\n '_max_memory_size', # maximum amount of memory we may allocate\\n '_max_handle_count', # maximum amount of handles to keep open\\n '_memory_size', # currently allocated memory size\\n '_handle_count', # amount of currently allocated file handles\\n ]\\n\\n #{ Configuration\\n MapRegionListCls = MapRegionList\\n MapWindowCls = MapWindow\\n MapRegionCls = MapRegion\\n WindowCursorCls = WindowCursor\\n #} END configuration\\n\\n _MB_in_bytes = 1024 * 1024\\n\\n def __init__(self, window_size=0, max_memory_size=0, max_open_handles=sys.maxsize):\\n \\\"\\\"\\\"initialize the manager with the given parameters.\\n :param window_size: if -1, a default window size will be chosen depending on\\n the operating system's architecture. It will internally be quantified to a multiple of the page size\\n If 0, the window may have any size, which basically results in mapping the whole file at one\\n :param max_memory_size: maximum amount of memory we may map at once before releasing mapped regions.\\n If 0, a viable default will be set depending on the system's architecture.\\n It is a soft limit that is tried to be kept, but nothing bad happens if we have to over-allocate\\n :param max_open_handles: if not maxint, limit the amount of open file handles to the given number.\\n Otherwise the amount is only limited by the system itself. If a system or soft limit is hit,\\n the manager will free as many handles as possible\\\"\\\"\\\"\\n self._fdict = dict()\\n self._window_size = window_size\\n self._max_memory_size = max_memory_size\\n self._max_handle_count = max_open_handles\\n self._memory_size = 0\\n self._handle_count = 0\\n\\n if window_size < 0:\\n coeff = 64\\n if is_64_bit():\\n coeff = 1024\\n # END handle arch\\n self._window_size = coeff * self._MB_in_bytes\\n # END handle max window size\\n\\n if max_memory_size == 0:\\n coeff = 1024\\n if is_64_bit():\\n coeff = 8192\\n # END handle arch\\n self._max_memory_size = coeff * self._MB_in_bytes\\n # END handle max memory size\\n\\n #{ Internal Methods\\n\\n def _collect_lru_region(self, size):\\n \\\"\\\"\\\"Unmap the region which was least-recently used and has no client\\n :param size: size of the region we want to map next (assuming its not already mapped partially or full\\n if 0, we try to free any available region\\n :return: Amount of freed regions\\n\\n .. Note::\\n We don't raise exceptions anymore, in order to keep the system working, allowing temporary overallocation.\\n If the system runs out of memory, it will tell.\\n\\n .. TODO::\\n implement a case where all unusued regions are discarded efficiently.\\n Currently its only brute force\\n \\\"\\\"\\\"\\n num_found = 0\\n while (size == 0) or (self._memory_size + size > self._max_memory_size):\\n lru_region = None\\n lru_list = None\\n for regions in self._fdict.values():\\n for region in regions:\\n # check client count - if it's 1, it's just us\\n if (region.client_count() == 1 and\\n (lru_region is None or region._uc < lru_region._uc)):\\n lru_region = region\\n lru_list = regions\\n # END update lru_region\\n # END for each region\\n # END for each regions list\\n\\n if lru_region is None:\\n break\\n # END handle region not found\\n\\n num_found += 1\\n del(lru_list[lru_list.index(lru_region)])\\n lru_region.increment_client_count(-1)\\n self._memory_size -= lru_region.size()\\n self._handle_count -= 1\\n # END while there is more memory to free\\n return num_found\\n\\n def _obtain_region(self, a, offset, size, flags, is_recursive):\\n \\\"\\\"\\\"Utility to create a new region - for more information on the parameters,\\n see MapCursor.use_region.\\n :param a: A regions (a)rray\\n :return: The newly created region\\\"\\\"\\\"\\n if self._memory_size + size > self._max_memory_size:\\n self._collect_lru_region(size)\\n # END handle collection\\n\\n r = None\\n if a:\\n assert len(a) == 1\\n r = a[0]\\n else:\\n try:\\n r = self.MapRegionCls(a.path_or_fd(), 0, sys.maxsize, flags)\\n except Exception:\\n # apparently we are out of system resources or hit a limit\\n # As many more operations are likely to fail in that condition (\\n # like reading a file from disk, etc) we free up as much as possible\\n # As this invalidates our insert position, we have to recurse here\\n if is_recursive:\\n # we already tried this, and still have no success in obtaining\\n # a mapping. This is an exception, so we propagate it\\n raise\\n # END handle existing recursion\\n self._collect_lru_region(0)\\n return self._obtain_region(a, offset, size, flags, True)\\n # END handle exceptions\\n\\n self._handle_count += 1\\n self._memory_size += r.size()\\n a.append(r)\\n # END handle array\\n\\n assert r.includes_ofs(offset)\\n return r\\n\\n #}END internal methods\\n\\n #{ Interface\\n def make_cursor(self, path_or_fd):\\n \\\"\\\"\\\"\\n :return: a cursor pointing to the given path or file descriptor.\\n It can be used to map new regions of the file into memory\\n\\n **Note:** if a file descriptor is given, it is assumed to be open and valid,\\n but may be closed afterwards. To refer to the same file, you may reuse\\n your existing file descriptor, but keep in mind that new windows can only\\n be mapped as long as it stays valid. This is why the using actual file paths\\n are preferred unless you plan to keep the file descriptor open.\\n\\n **Note:** file descriptors are problematic as they are not necessarily unique, as two\\n different files opened and closed in succession might have the same file descriptor id.\\n\\n **Note:** Using file descriptors directly is faster once new windows are mapped as it\\n prevents the file to be opened again just for the purpose of mapping it.\\\"\\\"\\\"\\n regions = self._fdict.get(path_or_fd)\\n if regions is None:\\n regions = self.MapRegionListCls(path_or_fd)\\n self._fdict[path_or_fd] = regions\\n # END obtain region for path\\n return self.WindowCursorCls(self, regions)\\n\\n def collect(self):\\n \\\"\\\"\\\"Collect all available free-to-collect mapped regions\\n :return: Amount of freed handles\\\"\\\"\\\"\\n return self._collect_lru_region(0)\\n\\n def num_file_handles(self):\\n \\\"\\\"\\\":return: amount of file handles in use. Each mapped region uses one file handle\\\"\\\"\\\"\\n return self._handle_count\\n\\n def num_open_files(self):\\n \\\"\\\"\\\"Amount of opened files in the system\\\"\\\"\\\"\\n return reduce(lambda x, y: x + y, (1 for rlist in self._fdict.values() if len(rlist) > 0), 0)\\n\\n def window_size(self):\\n \\\"\\\"\\\":return: size of each window when allocating new regions\\\"\\\"\\\"\\n return self._window_size\\n\\n def mapped_memory_size(self):\\n \\\"\\\"\\\":return: amount of bytes currently mapped in total\\\"\\\"\\\"\\n return self._memory_size\\n\\n def max_file_handles(self):\\n \\\"\\\"\\\":return: maximum amount of handles we may have opened\\\"\\\"\\\"\\n return self._max_handle_count\\n\\n def max_mapped_memory_size(self):\\n \\\"\\\"\\\":return: maximum amount of memory we may allocate\\\"\\\"\\\"\\n return self._max_memory_size\\n\\n #} END interface\\n\\n #{ Special Purpose Interface\\n\\n def force_map_handle_removal_win(self, base_path):\\n \\\"\\\"\\\"ONLY AVAILABLE ON WINDOWS\\n On windows removing files is not allowed if anybody still has it opened.\\n If this process is ourselves, and if the whole process uses this memory\\n manager (as far as the parent framework is concerned) we can enforce\\n closing all memory maps whose path matches the given base path to\\n allow the respective operation after all.\\n The respective system must NOT access the closed memory regions anymore !\\n This really may only be used if you know that the items which keep\\n the cursors alive will not be using it anymore. They need to be recreated !\\n :return: Amount of closed handles\\n\\n **Note:** does nothing on non-windows platforms\\\"\\\"\\\"\\n if sys.platform != 'win32':\\n return\\n # END early bailout\\n\\n num_closed = 0\\n for path, rlist in self._fdict.items():\\n if path.startswith(base_path):\\n for region in rlist:\\n region.release()\\n num_closed += 1\\n # END path matches\\n # END for each path\\n return num_closed\\n #} END special purpose interface\\n\\n\\nclass SlidingWindowMapManager(StaticWindowMapManager):\\n\\n \\\"\\\"\\\"Maintains a list of ranges of mapped memory regions in one or more files and allows to easily\\n obtain additional regions assuring there is no overlap.\\n Once a certain memory limit is reached globally, or if there cannot be more open file handles\\n which result from each mmap call, the least recently used, and currently unused mapped regions\\n are unloaded automatically.\\n\\n **Note:** currently not thread-safe !\\n\\n **Note:** in the current implementation, we will automatically unload windows if we either cannot\\n create more memory maps (as the open file handles limit is hit) or if we have allocated more than\\n a safe amount of memory already, which would possibly cause memory allocations to fail as our address\\n space is full.\\\"\\\"\\\"\\n\\n __slots__ = tuple()\\n\\n def __init__(self, window_size=-1, max_memory_size=0, max_open_handles=sys.maxsize):\\n \\\"\\\"\\\"Adjusts the default window size to -1\\\"\\\"\\\"\\n super().__init__(window_size, max_memory_size, max_open_handles)\\n\\n def _obtain_region(self, a, offset, size, flags, is_recursive):\\n # bisect to find an existing region. The c++ implementation cannot\\n # do that as it uses a linked list for regions.\\n r = None\\n lo = 0\\n hi = len(a)\\n while lo < hi:\\n mid = (lo + hi) // 2\\n ofs = a[mid]._b\\n if ofs <= offset:\\n if a[mid].includes_ofs(offset):\\n r = a[mid]\\n break\\n # END have region\\n lo = mid + 1\\n else:\\n hi = mid\\n # END handle position\\n # END while bisecting\\n\\n if r is None:\\n window_size = self._window_size\\n left = self.MapWindowCls(0, 0)\\n mid = self.MapWindowCls(offset, size)\\n right = self.MapWindowCls(a.file_size(), 0)\\n\\n # we want to honor the max memory size, and assure we have anough\\n # memory available\\n # Save calls !\\n if self._memory_size + window_size > self._max_memory_size:\\n self._collect_lru_region(window_size)\\n # END handle collection\\n\\n # we assume the list remains sorted by offset\\n insert_pos = 0\\n len_regions = len(a)\\n if len_regions == 1:\\n if a[0]._b <= offset:\\n insert_pos = 1\\n # END maintain sort\\n else:\\n # find insert position\\n insert_pos = len_regions\\n for i, region in enumerate(a):\\n if region._b > offset:\\n insert_pos = i\\n break\\n # END if insert position is correct\\n # END for each region\\n # END obtain insert pos\\n\\n # adjust the actual offset and size values to create the largest\\n # possible mapping\\n if insert_pos == 0:\\n if len_regions:\\n right = self.MapWindowCls.from_region(a[insert_pos])\\n # END adjust right side\\n else:\\n if insert_pos != len_regions:\\n right = self.MapWindowCls.from_region(a[insert_pos])\\n # END adjust right window\\n left = self.MapWindowCls.from_region(a[insert_pos - 1])\\n # END adjust surrounding windows\\n\\n mid.extend_left_to(left, window_size)\\n mid.extend_right_to(right, window_size)\\n mid.align()\\n\\n # it can happen that we align beyond the end of the file\\n if mid.ofs_end() > right.ofs:\\n mid.size = right.ofs - mid.ofs\\n # END readjust size\\n\\n # insert new region at the right offset to keep the order\\n try:\\n if self._handle_count >= self._max_handle_count:\\n raise Exception\\n # END assert own imposed max file handles\\n r = self.MapRegionCls(a.path_or_fd(), mid.ofs, mid.size, flags)\\n except Exception:\\n # apparently we are out of system resources or hit a limit\\n # As many more operations are likely to fail in that condition (\\n # like reading a file from disk, etc) we free up as much as possible\\n # As this invalidates our insert position, we have to recurse here\\n if is_recursive:\\n # we already tried this, and still have no success in obtaining\\n # a mapping. This is an exception, so we propagate it\\n raise\\n # END handle existing recursion\\n self._collect_lru_region(0)\\n return self._obtain_region(a, offset, size, flags, True)\\n # END handle exceptions\\n\\n self._handle_count += 1\\n self._memory_size += r.size()\\n a.insert(insert_pos, r)\\n # END create new region\\n return r\\n\\n[end of smmap/mman.py]\",\n \"filename\": \"smmap/mman.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module with a simple buffer implementation using the memory manager\\\"\\\"\\\"\\nimport sys\\n\\n__all__ = [\\\"SlidingWindowMapBuffer\\\"]\\n\\n\\nclass SlidingWindowMapBuffer:\\n\\n \\\"\\\"\\\"A buffer like object which allows direct byte-wise object and slicing into\\n memory of a mapped file. The mapping is controlled by the provided cursor.\\n\\n The buffer is relative, that is if you map an offset, index 0 will map to the\\n first byte at the offset you used during initialization or begin_access\\n\\n **Note:** Although this type effectively hides the fact that there are mapped windows\\n underneath, it can unfortunately not be used in any non-pure python method which\\n needs a buffer or string\\\"\\\"\\\"\\n __slots__ = (\\n '_c', # our cursor\\n '_size', # our supposed size\\n )\\n\\n def __init__(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\\n \\\"\\\"\\\"Initialize the instance to operate on the given cursor.\\n :param cursor: if not None, the associated cursor to the file you want to access\\n If None, you have call begin_access before using the buffer and provide a cursor\\n :param offset: absolute offset in bytes\\n :param size: the total size of the mapping. Defaults to the maximum possible size\\n From that point on, the __len__ of the buffer will be the given size or the file size.\\n If the size is larger than the mappable area, you can only access the actually available\\n area, although the length of the buffer is reported to be your given size.\\n Hence it is in your own interest to provide a proper size !\\n :param flags: Additional flags to be passed to os.open\\n :raise ValueError: if the buffer could not achieve a valid state\\\"\\\"\\\"\\n self._c = cursor\\n if cursor and not self.begin_access(cursor, offset, size, flags):\\n raise ValueError(\\\"Failed to allocate the buffer - probably the given offset is out of bounds\\\")\\n # END handle offset\\n\\n def __del__(self):\\n self.end_access()\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self.end_access()\\n\\n def __len__(self):\\n return self._size\\n\\n def __getitem__(self, i):\\n if isinstance(i, slice):\\n return self.__getslice__(i.start or 0, i.stop or self._size)\\n c = self._c\\n assert c.is_valid()\\n if i < 0:\\n i = self._size + i\\n if not c.includes_ofs(i):\\n c.use_region(i, 1)\\n # END handle region usage\\n return c.buffer()[i - c.ofs_begin()]\\n\\n def __getslice__(self, i, j):\\n c = self._c\\n # fast path, slice fully included - safes a concatenate operation and\\n # should be the default\\n assert c.is_valid()\\n if i < 0:\\n i = self._size + i\\n if j == sys.maxsize:\\n j = self._size\\n if j < 0:\\n j = self._size + j\\n if (c.ofs_begin() <= i) and (j < c.ofs_end()):\\n b = c.ofs_begin()\\n return c.buffer()[i - b:j - b]\\n else:\\n l = j - i # total length\\n ofs = i\\n # It's fastest to keep tokens and join later, especially in py3, which was 7 times slower\\n # in the previous iteration of this code\\n md = list()\\n while l:\\n c.use_region(ofs, l)\\n assert c.is_valid()\\n d = c.buffer()[:l]\\n ofs += len(d)\\n l -= len(d)\\n # Make sure we don't keep references, as c.use_region() might attempt to free resources, but\\n # can't unless we use pure bytes\\n if hasattr(d, 'tobytes'):\\n d = d.tobytes()\\n md.append(d)\\n # END while there are bytes to read\\n return b''.join(md)\\n # END fast or slow path\\n #{ Interface\\n\\n def begin_access(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\\n \\\"\\\"\\\"Call this before the first use of this instance. The method was already\\n called by the constructor in case sufficient information was provided.\\n\\n For more information no the parameters, see the __init__ method\\n :param path: if cursor is None the existing one will be used.\\n :return: True if the buffer can be used\\\"\\\"\\\"\\n if cursor:\\n self._c = cursor\\n # END update our cursor\\n\\n # reuse existing cursors if possible\\n if self._c is not None and self._c.is_associated():\\n res = self._c.use_region(offset, size, flags).is_valid()\\n if res:\\n # if given size is too large or default, we computer a proper size\\n # If its smaller, we assume the combination between offset and size\\n # as chosen by the user is correct and use it !\\n # If not, the user is in trouble.\\n if size > self._c.file_size():\\n size = self._c.file_size() - offset\\n # END handle size\\n self._size = size\\n # END set size\\n return res\\n # END use our cursor\\n return False\\n\\n def end_access(self):\\n \\\"\\\"\\\"Call this method once you are done using the instance. It is automatically\\n called on destruction, and should be called just in time to allow system\\n resources to be freed.\\n\\n Once you called end_access, you must call begin access before reusing this instance!\\\"\\\"\\\"\\n self._size = 0\\n if self._c is not None:\\n self._c.unuse_region()\\n # END unuse region\\n\\n def cursor(self):\\n \\\"\\\"\\\":return: the currently set cursor which provides access to the data\\\"\\\"\\\"\\n return self._c\\n\\n #}END interface\\n\\n[end of smmap/buf.py]\",\n \"filename\": \"smmap/buf.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\\\"\\\"\\\"\\nimport os\\nimport sys\\n\\nfrom mmap import mmap, ACCESS_READ\\nfrom mmap import ALLOCATIONGRANULARITY\\n\\n__all__ = [\\\"align_to_mmap\\\", \\\"is_64_bit\\\",\\n \\\"MapWindow\\\", \\\"MapRegion\\\", \\\"MapRegionList\\\", \\\"ALLOCATIONGRANULARITY\\\"]\\n\\n#{ Utilities\\n\\n\\ndef align_to_mmap(num, round_up):\\n \\\"\\\"\\\"\\n Align the given integer number to the closest page offset, which usually is 4096 bytes.\\n\\n :param round_up: if True, the next higher multiple of page size is used, otherwise\\n the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)\\n :return: num rounded to closest page\\\"\\\"\\\"\\n res = (num // ALLOCATIONGRANULARITY) * ALLOCATIONGRANULARITY\\n if round_up and (res != num):\\n res += ALLOCATIONGRANULARITY\\n # END handle size\\n return res\\n\\n\\ndef is_64_bit():\\n \\\"\\\"\\\":return: True if the system is 64 bit. Otherwise it can be assumed to be 32 bit\\\"\\\"\\\"\\n return sys.maxsize > (1 << 32) - 1\\n\\n#}END utilities\\n\\n\\n#{ Utility Classes\\n\\nclass MapWindow:\\n\\n \\\"\\\"\\\"Utility type which is used to snap windows towards each other, and to adjust their size\\\"\\\"\\\"\\n __slots__ = (\\n 'ofs', # offset into the file in bytes\\n 'size' # size of the window in bytes\\n )\\n\\n def __init__(self, offset, size):\\n self.ofs = offset\\n self.size = size\\n\\n def __repr__(self):\\n return \\\"MapWindow(%i, %i)\\\" % (self.ofs, self.size)\\n\\n @classmethod\\n def from_region(cls, region):\\n \\\"\\\"\\\":return: new window from a region\\\"\\\"\\\"\\n return cls(region._b, region.size())\\n\\n def ofs_end(self):\\n return self.ofs + self.size\\n\\n def align(self):\\n \\\"\\\"\\\"Assures the previous window area is contained in the new one\\\"\\\"\\\"\\n nofs = align_to_mmap(self.ofs, 0)\\n self.size += self.ofs - nofs # keep size constant\\n self.ofs = nofs\\n self.size = align_to_mmap(self.size, 1)\\n\\n def extend_left_to(self, window, max_size):\\n \\\"\\\"\\\"Adjust the offset to start where the given window on our left ends if possible,\\n but don't make yourself larger than max_size.\\n The resize will assure that the new window still contains the old window area\\\"\\\"\\\"\\n rofs = self.ofs - window.ofs_end()\\n nsize = rofs + self.size\\n rofs -= nsize - min(nsize, max_size)\\n self.ofs -= rofs\\n self.size += rofs\\n\\n def extend_right_to(self, window, max_size):\\n \\\"\\\"\\\"Adjust the size to make our window end where the right window begins, but don't\\n get larger than max_size\\\"\\\"\\\"\\n self.size = min(self.size + (window.ofs - self.ofs_end()), max_size)\\n\\n\\nclass MapRegion:\\n\\n \\\"\\\"\\\"Defines a mapped region of memory, aligned to pagesizes\\n\\n **Note:** deallocates used region automatically on destruction\\\"\\\"\\\"\\n __slots__ = [\\n '_b', # beginning of mapping\\n '_mf', # mapped memory chunk (as returned by mmap)\\n '_uc', # total amount of usages\\n '_size', # cached size of our memory map\\n '__weakref__'\\n ]\\n\\n #{ Configuration\\n #} END configuration\\n\\n def __init__(self, path_or_fd, ofs, size, flags=0):\\n \\\"\\\"\\\"Initialize a region, allocate the memory map\\n :param path_or_fd: path to the file to map, or the opened file descriptor\\n :param ofs: **aligned** offset into the file to be mapped\\n :param size: if size is larger then the file on disk, the whole file will be\\n allocated the the size automatically adjusted\\n :param flags: additional flags to be given when opening the file.\\n :raise Exception: if no memory can be allocated\\\"\\\"\\\"\\n self._b = ofs\\n self._size = 0\\n self._uc = 0\\n\\n if isinstance(path_or_fd, int):\\n fd = path_or_fd\\n else:\\n fd = os.open(path_or_fd, os.O_RDONLY | getattr(os, 'O_BINARY', 0) | flags)\\n # END handle fd\\n\\n try:\\n kwargs = dict(access=ACCESS_READ, offset=ofs)\\n corrected_size = size\\n sizeofs = ofs\\n\\n # have to correct size, otherwise (instead of the c version) it will\\n # bark that the size is too large ... many extra file accesses because\\n # if this ... argh !\\n actual_size = min(os.fstat(fd).st_size - sizeofs, corrected_size)\\n self._mf = mmap(fd, actual_size, **kwargs)\\n # END handle memory mode\\n\\n self._size = len(self._mf)\\n finally:\\n if isinstance(path_or_fd, str):\\n os.close(fd)\\n # END only close it if we opened it\\n # END close file handle\\n # We assume the first one to use us keeps us around\\n self.increment_client_count()\\n\\n def __repr__(self):\\n return \\\"MapRegion<%i, %i>\\\" % (self._b, self.size())\\n\\n #{ Interface\\n\\n def buffer(self):\\n \\\"\\\"\\\":return: a buffer containing the memory\\\"\\\"\\\"\\n return self._mf\\n\\n def map(self):\\n \\\"\\\"\\\":return: a memory map containing the memory\\\"\\\"\\\"\\n return self._mf\\n\\n def ofs_begin(self):\\n \\\"\\\"\\\":return: absolute byte offset to the first byte of the mapping\\\"\\\"\\\"\\n return self._b\\n\\n def size(self):\\n \\\"\\\"\\\":return: total size of the mapped region in bytes\\\"\\\"\\\"\\n return self._size\\n\\n def ofs_end(self):\\n \\\"\\\"\\\":return: Absolute offset to one byte beyond the mapping into the file\\\"\\\"\\\"\\n return self._b + self._size\\n\\n def includes_ofs(self, ofs):\\n \\\"\\\"\\\":return: True if the given offset can be read in our mapped region\\\"\\\"\\\"\\n return self._b <= ofs < self._b + self._size\\n\\n def client_count(self):\\n \\\"\\\"\\\":return: number of clients currently using this region\\\"\\\"\\\"\\n return self._uc\\n\\n def increment_client_count(self, ofs = 1):\\n \\\"\\\"\\\"Adjust the usage count by the given positive or negative offset.\\n If usage count equals 0, we will auto-release our resources\\n :return: True if we released resources, False otherwise. In the latter case, we can still be used\\\"\\\"\\\"\\n self._uc += ofs\\n assert self._uc > -1, \\\"Increments must match decrements, usage counter negative: %i\\\" % self._uc\\n\\n if self.client_count() == 0:\\n self.release()\\n return True\\n else:\\n return False\\n # end handle release\\n\\n def release(self):\\n \\\"\\\"\\\"Release all resources this instance might hold. Must only be called if there usage_count() is zero\\\"\\\"\\\"\\n self._mf.close()\\n\\n #} END interface\\n\\n\\nclass MapRegionList(list):\\n\\n \\\"\\\"\\\"List of MapRegion instances associating a path with a list of regions.\\\"\\\"\\\"\\n __slots__ = (\\n '_path_or_fd', # path or file descriptor which is mapped by all our regions\\n '_file_size' # total size of the file we map\\n )\\n\\n def __new__(cls, path):\\n return super().__new__(cls)\\n\\n def __init__(self, path_or_fd):\\n self._path_or_fd = path_or_fd\\n self._file_size = None\\n\\n def path_or_fd(self):\\n \\\"\\\"\\\":return: path or file descriptor we are attached to\\\"\\\"\\\"\\n return self._path_or_fd\\n\\n def file_size(self):\\n \\\"\\\"\\\":return: size of file we manager\\\"\\\"\\\"\\n if self._file_size is None:\\n if isinstance(self._path_or_fd, str):\\n self._file_size = os.stat(self._path_or_fd).st_size\\n else:\\n self._file_size = os.fstat(self._path_or_fd).st_size\\n # END handle path type\\n # END update file size\\n return self._file_size\\n\\n#} END utility classes\\n\\n[end of smmap/util.py]\",\n \"filename\": \"smmap/util.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Initialize the smmap package\\\"\\\"\\\"\\n\\n__author__ = \\\"Sebastian Thiel\\\"\\n__contact__ = \\\"byronimo@gmail.com\\\"\\n__homepage__ = \\\"https://github.com/gitpython-developers/smmap\\\"\\nversion_info = (5, 0, 2)\\n__version__ = '.'.join(str(i) for i in version_info)\\n\\n# make everything available in root package for convenience\\nfrom .mman import *\\nfrom .buf import *\\n\\n[end of smmap/__init__.py]\",\n \"filename\": \"smmap/__init__.py\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = build\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\\n\\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\t-rm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make all-pdf' or \\\\`make all-ps' in that directory to\\\" \\\\\\n\\t \\\"run these through (pdf)latex.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\n[end of doc/Makefile]\",\n \"filename\": \"doc/Makefile\",\n \"id\": \"14\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\nREM Command file for Sphinx documentation\\n\\nset SPHINXBUILD=sphinx-build\\nset BUILDDIR=build\\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\\nif NOT \\\"%PAPER%\\\" == \\\"\\\" (\\n\\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\\n)\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\nif \\\"%1\\\" == \\\"help\\\" (\\n\\t:help\\n\\techo.Please use `make ^<target^>` where ^<target^> is one of\\n\\techo. html to make standalone HTML files\\n\\techo. dirhtml to make HTML files named index.html in directories\\n\\techo. pickle to make pickle files\\n\\techo. json to make JSON files\\n\\techo. htmlhelp to make HTML files and a HTML help project\\n\\techo. qthelp to make HTML files and a qthelp project\\n\\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\n\\techo. changes to make an overview over all changed/added/deprecated items\\n\\techo. linkcheck to check all external links for integrity\\n\\techo. doctest to run all doctests embedded in the documentation if enabled\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"clean\\\" (\\n\\tfor /d %%i in (%BUILDDIR%\\\\*) do rmdir /q /s %%i\\n\\tdel /q /s %BUILDDIR%\\\\*\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"html\\\" (\\n\\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\\n\\techo.\\n\\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"dirhtml\\\" (\\n\\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\\n\\techo.\\n\\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"pickle\\\" (\\n\\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\\n\\techo.\\n\\techo.Build finished; now you can process the pickle files.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"json\\\" (\\n\\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\\n\\techo.\\n\\techo.Build finished; now you can process the JSON files.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"htmlhelp\\\" (\\n\\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\\n\\techo.\\n\\techo.Build finished; now you can run HTML Help Workshop with the ^\\n.hhp project file in %BUILDDIR%/htmlhelp.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"qthelp\\\" (\\n\\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\\n\\techo.\\n\\techo.Build finished; now you can run \\\"qcollectiongenerator\\\" with the ^\\n.qhcp project file in %BUILDDIR%/qthelp, like this:\\n\\techo.^> qcollectiongenerator %BUILDDIR%\\\\qthelp\\\\smmap.qhcp\\n\\techo.To view the help file:\\n\\techo.^> assistant -collectionFile %BUILDDIR%\\\\qthelp\\\\smmap.ghc\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"latex\\\" (\\n\\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\\n\\techo.\\n\\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"changes\\\" (\\n\\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\\n\\techo.\\n\\techo.The overview file is in %BUILDDIR%/changes.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"linkcheck\\\" (\\n\\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\\n\\techo.\\n\\techo.Link check complete; look for any errors in the above output ^\\nor in %BUILDDIR%/linkcheck/output.txt.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"doctest\\\" (\\n\\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\\n\\techo.\\n\\techo.Testing of doctests in the sources finished, look at the ^\\nresults in %BUILDDIR%/doctest/output.txt.\\n\\tgoto end\\n)\\n\\n:end\\n\\n[end of doc/make.bat]\",\n \"filename\": \"doc/make.bat\",\n \"id\": \"15\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.mman import (\\n WindowCursor,\\n SlidingWindowMapManager,\\n StaticWindowMapManager\\n)\\nfrom smmap.util import align_to_mmap\\n\\nfrom random import randint\\nfrom time import time\\nimport os\\nimport sys\\nfrom copy import copy\\n\\n\\nclass TestMMan(TestBase):\\n\\n def test_cursor(self):\\n with FileCreator(self.k_window_test_size, \\\"cursor_test\\\") as fc:\\n man = SlidingWindowMapManager()\\n ci = WindowCursor(man) # invalid cursor\\n assert not ci.is_valid()\\n assert not ci.is_associated()\\n assert ci.size() == 0 # this is cached, so we can query it in invalid state\\n\\n cv = man.make_cursor(fc.path)\\n assert not cv.is_valid() # no region mapped yet\\n assert cv.is_associated() # but it know where to map it from\\n assert cv.file_size() == fc.size\\n assert cv.path() == fc.path\\n\\n # copy module\\n cio = copy(cv)\\n assert not cio.is_valid() and cio.is_associated()\\n\\n # assign method\\n assert not ci.is_associated()\\n ci.assign(cv)\\n assert not ci.is_valid() and ci.is_associated()\\n\\n # unuse non-existing region is fine\\n cv.unuse_region()\\n cv.unuse_region()\\n\\n # destruction is fine (even multiple times)\\n cv._destroy()\\n WindowCursor(man)._destroy()\\n\\n def test_memory_manager(self):\\n slide_man = SlidingWindowMapManager()\\n static_man = StaticWindowMapManager()\\n\\n for man in (static_man, slide_man):\\n assert man.num_file_handles() == 0\\n assert man.num_open_files() == 0\\n winsize_cmp_val = 0\\n if isinstance(man, StaticWindowMapManager):\\n winsize_cmp_val = -1\\n # END handle window size\\n assert man.window_size() > winsize_cmp_val\\n assert man.mapped_memory_size() == 0\\n assert man.max_mapped_memory_size() > 0\\n\\n # collection doesn't raise in 'any' mode\\n man._collect_lru_region(0)\\n # doesn't raise if we are within the limit\\n man._collect_lru_region(10)\\n\\n # doesn't fail if we over-allocate\\n assert man._collect_lru_region(sys.maxsize) == 0\\n\\n # use a region, verify most basic functionality\\n with FileCreator(self.k_window_test_size, \\\"manager_test\\\") as fc:\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n for item in (fc.path, fd):\\n c = man.make_cursor(item)\\n assert c.path_or_fd() is item\\n assert c.use_region(10, 10).is_valid()\\n assert c.ofs_begin() == 10\\n assert c.size() == 10\\n with open(fc.path, 'rb') as fp:\\n assert c.buffer()[:] == fp.read(20)[10:]\\n\\n if isinstance(item, int):\\n self.assertRaises(ValueError, c.path)\\n else:\\n self.assertRaises(ValueError, c.fd)\\n # END handle value error\\n # END for each input\\n finally:\\n os.close(fd)\\n # END for each manasger type\\n\\n def test_memman_operation(self):\\n # test more access, force it to actually unmap regions\\n with FileCreator(self.k_window_test_size, \\\"manager_operation_test\\\") as fc:\\n with open(fc.path, 'rb') as fp:\\n data = fp.read()\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n max_num_handles = 15\\n # small_size =\\n for mtype, args in ((StaticWindowMapManager, (0, fc.size // 3, max_num_handles)),\\n (SlidingWindowMapManager, (fc.size // 100, fc.size // 3, max_num_handles)),):\\n for item in (fc.path, fd):\\n assert len(data) == fc.size\\n\\n # small windows, a reasonable max memory. Not too many regions at once\\n man = mtype(window_size=args[0], max_memory_size=args[1], max_open_handles=args[2])\\n c = man.make_cursor(item)\\n\\n # still empty (more about that is tested in test_memory_manager()\\n assert man.num_open_files() == 0\\n assert man.mapped_memory_size() == 0\\n\\n base_offset = 5000\\n # window size is 0 for static managers, hence size will be 0. We take that into consideration\\n size = man.window_size() // 2\\n assert c.use_region(base_offset, size).is_valid()\\n rr = c.region()\\n assert rr.client_count() == 2 # the manager and the cursor and us\\n\\n assert man.num_open_files() == 1\\n assert man.num_file_handles() == 1\\n assert man.mapped_memory_size() == rr.size()\\n\\n # assert c.size() == size # the cursor may overallocate in its static version\\n assert c.ofs_begin() == base_offset\\n assert rr.ofs_begin() == 0 # it was aligned and expanded\\n if man.window_size():\\n # but isn't larger than the max window (aligned)\\n assert rr.size() == align_to_mmap(man.window_size(), True)\\n else:\\n assert rr.size() == fc.size\\n # END ignore static managers which dont use windows and are aligned to file boundaries\\n\\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\\n\\n # obtain second window, which spans the first part of the file - it is a still the same window\\n nsize = (size or fc.size) - 10\\n assert c.use_region(0, nsize).is_valid()\\n assert c.region() == rr\\n assert man.num_file_handles() == 1\\n assert c.size() == nsize\\n assert c.ofs_begin() == 0\\n assert c.buffer()[:] == data[:nsize]\\n\\n # map some part at the end, our requested size cannot be kept\\n overshoot = 4000\\n base_offset = fc.size - (size or c.size()) + overshoot\\n assert c.use_region(base_offset, size).is_valid()\\n if man.window_size():\\n assert man.num_file_handles() == 2\\n assert c.size() < size\\n assert c.region() is not rr # old region is still available, but has not cursor ref anymore\\n assert rr.client_count() == 1 # only held by manager\\n else:\\n assert c.size() < fc.size\\n # END ignore static managers which only have one handle per file\\n rr = c.region()\\n assert rr.client_count() == 2 # manager + cursor\\n assert rr.ofs_begin() < c.ofs_begin() # it should have extended itself to the left\\n assert rr.ofs_end() <= fc.size # it cannot be larger than the file\\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\\n\\n # unising a region makes the cursor invalid\\n c.unuse_region()\\n assert not c.is_valid()\\n if man.window_size():\\n # but doesn't change anything regarding the handle count - we cache it and only\\n # remove mapped regions if we have to\\n assert man.num_file_handles() == 2\\n # END ignore this for static managers\\n\\n # iterate through the windows, verify data contents\\n # this will trigger map collection after a while\\n max_random_accesses = 5000\\n num_random_accesses = max_random_accesses\\n memory_read = 0\\n st = time()\\n\\n # cache everything to get some more performance\\n includes_ofs = c.includes_ofs\\n max_mapped_memory_size = man.max_mapped_memory_size()\\n max_file_handles = man.max_file_handles()\\n mapped_memory_size = man.mapped_memory_size\\n num_file_handles = man.num_file_handles\\n while num_random_accesses:\\n num_random_accesses -= 1\\n base_offset = randint(0, fc.size - 1)\\n\\n # precondition\\n if man.window_size():\\n assert max_mapped_memory_size >= mapped_memory_size()\\n # END statistics will overshoot, which is fine\\n assert max_file_handles >= num_file_handles()\\n assert c.use_region(base_offset, (size or c.size())).is_valid()\\n csize = c.size()\\n assert c.buffer()[:] == data[base_offset:base_offset + csize]\\n memory_read += csize\\n\\n assert includes_ofs(base_offset)\\n assert includes_ofs(base_offset + csize - 1)\\n assert not includes_ofs(base_offset + csize)\\n # END while we should do an access\\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\\n mb = float(1000 * 1000)\\n print(\\\"%s: Read %i mb of memory with %i random on cursor initialized with %s accesses in %fs (%f mb/s)\\\\n\\\"\\n % (mtype, memory_read / mb, max_random_accesses, type(item), elapsed, (memory_read / mb) / elapsed),\\n file=sys.stderr)\\n\\n # an offset as large as the size doesn't work !\\n assert not c.use_region(fc.size, size).is_valid()\\n\\n # collection - it should be able to collect all\\n assert man.num_file_handles()\\n assert man.collect()\\n assert man.num_file_handles() == 0\\n # END for each item\\n # END for each manager type\\n finally:\\n os.close(fd)\\n\\n[end of smmap/test/test_mman.py]\",\n \"filename\": \"smmap/test/test_mman.py\",\n \"id\": \"16\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Provide base classes for the test system\\\"\\\"\\\"\\nfrom unittest import TestCase\\nimport os\\nimport tempfile\\n\\n__all__ = ['TestBase', 'FileCreator']\\n\\n\\n#{ Utilities\\n\\nclass FileCreator:\\n\\n \\\"\\\"\\\"A instance which creates a temporary file with a prefix and a given size\\n and provides this info to the user.\\n Once it gets deleted, it will remove the temporary file as well.\\\"\\\"\\\"\\n __slots__ = (\\\"_size\\\", \\\"_path\\\")\\n\\n def __init__(self, size, prefix=''):\\n assert size, \\\"Require size to be larger 0\\\"\\n\\n self._size = size\\n\\n with tempfile.NamedTemporaryFile(\\\"wb\\\", prefix=prefix, delete=False) as file:\\n self._path = file.name\\n file.seek(size - 1)\\n file.write(b'1')\\n\\n assert os.path.getsize(self.path) == size\\n\\n def __del__(self):\\n try:\\n os.remove(self.path)\\n except OSError:\\n pass\\n # END exception handling\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self.__del__()\\n\\n @property\\n def path(self):\\n return self._path\\n\\n @property\\n def size(self):\\n return self._size\\n\\n#} END utilities\\n\\n\\nclass TestBase(TestCase):\\n\\n \\\"\\\"\\\"Foundation used by all tests\\\"\\\"\\\"\\n\\n #{ Configuration\\n k_window_test_size = 1000 * 1000 * 8 + 5195\\n #} END configuration\\n\\n #{ Overrides\\n @classmethod\\n def setUpAll(cls):\\n # nothing for now\\n pass\\n\\n # END overrides\\n\\n #{ Interface\\n\\n #} END interface\\n\\n[end of smmap/test/lib.py]\",\n \"filename\": \"smmap/test/lib.py\",\n \"id\": \"17\"\n },\n {\n \"content\": \"[end of smmap/test/__init__.py]\",\n \"filename\": \"smmap/test/__init__.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.mman import (\\n SlidingWindowMapManager,\\n StaticWindowMapManager\\n)\\nfrom smmap.buf import SlidingWindowMapBuffer\\n\\nfrom random import randint\\nfrom time import time\\nimport sys\\nimport os\\n\\n\\nman_optimal = SlidingWindowMapManager()\\nman_worst_case = SlidingWindowMapManager(\\n window_size=TestBase.k_window_test_size // 100,\\n max_memory_size=TestBase.k_window_test_size // 3,\\n max_open_handles=15)\\nstatic_man = StaticWindowMapManager()\\n\\n\\nclass TestBuf(TestBase):\\n\\n def test_basics(self):\\n with FileCreator(self.k_window_test_size, \\\"buffer_test\\\") as fc:\\n\\n # invalid paths fail upon construction\\n c = man_optimal.make_cursor(fc.path)\\n self.assertRaises(ValueError, SlidingWindowMapBuffer, type(c)()) # invalid cursor\\n self.assertRaises(ValueError, SlidingWindowMapBuffer, c, fc.size) # offset too large\\n\\n buf = SlidingWindowMapBuffer() # can create uninitialized buffers\\n assert buf.cursor() is None\\n\\n # can call end access any time\\n buf.end_access()\\n buf.end_access()\\n assert len(buf) == 0\\n\\n # begin access can revive it, if the offset is suitable\\n offset = 100\\n assert buf.begin_access(c, fc.size) == False\\n assert buf.begin_access(c, offset) == True\\n assert len(buf) == fc.size - offset\\n assert buf.cursor().is_valid()\\n\\n # empty begin access keeps it valid on the same path, but alters the offset\\n assert buf.begin_access() == True\\n assert len(buf) == fc.size\\n assert buf.cursor().is_valid()\\n\\n # simple access\\n with open(fc.path, 'rb') as fp:\\n data = fp.read()\\n assert data[offset] == buf[0]\\n assert data[offset:offset * 2] == buf[0:offset]\\n\\n # negative indices, partial slices\\n assert buf[-1] == buf[len(buf) - 1]\\n assert buf[-10:] == buf[len(buf) - 10:len(buf)]\\n\\n # end access makes its cursor invalid\\n buf.end_access()\\n assert not buf.cursor().is_valid()\\n assert buf.cursor().is_associated() # but it remains associated\\n\\n # an empty begin access fixes it up again\\n assert buf.begin_access() == True and buf.cursor().is_valid()\\n del(buf) # ends access automatically\\n del(c)\\n\\n assert man_optimal.num_file_handles() == 1\\n\\n # PERFORMANCE\\n # blast away with random access and a full mapping - we don't want to\\n # exaggerate the manager's overhead, but measure the buffer overhead\\n # We do it once with an optimal setting, and with a worse manager which\\n # will produce small mappings only !\\n max_num_accesses = 100\\n fd = os.open(fc.path, os.O_RDONLY)\\n for item in (fc.path, fd):\\n for manager, man_id in ((man_optimal, 'optimal'),\\n (man_worst_case, 'worst case'),\\n (static_man, 'static optimal')):\\n buf = SlidingWindowMapBuffer(manager.make_cursor(item))\\n assert manager.num_file_handles() == 1\\n for access_mode in range(2): # single, multi\\n num_accesses_left = max_num_accesses\\n num_bytes = 0\\n fsize = fc.size\\n\\n st = time()\\n buf.begin_access()\\n while num_accesses_left:\\n num_accesses_left -= 1\\n if access_mode: # multi\\n ofs_start = randint(0, fsize)\\n ofs_end = randint(ofs_start, fsize)\\n d = buf[ofs_start:ofs_end]\\n assert len(d) == ofs_end - ofs_start\\n assert d == data[ofs_start:ofs_end]\\n num_bytes += len(d)\\n del d\\n else:\\n pos = randint(0, fsize)\\n assert buf[pos] == data[pos]\\n num_bytes += 1\\n # END handle mode\\n # END handle num accesses\\n\\n buf.end_access()\\n assert manager.num_file_handles()\\n assert manager.collect()\\n assert manager.num_file_handles() == 0\\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\\n mb = float(1000 * 1000)\\n mode_str = (access_mode and \\\"slice\\\") or \\\"single byte\\\"\\n print(\\\"%s: Made %i random %s accesses to buffer created from %s reading a total of %f mb in %f s (%f mb/s)\\\"\\n % (man_id, max_num_accesses, mode_str, type(item), num_bytes / mb, elapsed, (num_bytes / mb) / elapsed),\\n file=sys.stderr)\\n # END handle access mode\\n del buf\\n # END for each manager\\n # END for each input\\n os.close(fd)\\n\\n[end of smmap/test/test_buf.py]\",\n \"filename\": \"smmap/test/test_buf.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.util import (\\n MapWindow,\\n MapRegion,\\n MapRegionList,\\n ALLOCATIONGRANULARITY,\\n is_64_bit,\\n align_to_mmap\\n)\\n\\nimport os\\nimport sys\\n\\n\\nclass TestMMan(TestBase):\\n\\n def test_window(self):\\n wl = MapWindow(0, 1) # left\\n wc = MapWindow(1, 1) # center\\n wc2 = MapWindow(10, 5) # another center\\n wr = MapWindow(8000, 50) # right\\n\\n assert wl.ofs_end() == 1\\n assert wc.ofs_end() == 2\\n assert wr.ofs_end() == 8050\\n\\n # extension does nothing if already in place\\n maxsize = 100\\n wc.extend_left_to(wl, maxsize)\\n assert wc.ofs == 1 and wc.size == 1\\n wl.extend_right_to(wc, maxsize)\\n wl.extend_right_to(wc, maxsize)\\n assert wl.ofs == 0 and wl.size == 1\\n\\n # an actual left extension\\n pofs_end = wc2.ofs_end()\\n wc2.extend_left_to(wc, maxsize)\\n assert wc2.ofs == wc.ofs_end() and pofs_end == wc2.ofs_end()\\n\\n # respects maxsize\\n wc.extend_right_to(wr, maxsize)\\n assert wc.ofs == 1 and wc.size == maxsize\\n wc.extend_right_to(wr, maxsize)\\n assert wc.ofs == 1 and wc.size == maxsize\\n\\n # without maxsize\\n wc.extend_right_to(wr, sys.maxsize)\\n assert wc.ofs_end() == wr.ofs and wc.ofs == 1\\n\\n # extend left\\n wr.extend_left_to(wc2, maxsize)\\n wr.extend_left_to(wc2, maxsize)\\n assert wr.size == maxsize\\n\\n wr.extend_left_to(wc2, sys.maxsize)\\n assert wr.ofs == wc2.ofs_end()\\n\\n wc.align()\\n assert wc.ofs == 0 and wc.size == align_to_mmap(wc.size, True)\\n\\n def test_region(self):\\n with FileCreator(self.k_window_test_size, \\\"window_test\\\") as fc:\\n half_size = fc.size // 2\\n rofs = align_to_mmap(4200, False)\\n rfull = MapRegion(fc.path, 0, fc.size)\\n rhalfofs = MapRegion(fc.path, rofs, fc.size)\\n rhalfsize = MapRegion(fc.path, 0, half_size)\\n\\n # offsets\\n assert rfull.ofs_begin() == 0 and rfull.size() == fc.size\\n assert rfull.ofs_end() == fc.size # if this method works, it works always\\n\\n assert rhalfofs.ofs_begin() == rofs and rhalfofs.size() == fc.size - rofs\\n assert rhalfsize.ofs_begin() == 0 and rhalfsize.size() == half_size\\n\\n assert rfull.includes_ofs(0) and rfull.includes_ofs(fc.size - 1) and rfull.includes_ofs(half_size)\\n assert not rfull.includes_ofs(-1) and not rfull.includes_ofs(sys.maxsize)\\n\\n # auto-refcount\\n assert rfull.client_count() == 1\\n rfull2 = rfull\\n assert rfull.client_count() == 1, \\\"no auto-counting\\\"\\n\\n # window constructor\\n w = MapWindow.from_region(rfull)\\n assert w.ofs == rfull.ofs_begin() and w.ofs_end() == rfull.ofs_end()\\n\\n def test_region_list(self):\\n with FileCreator(100, \\\"sample_file\\\") as fc:\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n for item in (fc.path, fd):\\n ml = MapRegionList(item)\\n\\n assert len(ml) == 0\\n assert ml.path_or_fd() == item\\n assert ml.file_size() == fc.size\\n finally:\\n os.close(fd)\\n\\n def test_util(self):\\n assert isinstance(is_64_bit(), bool) # just call it\\n assert align_to_mmap(1, False) == 0\\n assert align_to_mmap(1, True) == ALLOCATIONGRANULARITY\\n\\n[end of smmap/test/test_util.py]\",\n \"filename\": \"smmap/test/test_util.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"from .lib import TestBase\\n\\n\\nclass TestTutorial(TestBase):\\n\\n def test_example(self):\\n # Memory Managers\\n ##################\\n import smmap\\n # This instance should be globally available in your application\\n # It is configured to be well suitable for 32-bit or 64 bit applications.\\n mman = smmap.SlidingWindowMapManager()\\n\\n # the manager provides much useful information about its current state\\n # like the amount of open file handles or the amount of mapped memory\\n assert mman.num_file_handles() == 0\\n assert mman.mapped_memory_size() == 0\\n # and many more ...\\n\\n # Cursors\\n ##########\\n import smmap.test.lib\\n with smmap.test.lib.FileCreator(1024 * 1024 * 8, \\\"test_file\\\") as fc:\\n # obtain a cursor to access some file.\\n c = mman.make_cursor(fc.path)\\n\\n # the cursor is now associated with the file, but not yet usable\\n assert c.is_associated()\\n assert not c.is_valid()\\n\\n # before you can use the cursor, you have to specify a window you want to\\n # access. The following just says you want as much data as possible starting\\n # from offset 0.\\n # To be sure your region could be mapped, query for validity\\n assert c.use_region().is_valid() # use_region returns self\\n\\n # once a region was mapped, you must query its dimension regularly\\n # to assure you don't try to access its buffer out of its bounds\\n assert c.size()\\n c.buffer()[0] # first byte\\n c.buffer()[1:10] # first 9 bytes\\n c.buffer()[c.size() - 1] # last byte\\n\\n # you can query absolute offsets, and check whether an offset is included\\n # in the cursor's data.\\n assert c.ofs_begin() < c.ofs_end()\\n assert c.includes_ofs(100)\\n\\n # If you are over out of bounds with one of your region requests, the\\n # cursor will be come invalid. It cannot be used in that state\\n assert not c.use_region(fc.size, 100).is_valid()\\n # map as much as possible after skipping the first 100 bytes\\n assert c.use_region(100).is_valid()\\n\\n # You can explicitly free cursor resources by unusing the cursor's region\\n c.unuse_region()\\n assert not c.is_valid()\\n\\n # Buffers\\n #########\\n # Create a default buffer which can operate on the whole file\\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\\n\\n # you can use it right away\\n assert buf.cursor().is_valid()\\n\\n buf[0] # access the first byte\\n buf[-1] # access the last ten bytes on the file\\n buf[-10:] # access the last ten bytes\\n\\n # If you want to keep the instance between different accesses, use the\\n # dedicated methods\\n buf.end_access()\\n assert not buf.cursor().is_valid() # you cannot use the buffer anymore\\n assert buf.begin_access(offset=10) # start using the buffer at an offset\\n\\n[end of smmap/test/test_tutorial.py]\",\n \"filename\": \"smmap/test/test_tutorial.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. smmap documentation master file, created by\\n sphinx-quickstart on Wed Jun 8 15:14:25 2011.\\n You can adapt this file completely to your liking, but it should at least\\n contain the root `toctree` directive.\\n\\nWelcome to smmap's documentation!\\n=================================\\n**smmap** is a pure python implementation of a sliding memory map to help unifying memory mapped access on 32 and 64 bit systems and to help managing resources more efficiently.\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n \\n intro\\n tutorial\\n api\\n changes\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of doc/source/index.rst]\",\n \"filename\": \"doc/source/index.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"###########\\nMotivation\\n###########\\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\\n\\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\\n\\n########\\nOverview\\n########\\n\\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\\n\\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\\n\\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\\n\\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\\n\\n#############\\nPrerequisites\\n#############\\n* Python 3.7+\\n* OSX, Windows or Linux\\n\\nThe package was tested on all of the previously mentioned configurations.\\n\\n###########\\nLimitations\\n###########\\n* The memory access is read-only by design.\\n\\n################\\nInstalling smmap\\n################\\nIts easiest to install smmap using the *pip* program::\\n \\n $ pip install smmap\\n \\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\\n\\nIf you have downloaded the source archive, the package can be installed by running the ``setup.py`` script::\\n \\n $ python setup.py install\\n\\nIt is advised to have a look at the :ref:`Usage Guide <tutorial-label>` for a brief introduction on the different database implementations.\\n\\n##################\\nHomepage and Links\\n##################\\nThe project is home on github at `https://github.com/gitpython-developers/smmap <https://github.com/gitpython-developers/smmap>`_.\\n\\nThe latest source can be cloned from github as well:\\n\\n * git://github.com/gitpython-developers/smmap.git\\n \\n \\nFor support, please use the git-python mailing list:\\n\\n * http://groups.google.com/group/git-python\\n \\n\\nIssues can be filed on github:\\n\\n * https://github.com/gitpython-developers/smmap/issues\\n \\n###################\\nLicense Information\\n###################\\n*smmap* is licensed under the New BSD License.\\n\\n.. _pip: http://www.pip-installer.org/en/latest/\\n\\n[end of doc/source/intro.rst]\",\n \"filename\": \"doc/source/intro.rst\",\n \"id\": \"23\"\n },\n {\n \"content\": \"#\\n# smmap documentation build configuration file, created by\\n# sphinx-quickstart on Wed Jun 8 15:14:25 2011.\\n#\\n# This file is execfile()d with the current directory set to its containing dir.\\n#\\n# Note that not all possible configuration values are present in this\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.append(os.path.abspath('../../'))\\n\\n# -- General configuration -----------------------------------------------------\\n\\n# Add any Sphinx extension module names here, as strings. They can be extensions\\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['.templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = 'smmap'\\ncopyright = '2011, Sebastian Thiel'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.8.0'\\n# The full version, including alpha/beta/rc tags.\\nrelease = '0.8.0'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of documents that shouldn't be included in the build.\\n#unused_docs = []\\n\\n# List of directories, relative to source directory, that shouldn't be searched\\n# for source files.\\nexclude_trees = []\\n\\n# The reST default role (used for this markup: `text`) to use for all documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n\\n# -- Options for HTML output ---------------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. Major themes that come with\\n# Sphinx are currently 'default' and 'sphinxdoc'.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['.static']\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_use_modindex = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# If nonempty, this is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = ''\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'smmapdoc'\\n\\n\\n# -- Options for LaTeX output --------------------------------------------------\\n\\n# The paper size ('letter' or 'a4').\\n#latex_paper_size = 'letter'\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#latex_font_size = '10pt'\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title, author, documentclass [howto/manual]).\\nlatex_documents = [\\n ('index', 'smmap.tex', 'smmap Documentation',\\n 'Sebastian Thiel', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# Additional stuff for the LaTeX preamble.\\n#latex_preamble = ''\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_use_modindex = True\\n\\n[end of doc/source/conf.py]\",\n \"filename\": \"doc/source/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \".. _tutorial-label:\\n\\n###########\\nUsage Guide\\n###########\\nThis text briefly introduces you to the basic design decisions and accompanying classes.\\n\\n******\\nDesign\\n******\\nPer application, there is *MemoryManager* which is held as static instance and used throughout the application. It can be configured to keep your resources within certain limits.\\n\\nTo access mapped regions, you require a cursor. Cursors point to exactly one file and serve as handles into it. As long as it exists, the respective memory region will remain available.\\n\\nFor convenience, a buffer implementation is provided which handles cursors and resource allocation behind its simple buffer like interface.\\n\\n***************\\nMemory Managers\\n***************\\nThere are two types of memory managers, one uses *static* windows, the other one uses *sliding* windows. A window is a region of a file mapped into memory. Although the names might be somewhat misleading as technically windows are always static, the *sliding* version will allocate relatively small windows whereas the *static* version will always map the whole file.\\n\\nThe *static* manager does nothing more than keeping a client count on the respective memory maps which always map the whole file, which allows to make some assumptions that can lead to simplified data access and increased performance, but reduces the compatibility to 32 bit systems or giant files.\\n\\nThe *sliding* memory manager therefore should be the default manager when preparing an application for handling huge amounts of data on 32 bit and 64 bit platforms::\\n\\n import smmap\\n # This instance should be globally available in your application\\n # It is configured to be well suitable for 32-bit or 64 bit applications.\\n mman = smmap.SlidingWindowMapManager()\\n \\n # the manager provides much useful information about its current state\\n # like the amount of open file handles or the amount of mapped memory\\n mman.num_file_handles()\\n mman.mapped_memory_size()\\n # and many more ...\\n\\n\\nCursors\\n*******\\n*Cursors* are handles that point onto a window, i.e. a region of a file mapped into memory. From them you may obtain a buffer through which the data of that window can actually be accessed::\\n\\n import smmap.test.lib\\n fc = smmap.test.lib.FileCreator(1024*1024*8, \\\"test_file\\\")\\n \\n # obtain a cursor to access some file.\\n c = mman.make_cursor(fc.path)\\n \\n # the cursor is now associated with the file, but not yet usable\\n assert c.is_associated()\\n assert not c.is_valid()\\n \\n # before you can use the cursor, you have to specify a window you want to \\n # access. The following just says you want as much data as possible starting\\n # from offset 0.\\n # To be sure your region could be mapped, query for validity\\n assert c.use_region().is_valid()\\t\\t# use_region returns self\\n \\n # once a region was mapped, you must query its dimension regularly\\n # to assure you don't try to access its buffer out of its bounds\\n assert c.size()\\n c.buffer()[0]\\t\\t\\t# first byte\\n c.buffer()[1:10]\\t\\t\\t# first 9 bytes\\n c.buffer()[c.size()-1] \\t# last byte\\n \\n # its recommended not to create big slices when feeding the buffer\\n # into consumers (e.g. struct or zlib). \\n # Instead, either give the buffer directly, or use pythons buffer command.\\n buffer(c.buffer(), 1, 9)\\t# first 9 bytes without copying them\\n \\n # you can query absolute offsets, and check whether an offset is included\\n # in the cursor's data.\\n assert c.ofs_begin() < c.ofs_end()\\n assert c.includes_ofs(100)\\n \\n # If you are over out of bounds with one of your region requests, the \\n # cursor will be come invalid. It cannot be used in that state\\n assert not c.use_region(fc.size, 100).is_valid()\\n # map as much as possible after skipping the first 100 bytes\\n assert c.use_region(100).is_valid()\\n \\n # You can explicitly free cursor resources by unusing the cursor's region\\n c.unuse_region()\\n assert not c.is_valid()\\n \\n\\nNow you would have to write your algorithms around this interface to properly slide through huge amounts of data. \\n \\nAlternatively you can use a convenience interface.\\n\\n*******\\nBuffers\\n*******\\nTo make first use easier, at the expense of performance, there is a Buffer implementation which uses a cursor underneath.\\n\\nWith it, you can access all data in a possibly huge file without having to take care of setting the cursor to different regions yourself::\\n\\n # Create a default buffer which can operate on the whole file\\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\\n \\n # you can use it right away\\n assert buf.cursor().is_valid()\\n \\n buf[0]\\t# access the first byte\\n buf[-1]\\t# access the last ten bytes on the file\\n buf[-10:]# access the last ten bytes\\n \\n # If you want to keep the instance between different accesses, use the\\n # dedicated methods\\n buf.end_access()\\n assert not buf.cursor().is_valid()\\t# you cannot use the buffer anymore\\n assert buf.begin_access(offset=10)\\t# start using the buffer at an offset\\n \\n # it will stop using resources automatically once it goes out of scope\\n \\nDisadvantages\\n*************\\nBuffers cannot be used in place of strings or maps, hence you have to slice them to have valid input for the sorts of struct and zlib. A slice means a lot of data handling overhead which makes buffers slower compared to using cursors directly. \\n\\n\\n[end of doc/source/tutorial.rst]\",\n \"filename\": \"doc/source/tutorial.rst\",\n \"id\": \"25\"\n },\n {\n \"content\": \"#########\\nChangelog\\n#########\\n\\n******\\nv5.0.2\\n******\\n\\n- remove a usage of mktemp\\n\\n******\\nv5.0.1\\n******\\n\\n- Added support for Python 3.12\\n\\n******\\nv6.0.0\\n******\\n\\nYANKED\\n\\n- Dropped support 3.6 and 3.7\\n- Declared support for Python 3.11 and 3.12\\n\\n******\\nv5.0.0\\n******\\n\\n- Dropped support 3.5\\n- Added support for Python 3.10\\n\\n******\\nv4.0.0\\n******\\n\\n- Dropped support for Python 2.7 and 3.4\\n- Added support for Python 3.7, 3.8, and 3.9\\n- Removed unused exc.MemoryManagerError and exc.RegionCollectionError\\n\\n******\\nv3.0.5\\n******\\n\\n- Restored Python 2 support removed in v3.0.2\\n- Changed release signature key to 27C50E7F590947D7273A741E85194C08421980C9.\\n See https://keybase.io/byronbates for proof of ownership.\\n\\n******\\nv3.0.4\\n******\\n\\n- Signed release (with correct key this time)\\n\\n******\\nv3.0.2\\n******\\n\\n- Signed release\\n- Switched to GitHub Actions for CI\\n\\n******\\nv3.0.1\\n******\\n- Switched back to the smmap package name on PyPI and fixed the smmap2 mirror package\\n (`#44 <https://github.com/gitpython-developers/smmap/issues/44>`_)\\n- Fixed setup.py ``long_description`` rendering\\n (`#40 <https://github.com/gitpython-developers/smmap/pull/40>`_)\\n\\n**********\\nv0.9.0\\n**********\\n- Fixed issue with resources never being freed as mmaps were never closed.\\n- Client counting is now done manually, instead of relying on pyton's reference count\\n\\n**********\\nv0.8.5\\n**********\\n- Fixed Python 3.0-3.3 regression, which also causes smmap to become about 3 times slower depending on the code path. It's related to this bug (http://bugs.python.org/issue15958), which was fixed in python 3.4\\n\\n**********\\nv0.8.4\\n**********\\n- Fixed Python 3 performance regression\\n\\n**********\\nv0.8.3\\n**********\\n- Cleaned up code and assured it works sufficiently well with python 3\\n\\n**********\\nv0.8.1\\n**********\\n- A single bugfix\\n\\n**********\\nv0.8.0 \\n**********\\n\\n- Initial Release\\n\\n[end of doc/source/changes.rst]\",\n \"filename\": \"doc/source/changes.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \".. _api-label:\\n\\n#############\\nAPI Reference\\n#############\\n\\n***********************\\nMapped Memory Managers\\n***********************\\n\\n.. automodule:: smmap.mman\\n :members:\\n :undoc-members:\\n\\n*******\\nBuffers\\n*******\\n\\n.. automodule:: smmap.buf\\n :members:\\n :undoc-members:\\n\\n*********\\nUtilities\\n*********\\n\\n.. automodule:: smmap.util\\n :members:\\n :undoc-members:\\n\\n\\n\\n\\n\\n\\n[end of doc/source/api.rst]\",\n \"filename\": \"doc/source/api.rst\",\n \"id\": \"27\"\n }\n]","isConversational":false}}},{"rowIdx":71,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 71,\n \"num_files\": 28,\n \"repo_id\": \"repo_0071\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"Copyright (C) 2010, 2011 Sebastian Thiel and contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions \nare met:\n\n* Redistributions of source code must retain the above copyright \nnotice, this list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright \nnotice, this list of conditions and the following disclaimer in the \ndocumentation and/or other materials provided with the distribution.\n\n* Neither the name of the async project nor the names of \nits contributors may be used to endorse or promote products derived \nfrom this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED \nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR \nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING \nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":".PHONY: all clean release force_release\n\nall:\n\t@grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all\n\nclean:\n\trm -rf build/ dist/ .eggs/ .tox/\n\nforce_release: clean\n\t./build-release.sh\n\ttwine upload dist/*\n\tgit push --tags origin master\n\n[end of Makefile]","filename":"Makefile","id":"1"},{"content":"# Include the license file\ninclude LICENSE\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"2"},{"content":"[run]\nsource = smmap\n\n; to make nosetests happy\n[report]\nomit = \n\t*/yaml*\n\t*/tests/*\n */python?.?/*\n */site-packages/nose/*\n[end of .coveragerc]","filename":".coveragerc","id":"3"},{"content":"## Motivation\n\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\n\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\n\n\n## Limitations\n\n* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.\n* The memory access is read-only by design.\n\n\n## Overview\n\n\n\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\n\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\n\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\n\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\n\n\n\n## Prerequisites\n\n* Python 3.7+\n* OSX, Windows or Linux\n\nThe package was tested on all of the previously mentioned configurations.\n\n## Installing smmap\n\n[](https://readthedocs.org/projects/smmap/?badge=latest)\n\nIts easiest to install smmap using the [pip](http://www.pip-installer.org/en/latest) program:\n\n```bash\n$ pip install smmap\n```\n\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\n\nIf you have downloaded the source archive, the package can be installed by running the `setup.py` script:\n\n```bash\n$ python setup.py install\n```\n\nIt is advised to have a look at the **Usage Guide** for a brief introduction on the different database implementations.\n\n\n\n## Homepage and Links\n\nThe project is home on github at https://github.com/gitpython-developers/smmap .\n\nThe latest source can be cloned from github as well:\n\n* git://github.com/gitpython-developers/smmap.git\n\n\nFor support, please use the git-python mailing list:\n\n* http://groups.google.com/group/git-python\n\n\nIssues can be filed on github:\n\n* https://github.com/gitpython-developers/smmap/issues\n\nA link to the pypi page related to this repository:\n\n* https://pypi.org/project/smmap/\n\n\n## License Information\n\n*smmap* is licensed under the New BSD License.\n\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"#!/usr/bin/env python\nimport os\n\ntry:\n from setuptools import setup, find_packages\nexcept ImportError:\n from ez_setup import use_setuptools\n use_setuptools()\n from setuptools import setup, find_packages\n\nimport smmap\n\nif os.path.exists(\"README.md\"):\n long_description = open('README.md', encoding=\"utf-8\").read().replace('\\r\\n', '\\n')\nelse:\n long_description = \"See https://github.com/gitpython-developers/smmap\"\n\nsetup(\n name=\"smmap\",\n version=smmap.__version__,\n description=\"A pure Python implementation of a sliding window memory map manager\",\n author=smmap.__author__,\n author_email=smmap.__contact__,\n url=smmap.__homepage__,\n platforms=[\"any\"],\n license=\"BSD-3-Clause\",\n packages=find_packages(),\n zip_safe=True,\n python_requires=\">=3.7\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Operating System :: POSIX\",\n \"Operating System :: Microsoft :: Windows\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.7\",\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 \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3 :: Only\",\n ],\n long_description=long_description,\n long_description_content_type='text/markdown',\n)\n\n[end of setup.py]","filename":"setup.py","id":"5"},{"content":"# Tox (http://tox.testrun.org/) is a tool for running tests\n# in multiple virtualenvs. This configuration file will run the\n# test suite on all supported python versions. To use it, \"pip install tox\"\n# and then run \"tox\" from this directory.\n\n[tox]\nenvlist = flake8, py{37, 38, 39, 310, 311, 312}\n\n[testenv]\ncommands = {envpython} -m pytest --cov smmap --cov-report xml {posargs}\ndeps =\n pytest\n pytest-cov\n\n[testenv:flake8]\ncommands = flake8 {posargs}\ndeps = flake8\n\n[end of tox.ini]","filename":"tox.ini","id":"6"},{"content":"[flake8]\nexclude = .tox,.venv,build,dist,doc\n\n[end of setup.cfg]","filename":"setup.cfg","id":"7"},{"content":"#!/bin/bash\n#\n# This script builds a release. If run in a venv, it auto-installs its tools.\n# You may want to run \"make release\" instead of running this script directly.\n\nset -eEu\n\nfunction release_with() {\n $1 -m build --sdist --wheel\n}\n\nif test -n \"${VIRTUAL_ENV:-}\"; then\n deps=(build twine) # Install twine along with build, as we need it later.\n echo \"Virtual environment detected. Adding packages: ${deps[*]}\"\n pip install --quiet --upgrade \"${deps[@]}\"\n echo 'Starting the build.'\n release_with python\nelse\n function suggest_venv() {\n venv_cmd='python -m venv env && source env/bin/activate'\n printf \"HELP: To avoid this error, use a virtual-env with '%s' instead.\\n\" \"$venv_cmd\"\n }\n trap suggest_venv ERR # This keeps the original exit (error) code.\n echo 'Starting the build.'\n release_with python3 # Outside a venv, use python3.\nfi\n\n[end of build-release.sh]","filename":"build-release.sh","id":"8"},{"content":"# Security Policy\n\nSee [GitPython](https://github.com/gitpython-developers/GitPython/blob/main/SECURITY.md). Vulnerabilities found in `smmap` can be reported there.\n\n[end of SECURITY.md]","filename":"SECURITY.md","id":"9"},{"content":"\"\"\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\"\"\"\nfrom .util import (\n MapWindow,\n MapRegion,\n MapRegionList,\n is_64_bit,\n)\n\nimport sys\nfrom functools import reduce\n\n__all__ = [\"StaticWindowMapManager\", \"SlidingWindowMapManager\", \"WindowCursor\"]\n#{ Utilities\n\n#}END utilities\n\n\nclass WindowCursor:\n\n \"\"\"\n Pointer into the mapped region of the memory manager, keeping the map\n alive until it is destroyed and no other client uses it.\n\n Cursors should not be created manually, but are instead returned by the SlidingWindowMapManager\n\n **Note:**: The current implementation is suited for static and sliding window managers, but it also means\n that it must be suited for the somewhat quite different sliding manager. It could be improved, but\n I see no real need to do so.\"\"\"\n __slots__ = (\n '_manager', # the manager keeping all file regions\n '_rlist', # a regions list with regions for our file\n '_region', # our current class:`MapRegion` or None\n '_ofs', # relative offset from the actually mapped area to our start area\n '_size' # maximum size we should provide\n )\n\n def __init__(self, manager=None, regions=None):\n self._manager = manager\n self._rlist = regions\n self._region = None\n self._ofs = 0\n self._size = 0\n\n def __del__(self):\n self._destroy()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self._destroy()\n\n def _destroy(self):\n \"\"\"Destruction code to decrement counters\"\"\"\n self.unuse_region()\n\n if self._rlist is not None:\n # Actual client count, which doesn't include the reference kept by the manager, nor ours\n # as we are about to be deleted\n try:\n if len(self._rlist) == 0:\n # Free all resources associated with the mapped file\n self._manager._fdict.pop(self._rlist.path_or_fd())\n # END remove regions list from manager\n except (TypeError, KeyError):\n # sometimes, during shutdown, getrefcount is None. Its possible\n # to re-import it, however, its probably better to just ignore\n # this python problem (for now).\n # The next step is to get rid of the error prone getrefcount altogether.\n pass\n # END exception handling\n # END handle regions\n\n def _copy_from(self, rhs):\n \"\"\"Copy all data from rhs into this instance, handles usage count\"\"\"\n self._manager = rhs._manager\n self._rlist = type(rhs._rlist)(rhs._rlist)\n self._region = rhs._region\n self._ofs = rhs._ofs\n self._size = rhs._size\n\n for region in self._rlist:\n region.increment_client_count()\n\n if self._region is not None:\n self._region.increment_client_count()\n # END handle regions\n\n def __copy__(self):\n \"\"\"copy module interface\"\"\"\n cpy = type(self)()\n cpy._copy_from(self)\n return cpy\n\n #{ Interface\n def assign(self, rhs):\n \"\"\"Assign rhs to this instance. This is required in order to get a real copy.\n Alternatively, you can copy an existing instance using the copy module\"\"\"\n self._destroy()\n self._copy_from(rhs)\n\n def use_region(self, offset=0, size=0, flags=0):\n \"\"\"Assure we point to a window which allows access to the given offset into the file\n\n :param offset: absolute offset in bytes into the file\n :param size: amount of bytes to map. If 0, all available bytes will be mapped\n :param flags: additional flags to be given to os.open in case a file handle is initially opened\n for mapping. Has no effect if a region can actually be reused.\n :return: this instance - it should be queried for whether it points to a valid memory region.\n This is not the case if the mapping failed because we reached the end of the file\n\n **Note:**: The size actually mapped may be smaller than the given size. If that is the case,\n either the file has reached its end, or the map was created between two existing regions\"\"\"\n need_region = True\n man = self._manager\n fsize = self._rlist.file_size()\n size = min(size or fsize, man.window_size() or fsize) # clamp size to window size\n\n if self._region is not None:\n if self._region.includes_ofs(offset):\n need_region = False\n else:\n self.unuse_region()\n # END handle existing region\n # END check existing region\n\n # offset too large ?\n if offset >= fsize:\n return self\n # END handle offset\n\n if need_region:\n self._region = man._obtain_region(self._rlist, offset, size, flags, False)\n self._region.increment_client_count()\n # END need region handling\n\n self._ofs = offset - self._region._b\n self._size = min(size, self._region.ofs_end() - offset)\n\n return self\n\n def unuse_region(self):\n \"\"\"Unuse the current region. Does nothing if we have no current region\n\n **Note:** the cursor unuses the region automatically upon destruction. It is recommended\n to un-use the region once you are done reading from it in persistent cursors as it\n helps to free up resource more quickly\"\"\"\n if self._region is not None:\n self._region.increment_client_count(-1)\n self._region = None\n # note: should reset ofs and size, but we spare that for performance. Its not\n # allowed to query information if we are not valid !\n\n def buffer(self):\n \"\"\"Return a buffer object which allows access to our memory region from our offset\n to the window size. Please note that it might be smaller than you requested when calling use_region()\n\n **Note:** You can only obtain a buffer if this instance is_valid() !\n\n **Note:** buffers should not be cached passed the duration of your access as it will\n prevent resources from being freed even though they might not be accounted for anymore !\"\"\"\n return memoryview(self._region.buffer())[self._ofs:self._ofs+self._size]\n\n def map(self):\n \"\"\"\n :return: the underlying raw memory map. Please not that the offset and size is likely to be different\n to what you set as offset and size. Use it only if you are sure about the region it maps, which is the whole\n file in case of StaticWindowMapManager\"\"\"\n return self._region.map()\n\n def is_valid(self):\n \"\"\":return: True if we have a valid and usable region\"\"\"\n return self._region is not None\n\n def is_associated(self):\n \"\"\":return: True if we are associated with a specific file already\"\"\"\n return self._rlist is not None\n\n def ofs_begin(self):\n \"\"\":return: offset to the first byte pointed to by our cursor\n\n **Note:** only if is_valid() is True\"\"\"\n return self._region._b + self._ofs\n\n def ofs_end(self):\n \"\"\":return: offset to one past the last available byte\"\"\"\n # unroll method calls for performance !\n return self._region._b + self._ofs + self._size\n\n def size(self):\n \"\"\":return: amount of bytes we point to\"\"\"\n return self._size\n\n def region(self):\n \"\"\":return: our mapped region, or None if nothing is mapped yet\n :raise AssertionError: if we have no current region. This is only useful for debugging\"\"\"\n return self._region\n\n def includes_ofs(self, ofs):\n \"\"\":return: True if the given absolute offset is contained in the cursors\n current region\n\n **Note:** cursor must be valid for this to work\"\"\"\n # unroll methods\n return (self._region._b + self._ofs) <= ofs < (self._region._b + self._ofs + self._size)\n\n def file_size(self):\n \"\"\":return: size of the underlying file\"\"\"\n return self._rlist.file_size()\n\n def path_or_fd(self):\n \"\"\":return: path or file descriptor of the underlying mapped file\"\"\"\n return self._rlist.path_or_fd()\n\n def path(self):\n \"\"\":return: path of the underlying mapped file\n :raise ValueError: if attached path is not a path\"\"\"\n if isinstance(self._rlist.path_or_fd(), int):\n raise ValueError(\"Path queried although mapping was applied to a file descriptor\")\n # END handle type\n return self._rlist.path_or_fd()\n\n def fd(self):\n \"\"\":return: file descriptor used to create the underlying mapping.\n\n **Note:** it is not required to be valid anymore\n :raise ValueError: if the mapping was not created by a file descriptor\"\"\"\n if isinstance(self._rlist.path_or_fd(), str):\n raise ValueError(\"File descriptor queried although mapping was generated from path\")\n # END handle type\n return self._rlist.path_or_fd()\n\n #} END interface\n\n\nclass StaticWindowMapManager:\n\n \"\"\"Provides a manager which will produce single size cursors that are allowed\n to always map the whole file.\n\n Clients must be written to specifically know that they are accessing their data\n through a StaticWindowMapManager, as they otherwise have to deal with their window size.\n\n These clients would have to use a SlidingWindowMapBuffer to hide this fact.\n\n This type will always use a maximum window size, and optimize certain methods to\n accommodate this fact\"\"\"\n\n __slots__ = [\n '_fdict', # mapping of path -> StorageHelper (of some kind\n '_window_size', # maximum size of a window\n '_max_memory_size', # maximum amount of memory we may allocate\n '_max_handle_count', # maximum amount of handles to keep open\n '_memory_size', # currently allocated memory size\n '_handle_count', # amount of currently allocated file handles\n ]\n\n #{ Configuration\n MapRegionListCls = MapRegionList\n MapWindowCls = MapWindow\n MapRegionCls = MapRegion\n WindowCursorCls = WindowCursor\n #} END configuration\n\n _MB_in_bytes = 1024 * 1024\n\n def __init__(self, window_size=0, max_memory_size=0, max_open_handles=sys.maxsize):\n \"\"\"initialize the manager with the given parameters.\n :param window_size: if -1, a default window size will be chosen depending on\n the operating system's architecture. It will internally be quantified to a multiple of the page size\n If 0, the window may have any size, which basically results in mapping the whole file at one\n :param max_memory_size: maximum amount of memory we may map at once before releasing mapped regions.\n If 0, a viable default will be set depending on the system's architecture.\n It is a soft limit that is tried to be kept, but nothing bad happens if we have to over-allocate\n :param max_open_handles: if not maxint, limit the amount of open file handles to the given number.\n Otherwise the amount is only limited by the system itself. If a system or soft limit is hit,\n the manager will free as many handles as possible\"\"\"\n self._fdict = dict()\n self._window_size = window_size\n self._max_memory_size = max_memory_size\n self._max_handle_count = max_open_handles\n self._memory_size = 0\n self._handle_count = 0\n\n if window_size < 0:\n coeff = 64\n if is_64_bit():\n coeff = 1024\n # END handle arch\n self._window_size = coeff * self._MB_in_bytes\n # END handle max window size\n\n if max_memory_size == 0:\n coeff = 1024\n if is_64_bit():\n coeff = 8192\n # END handle arch\n self._max_memory_size = coeff * self._MB_in_bytes\n # END handle max memory size\n\n #{ Internal Methods\n\n def _collect_lru_region(self, size):\n \"\"\"Unmap the region which was least-recently used and has no client\n :param size: size of the region we want to map next (assuming its not already mapped partially or full\n if 0, we try to free any available region\n :return: Amount of freed regions\n\n .. Note::\n We don't raise exceptions anymore, in order to keep the system working, allowing temporary overallocation.\n If the system runs out of memory, it will tell.\n\n .. TODO::\n implement a case where all unusued regions are discarded efficiently.\n Currently its only brute force\n \"\"\"\n num_found = 0\n while (size == 0) or (self._memory_size + size > self._max_memory_size):\n lru_region = None\n lru_list = None\n for regions in self._fdict.values():\n for region in regions:\n # check client count - if it's 1, it's just us\n if (region.client_count() == 1 and\n (lru_region is None or region._uc < lru_region._uc)):\n lru_region = region\n lru_list = regions\n # END update lru_region\n # END for each region\n # END for each regions list\n\n if lru_region is None:\n break\n # END handle region not found\n\n num_found += 1\n del(lru_list[lru_list.index(lru_region)])\n lru_region.increment_client_count(-1)\n self._memory_size -= lru_region.size()\n self._handle_count -= 1\n # END while there is more memory to free\n return num_found\n\n def _obtain_region(self, a, offset, size, flags, is_recursive):\n \"\"\"Utility to create a new region - for more information on the parameters,\n see MapCursor.use_region.\n :param a: A regions (a)rray\n :return: The newly created region\"\"\"\n if self._memory_size + size > self._max_memory_size:\n self._collect_lru_region(size)\n # END handle collection\n\n r = None\n if a:\n assert len(a) == 1\n r = a[0]\n else:\n try:\n r = self.MapRegionCls(a.path_or_fd(), 0, sys.maxsize, flags)\n except Exception:\n # apparently we are out of system resources or hit a limit\n # As many more operations are likely to fail in that condition (\n # like reading a file from disk, etc) we free up as much as possible\n # As this invalidates our insert position, we have to recurse here\n if is_recursive:\n # we already tried this, and still have no success in obtaining\n # a mapping. This is an exception, so we propagate it\n raise\n # END handle existing recursion\n self._collect_lru_region(0)\n return self._obtain_region(a, offset, size, flags, True)\n # END handle exceptions\n\n self._handle_count += 1\n self._memory_size += r.size()\n a.append(r)\n # END handle array\n\n assert r.includes_ofs(offset)\n return r\n\n #}END internal methods\n\n #{ Interface\n def make_cursor(self, path_or_fd):\n \"\"\"\n :return: a cursor pointing to the given path or file descriptor.\n It can be used to map new regions of the file into memory\n\n **Note:** if a file descriptor is given, it is assumed to be open and valid,\n but may be closed afterwards. To refer to the same file, you may reuse\n your existing file descriptor, but keep in mind that new windows can only\n be mapped as long as it stays valid. This is why the using actual file paths\n are preferred unless you plan to keep the file descriptor open.\n\n **Note:** file descriptors are problematic as they are not necessarily unique, as two\n different files opened and closed in succession might have the same file descriptor id.\n\n **Note:** Using file descriptors directly is faster once new windows are mapped as it\n prevents the file to be opened again just for the purpose of mapping it.\"\"\"\n regions = self._fdict.get(path_or_fd)\n if regions is None:\n regions = self.MapRegionListCls(path_or_fd)\n self._fdict[path_or_fd] = regions\n # END obtain region for path\n return self.WindowCursorCls(self, regions)\n\n def collect(self):\n \"\"\"Collect all available free-to-collect mapped regions\n :return: Amount of freed handles\"\"\"\n return self._collect_lru_region(0)\n\n def num_file_handles(self):\n \"\"\":return: amount of file handles in use. Each mapped region uses one file handle\"\"\"\n return self._handle_count\n\n def num_open_files(self):\n \"\"\"Amount of opened files in the system\"\"\"\n return reduce(lambda x, y: x + y, (1 for rlist in self._fdict.values() if len(rlist) > 0), 0)\n\n def window_size(self):\n \"\"\":return: size of each window when allocating new regions\"\"\"\n return self._window_size\n\n def mapped_memory_size(self):\n \"\"\":return: amount of bytes currently mapped in total\"\"\"\n return self._memory_size\n\n def max_file_handles(self):\n \"\"\":return: maximum amount of handles we may have opened\"\"\"\n return self._max_handle_count\n\n def max_mapped_memory_size(self):\n \"\"\":return: maximum amount of memory we may allocate\"\"\"\n return self._max_memory_size\n\n #} END interface\n\n #{ Special Purpose Interface\n\n def force_map_handle_removal_win(self, base_path):\n \"\"\"ONLY AVAILABLE ON WINDOWS\n On windows removing files is not allowed if anybody still has it opened.\n If this process is ourselves, and if the whole process uses this memory\n manager (as far as the parent framework is concerned) we can enforce\n closing all memory maps whose path matches the given base path to\n allow the respective operation after all.\n The respective system must NOT access the closed memory regions anymore !\n This really may only be used if you know that the items which keep\n the cursors alive will not be using it anymore. They need to be recreated !\n :return: Amount of closed handles\n\n **Note:** does nothing on non-windows platforms\"\"\"\n if sys.platform != 'win32':\n return\n # END early bailout\n\n num_closed = 0\n for path, rlist in self._fdict.items():\n if path.startswith(base_path):\n for region in rlist:\n region.release()\n num_closed += 1\n # END path matches\n # END for each path\n return num_closed\n #} END special purpose interface\n\n\nclass SlidingWindowMapManager(StaticWindowMapManager):\n\n \"\"\"Maintains a list of ranges of mapped memory regions in one or more files and allows to easily\n obtain additional regions assuring there is no overlap.\n Once a certain memory limit is reached globally, or if there cannot be more open file handles\n which result from each mmap call, the least recently used, and currently unused mapped regions\n are unloaded automatically.\n\n **Note:** currently not thread-safe !\n\n **Note:** in the current implementation, we will automatically unload windows if we either cannot\n create more memory maps (as the open file handles limit is hit) or if we have allocated more than\n a safe amount of memory already, which would possibly cause memory allocations to fail as our address\n space is full.\"\"\"\n\n __slots__ = tuple()\n\n def __init__(self, window_size=-1, max_memory_size=0, max_open_handles=sys.maxsize):\n \"\"\"Adjusts the default window size to -1\"\"\"\n super().__init__(window_size, max_memory_size, max_open_handles)\n\n def _obtain_region(self, a, offset, size, flags, is_recursive):\n # bisect to find an existing region. The c++ implementation cannot\n # do that as it uses a linked list for regions.\n r = None\n lo = 0\n hi = len(a)\n while lo < hi:\n mid = (lo + hi) // 2\n ofs = a[mid]._b\n if ofs <= offset:\n if a[mid].includes_ofs(offset):\n r = a[mid]\n break\n # END have region\n lo = mid + 1\n else:\n hi = mid\n # END handle position\n # END while bisecting\n\n if r is None:\n window_size = self._window_size\n left = self.MapWindowCls(0, 0)\n mid = self.MapWindowCls(offset, size)\n right = self.MapWindowCls(a.file_size(), 0)\n\n # we want to honor the max memory size, and assure we have anough\n # memory available\n # Save calls !\n if self._memory_size + window_size > self._max_memory_size:\n self._collect_lru_region(window_size)\n # END handle collection\n\n # we assume the list remains sorted by offset\n insert_pos = 0\n len_regions = len(a)\n if len_regions == 1:\n if a[0]._b <= offset:\n insert_pos = 1\n # END maintain sort\n else:\n # find insert position\n insert_pos = len_regions\n for i, region in enumerate(a):\n if region._b > offset:\n insert_pos = i\n break\n # END if insert position is correct\n # END for each region\n # END obtain insert pos\n\n # adjust the actual offset and size values to create the largest\n # possible mapping\n if insert_pos == 0:\n if len_regions:\n right = self.MapWindowCls.from_region(a[insert_pos])\n # END adjust right side\n else:\n if insert_pos != len_regions:\n right = self.MapWindowCls.from_region(a[insert_pos])\n # END adjust right window\n left = self.MapWindowCls.from_region(a[insert_pos - 1])\n # END adjust surrounding windows\n\n mid.extend_left_to(left, window_size)\n mid.extend_right_to(right, window_size)\n mid.align()\n\n # it can happen that we align beyond the end of the file\n if mid.ofs_end() > right.ofs:\n mid.size = right.ofs - mid.ofs\n # END readjust size\n\n # insert new region at the right offset to keep the order\n try:\n if self._handle_count >= self._max_handle_count:\n raise Exception\n # END assert own imposed max file handles\n r = self.MapRegionCls(a.path_or_fd(), mid.ofs, mid.size, flags)\n except Exception:\n # apparently we are out of system resources or hit a limit\n # As many more operations are likely to fail in that condition (\n # like reading a file from disk, etc) we free up as much as possible\n # As this invalidates our insert position, we have to recurse here\n if is_recursive:\n # we already tried this, and still have no success in obtaining\n # a mapping. This is an exception, so we propagate it\n raise\n # END handle existing recursion\n self._collect_lru_region(0)\n return self._obtain_region(a, offset, size, flags, True)\n # END handle exceptions\n\n self._handle_count += 1\n self._memory_size += r.size()\n a.insert(insert_pos, r)\n # END create new region\n return r\n\n[end of smmap/mman.py]","filename":"smmap/mman.py","id":"10"},{"content":"\"\"\"Module with a simple buffer implementation using the memory manager\"\"\"\nimport sys\n\n__all__ = [\"SlidingWindowMapBuffer\"]\n\n\nclass SlidingWindowMapBuffer:\n\n \"\"\"A buffer like object which allows direct byte-wise object and slicing into\n memory of a mapped file. The mapping is controlled by the provided cursor.\n\n The buffer is relative, that is if you map an offset, index 0 will map to the\n first byte at the offset you used during initialization or begin_access\n\n **Note:** Although this type effectively hides the fact that there are mapped windows\n underneath, it can unfortunately not be used in any non-pure python method which\n needs a buffer or string\"\"\"\n __slots__ = (\n '_c', # our cursor\n '_size', # our supposed size\n )\n\n def __init__(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\n \"\"\"Initialize the instance to operate on the given cursor.\n :param cursor: if not None, the associated cursor to the file you want to access\n If None, you have call begin_access before using the buffer and provide a cursor\n :param offset: absolute offset in bytes\n :param size: the total size of the mapping. Defaults to the maximum possible size\n From that point on, the __len__ of the buffer will be the given size or the file size.\n If the size is larger than the mappable area, you can only access the actually available\n area, although the length of the buffer is reported to be your given size.\n Hence it is in your own interest to provide a proper size !\n :param flags: Additional flags to be passed to os.open\n :raise ValueError: if the buffer could not achieve a valid state\"\"\"\n self._c = cursor\n if cursor and not self.begin_access(cursor, offset, size, flags):\n raise ValueError(\"Failed to allocate the buffer - probably the given offset is out of bounds\")\n # END handle offset\n\n def __del__(self):\n self.end_access()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self.end_access()\n\n def __len__(self):\n return self._size\n\n def __getitem__(self, i):\n if isinstance(i, slice):\n return self.__getslice__(i.start or 0, i.stop or self._size)\n c = self._c\n assert c.is_valid()\n if i < 0:\n i = self._size + i\n if not c.includes_ofs(i):\n c.use_region(i, 1)\n # END handle region usage\n return c.buffer()[i - c.ofs_begin()]\n\n def __getslice__(self, i, j):\n c = self._c\n # fast path, slice fully included - safes a concatenate operation and\n # should be the default\n assert c.is_valid()\n if i < 0:\n i = self._size + i\n if j == sys.maxsize:\n j = self._size\n if j < 0:\n j = self._size + j\n if (c.ofs_begin() <= i) and (j < c.ofs_end()):\n b = c.ofs_begin()\n return c.buffer()[i - b:j - b]\n else:\n l = j - i # total length\n ofs = i\n # It's fastest to keep tokens and join later, especially in py3, which was 7 times slower\n # in the previous iteration of this code\n md = list()\n while l:\n c.use_region(ofs, l)\n assert c.is_valid()\n d = c.buffer()[:l]\n ofs += len(d)\n l -= len(d)\n # Make sure we don't keep references, as c.use_region() might attempt to free resources, but\n # can't unless we use pure bytes\n if hasattr(d, 'tobytes'):\n d = d.tobytes()\n md.append(d)\n # END while there are bytes to read\n return b''.join(md)\n # END fast or slow path\n #{ Interface\n\n def begin_access(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\n \"\"\"Call this before the first use of this instance. The method was already\n called by the constructor in case sufficient information was provided.\n\n For more information no the parameters, see the __init__ method\n :param path: if cursor is None the existing one will be used.\n :return: True if the buffer can be used\"\"\"\n if cursor:\n self._c = cursor\n # END update our cursor\n\n # reuse existing cursors if possible\n if self._c is not None and self._c.is_associated():\n res = self._c.use_region(offset, size, flags).is_valid()\n if res:\n # if given size is too large or default, we computer a proper size\n # If its smaller, we assume the combination between offset and size\n # as chosen by the user is correct and use it !\n # If not, the user is in trouble.\n if size > self._c.file_size():\n size = self._c.file_size() - offset\n # END handle size\n self._size = size\n # END set size\n return res\n # END use our cursor\n return False\n\n def end_access(self):\n \"\"\"Call this method once you are done using the instance. It is automatically\n called on destruction, and should be called just in time to allow system\n resources to be freed.\n\n Once you called end_access, you must call begin access before reusing this instance!\"\"\"\n self._size = 0\n if self._c is not None:\n self._c.unuse_region()\n # END unuse region\n\n def cursor(self):\n \"\"\":return: the currently set cursor which provides access to the data\"\"\"\n return self._c\n\n #}END interface\n\n[end of smmap/buf.py]","filename":"smmap/buf.py","id":"11"},{"content":"\"\"\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\"\"\"\nimport os\nimport sys\n\nfrom mmap import mmap, ACCESS_READ\nfrom mmap import ALLOCATIONGRANULARITY\n\n__all__ = [\"align_to_mmap\", \"is_64_bit\",\n \"MapWindow\", \"MapRegion\", \"MapRegionList\", \"ALLOCATIONGRANULARITY\"]\n\n#{ Utilities\n\n\ndef align_to_mmap(num, round_up):\n \"\"\"\n Align the given integer number to the closest page offset, which usually is 4096 bytes.\n\n :param round_up: if True, the next higher multiple of page size is used, otherwise\n the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)\n :return: num rounded to closest page\"\"\"\n res = (num // ALLOCATIONGRANULARITY) * ALLOCATIONGRANULARITY\n if round_up and (res != num):\n res += ALLOCATIONGRANULARITY\n # END handle size\n return res\n\n\ndef is_64_bit():\n \"\"\":return: True if the system is 64 bit. Otherwise it can be assumed to be 32 bit\"\"\"\n return sys.maxsize > (1 << 32) - 1\n\n#}END utilities\n\n\n#{ Utility Classes\n\nclass MapWindow:\n\n \"\"\"Utility type which is used to snap windows towards each other, and to adjust their size\"\"\"\n __slots__ = (\n 'ofs', # offset into the file in bytes\n 'size' # size of the window in bytes\n )\n\n def __init__(self, offset, size):\n self.ofs = offset\n self.size = size\n\n def __repr__(self):\n return \"MapWindow(%i, %i)\" % (self.ofs, self.size)\n\n @classmethod\n def from_region(cls, region):\n \"\"\":return: new window from a region\"\"\"\n return cls(region._b, region.size())\n\n def ofs_end(self):\n return self.ofs + self.size\n\n def align(self):\n \"\"\"Assures the previous window area is contained in the new one\"\"\"\n nofs = align_to_mmap(self.ofs, 0)\n self.size += self.ofs - nofs # keep size constant\n self.ofs = nofs\n self.size = align_to_mmap(self.size, 1)\n\n def extend_left_to(self, window, max_size):\n \"\"\"Adjust the offset to start where the given window on our left ends if possible,\n but don't make yourself larger than max_size.\n The resize will assure that the new window still contains the old window area\"\"\"\n rofs = self.ofs - window.ofs_end()\n nsize = rofs + self.size\n rofs -= nsize - min(nsize, max_size)\n self.ofs -= rofs\n self.size += rofs\n\n def extend_right_to(self, window, max_size):\n \"\"\"Adjust the size to make our window end where the right window begins, but don't\n get larger than max_size\"\"\"\n self.size = min(self.size + (window.ofs - self.ofs_end()), max_size)\n\n\nclass MapRegion:\n\n \"\"\"Defines a mapped region of memory, aligned to pagesizes\n\n **Note:** deallocates used region automatically on destruction\"\"\"\n __slots__ = [\n '_b', # beginning of mapping\n '_mf', # mapped memory chunk (as returned by mmap)\n '_uc', # total amount of usages\n '_size', # cached size of our memory map\n '__weakref__'\n ]\n\n #{ Configuration\n #} END configuration\n\n def __init__(self, path_or_fd, ofs, size, flags=0):\n \"\"\"Initialize a region, allocate the memory map\n :param path_or_fd: path to the file to map, or the opened file descriptor\n :param ofs: **aligned** offset into the file to be mapped\n :param size: if size is larger then the file on disk, the whole file will be\n allocated the the size automatically adjusted\n :param flags: additional flags to be given when opening the file.\n :raise Exception: if no memory can be allocated\"\"\"\n self._b = ofs\n self._size = 0\n self._uc = 0\n\n if isinstance(path_or_fd, int):\n fd = path_or_fd\n else:\n fd = os.open(path_or_fd, os.O_RDONLY | getattr(os, 'O_BINARY', 0) | flags)\n # END handle fd\n\n try:\n kwargs = dict(access=ACCESS_READ, offset=ofs)\n corrected_size = size\n sizeofs = ofs\n\n # have to correct size, otherwise (instead of the c version) it will\n # bark that the size is too large ... many extra file accesses because\n # if this ... argh !\n actual_size = min(os.fstat(fd).st_size - sizeofs, corrected_size)\n self._mf = mmap(fd, actual_size, **kwargs)\n # END handle memory mode\n\n self._size = len(self._mf)\n finally:\n if isinstance(path_or_fd, str):\n os.close(fd)\n # END only close it if we opened it\n # END close file handle\n # We assume the first one to use us keeps us around\n self.increment_client_count()\n\n def __repr__(self):\n return \"MapRegion<%i, %i>\" % (self._b, self.size())\n\n #{ Interface\n\n def buffer(self):\n \"\"\":return: a buffer containing the memory\"\"\"\n return self._mf\n\n def map(self):\n \"\"\":return: a memory map containing the memory\"\"\"\n return self._mf\n\n def ofs_begin(self):\n \"\"\":return: absolute byte offset to the first byte of the mapping\"\"\"\n return self._b\n\n def size(self):\n \"\"\":return: total size of the mapped region in bytes\"\"\"\n return self._size\n\n def ofs_end(self):\n \"\"\":return: Absolute offset to one byte beyond the mapping into the file\"\"\"\n return self._b + self._size\n\n def includes_ofs(self, ofs):\n \"\"\":return: True if the given offset can be read in our mapped region\"\"\"\n return self._b <= ofs < self._b + self._size\n\n def client_count(self):\n \"\"\":return: number of clients currently using this region\"\"\"\n return self._uc\n\n def increment_client_count(self, ofs = 1):\n \"\"\"Adjust the usage count by the given positive or negative offset.\n If usage count equals 0, we will auto-release our resources\n :return: True if we released resources, False otherwise. In the latter case, we can still be used\"\"\"\n self._uc += ofs\n assert self._uc > -1, \"Increments must match decrements, usage counter negative: %i\" % self._uc\n\n if self.client_count() == 0:\n self.release()\n return True\n else:\n return False\n # end handle release\n\n def release(self):\n \"\"\"Release all resources this instance might hold. Must only be called if there usage_count() is zero\"\"\"\n self._mf.close()\n\n #} END interface\n\n\nclass MapRegionList(list):\n\n \"\"\"List of MapRegion instances associating a path with a list of regions.\"\"\"\n __slots__ = (\n '_path_or_fd', # path or file descriptor which is mapped by all our regions\n '_file_size' # total size of the file we map\n )\n\n def __new__(cls, path):\n return super().__new__(cls)\n\n def __init__(self, path_or_fd):\n self._path_or_fd = path_or_fd\n self._file_size = None\n\n def path_or_fd(self):\n \"\"\":return: path or file descriptor we are attached to\"\"\"\n return self._path_or_fd\n\n def file_size(self):\n \"\"\":return: size of file we manager\"\"\"\n if self._file_size is None:\n if isinstance(self._path_or_fd, str):\n self._file_size = os.stat(self._path_or_fd).st_size\n else:\n self._file_size = os.fstat(self._path_or_fd).st_size\n # END handle path type\n # END update file size\n return self._file_size\n\n#} END utility classes\n\n[end of smmap/util.py]","filename":"smmap/util.py","id":"12"},{"content":"\"\"\"Initialize the smmap package\"\"\"\n\n__author__ = \"Sebastian Thiel\"\n__contact__ = \"byronimo@gmail.com\"\n__homepage__ = \"https://github.com/gitpython-developers/smmap\"\nversion_info = (5, 0, 2)\n__version__ = '.'.join(str(i) for i in version_info)\n\n# make everything available in root package for convenience\nfrom .mman import *\nfrom .buf import *\n\n[end of smmap/__init__.py]","filename":"smmap/__init__.py","id":"13"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = build\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\n\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\t-rm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make all-pdf' or \\`make all-ps' in that directory to\" \\\n\t \"run these through (pdf)latex.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\n[end of doc/Makefile]","filename":"doc/Makefile","id":"14"},{"content":"@ECHO OFF\n\nREM Command file for Sphinx documentation\n\nset SPHINXBUILD=sphinx-build\nset BUILDDIR=build\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\nif NOT \"%PAPER%\" == \"\" (\n\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\n)\n\nif \"%1\" == \"\" goto help\n\nif \"%1\" == \"help\" (\n\t:help\n\techo.Please use `make ^<target^>` where ^<target^> is one of\n\techo. html to make standalone HTML files\n\techo. dirhtml to make HTML files named index.html in directories\n\techo. pickle to make pickle files\n\techo. json to make JSON files\n\techo. htmlhelp to make HTML files and a HTML help project\n\techo. qthelp to make HTML files and a qthelp project\n\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\n\techo. changes to make an overview over all changed/added/deprecated items\n\techo. linkcheck to check all external links for integrity\n\techo. doctest to run all doctests embedded in the documentation if enabled\n\tgoto end\n)\n\nif \"%1\" == \"clean\" (\n\tfor /d %%i in (%BUILDDIR%\\*) do rmdir /q /s %%i\n\tdel /q /s %BUILDDIR%\\*\n\tgoto end\n)\n\nif \"%1\" == \"html\" (\n\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\n\tgoto end\n)\n\nif \"%1\" == \"dirhtml\" (\n\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\n\tgoto end\n)\n\nif \"%1\" == \"pickle\" (\n\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\n\techo.\n\techo.Build finished; now you can process the pickle files.\n\tgoto end\n)\n\nif \"%1\" == \"json\" (\n\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\n\techo.\n\techo.Build finished; now you can process the JSON files.\n\tgoto end\n)\n\nif \"%1\" == \"htmlhelp\" (\n\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\n\techo.\n\techo.Build finished; now you can run HTML Help Workshop with the ^\n.hhp project file in %BUILDDIR%/htmlhelp.\n\tgoto end\n)\n\nif \"%1\" == \"qthelp\" (\n\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\n\techo.\n\techo.Build finished; now you can run \"qcollectiongenerator\" with the ^\n.qhcp project file in %BUILDDIR%/qthelp, like this:\n\techo.^> qcollectiongenerator %BUILDDIR%\\qthelp\\smmap.qhcp\n\techo.To view the help file:\n\techo.^> assistant -collectionFile %BUILDDIR%\\qthelp\\smmap.ghc\n\tgoto end\n)\n\nif \"%1\" == \"latex\" (\n\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\n\techo.\n\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\n\tgoto end\n)\n\nif \"%1\" == \"changes\" (\n\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\n\techo.\n\techo.The overview file is in %BUILDDIR%/changes.\n\tgoto end\n)\n\nif \"%1\" == \"linkcheck\" (\n\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\n\techo.\n\techo.Link check complete; look for any errors in the above output ^\nor in %BUILDDIR%/linkcheck/output.txt.\n\tgoto end\n)\n\nif \"%1\" == \"doctest\" (\n\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\n\techo.\n\techo.Testing of doctests in the sources finished, look at the ^\nresults in %BUILDDIR%/doctest/output.txt.\n\tgoto end\n)\n\n:end\n\n[end of doc/make.bat]","filename":"doc/make.bat","id":"15"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.mman import (\n WindowCursor,\n SlidingWindowMapManager,\n StaticWindowMapManager\n)\nfrom smmap.util import align_to_mmap\n\nfrom random import randint\nfrom time import time\nimport os\nimport sys\nfrom copy import copy\n\n\nclass TestMMan(TestBase):\n\n def test_cursor(self):\n with FileCreator(self.k_window_test_size, \"cursor_test\") as fc:\n man = SlidingWindowMapManager()\n ci = WindowCursor(man) # invalid cursor\n assert not ci.is_valid()\n assert not ci.is_associated()\n assert ci.size() == 0 # this is cached, so we can query it in invalid state\n\n cv = man.make_cursor(fc.path)\n assert not cv.is_valid() # no region mapped yet\n assert cv.is_associated() # but it know where to map it from\n assert cv.file_size() == fc.size\n assert cv.path() == fc.path\n\n # copy module\n cio = copy(cv)\n assert not cio.is_valid() and cio.is_associated()\n\n # assign method\n assert not ci.is_associated()\n ci.assign(cv)\n assert not ci.is_valid() and ci.is_associated()\n\n # unuse non-existing region is fine\n cv.unuse_region()\n cv.unuse_region()\n\n # destruction is fine (even multiple times)\n cv._destroy()\n WindowCursor(man)._destroy()\n\n def test_memory_manager(self):\n slide_man = SlidingWindowMapManager()\n static_man = StaticWindowMapManager()\n\n for man in (static_man, slide_man):\n assert man.num_file_handles() == 0\n assert man.num_open_files() == 0\n winsize_cmp_val = 0\n if isinstance(man, StaticWindowMapManager):\n winsize_cmp_val = -1\n # END handle window size\n assert man.window_size() > winsize_cmp_val\n assert man.mapped_memory_size() == 0\n assert man.max_mapped_memory_size() > 0\n\n # collection doesn't raise in 'any' mode\n man._collect_lru_region(0)\n # doesn't raise if we are within the limit\n man._collect_lru_region(10)\n\n # doesn't fail if we over-allocate\n assert man._collect_lru_region(sys.maxsize) == 0\n\n # use a region, verify most basic functionality\n with FileCreator(self.k_window_test_size, \"manager_test\") as fc:\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n for item in (fc.path, fd):\n c = man.make_cursor(item)\n assert c.path_or_fd() is item\n assert c.use_region(10, 10).is_valid()\n assert c.ofs_begin() == 10\n assert c.size() == 10\n with open(fc.path, 'rb') as fp:\n assert c.buffer()[:] == fp.read(20)[10:]\n\n if isinstance(item, int):\n self.assertRaises(ValueError, c.path)\n else:\n self.assertRaises(ValueError, c.fd)\n # END handle value error\n # END for each input\n finally:\n os.close(fd)\n # END for each manasger type\n\n def test_memman_operation(self):\n # test more access, force it to actually unmap regions\n with FileCreator(self.k_window_test_size, \"manager_operation_test\") as fc:\n with open(fc.path, 'rb') as fp:\n data = fp.read()\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n max_num_handles = 15\n # small_size =\n for mtype, args in ((StaticWindowMapManager, (0, fc.size // 3, max_num_handles)),\n (SlidingWindowMapManager, (fc.size // 100, fc.size // 3, max_num_handles)),):\n for item in (fc.path, fd):\n assert len(data) == fc.size\n\n # small windows, a reasonable max memory. Not too many regions at once\n man = mtype(window_size=args[0], max_memory_size=args[1], max_open_handles=args[2])\n c = man.make_cursor(item)\n\n # still empty (more about that is tested in test_memory_manager()\n assert man.num_open_files() == 0\n assert man.mapped_memory_size() == 0\n\n base_offset = 5000\n # window size is 0 for static managers, hence size will be 0. We take that into consideration\n size = man.window_size() // 2\n assert c.use_region(base_offset, size).is_valid()\n rr = c.region()\n assert rr.client_count() == 2 # the manager and the cursor and us\n\n assert man.num_open_files() == 1\n assert man.num_file_handles() == 1\n assert man.mapped_memory_size() == rr.size()\n\n # assert c.size() == size # the cursor may overallocate in its static version\n assert c.ofs_begin() == base_offset\n assert rr.ofs_begin() == 0 # it was aligned and expanded\n if man.window_size():\n # but isn't larger than the max window (aligned)\n assert rr.size() == align_to_mmap(man.window_size(), True)\n else:\n assert rr.size() == fc.size\n # END ignore static managers which dont use windows and are aligned to file boundaries\n\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\n\n # obtain second window, which spans the first part of the file - it is a still the same window\n nsize = (size or fc.size) - 10\n assert c.use_region(0, nsize).is_valid()\n assert c.region() == rr\n assert man.num_file_handles() == 1\n assert c.size() == nsize\n assert c.ofs_begin() == 0\n assert c.buffer()[:] == data[:nsize]\n\n # map some part at the end, our requested size cannot be kept\n overshoot = 4000\n base_offset = fc.size - (size or c.size()) + overshoot\n assert c.use_region(base_offset, size).is_valid()\n if man.window_size():\n assert man.num_file_handles() == 2\n assert c.size() < size\n assert c.region() is not rr # old region is still available, but has not cursor ref anymore\n assert rr.client_count() == 1 # only held by manager\n else:\n assert c.size() < fc.size\n # END ignore static managers which only have one handle per file\n rr = c.region()\n assert rr.client_count() == 2 # manager + cursor\n assert rr.ofs_begin() < c.ofs_begin() # it should have extended itself to the left\n assert rr.ofs_end() <= fc.size # it cannot be larger than the file\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\n\n # unising a region makes the cursor invalid\n c.unuse_region()\n assert not c.is_valid()\n if man.window_size():\n # but doesn't change anything regarding the handle count - we cache it and only\n # remove mapped regions if we have to\n assert man.num_file_handles() == 2\n # END ignore this for static managers\n\n # iterate through the windows, verify data contents\n # this will trigger map collection after a while\n max_random_accesses = 5000\n num_random_accesses = max_random_accesses\n memory_read = 0\n st = time()\n\n # cache everything to get some more performance\n includes_ofs = c.includes_ofs\n max_mapped_memory_size = man.max_mapped_memory_size()\n max_file_handles = man.max_file_handles()\n mapped_memory_size = man.mapped_memory_size\n num_file_handles = man.num_file_handles\n while num_random_accesses:\n num_random_accesses -= 1\n base_offset = randint(0, fc.size - 1)\n\n # precondition\n if man.window_size():\n assert max_mapped_memory_size >= mapped_memory_size()\n # END statistics will overshoot, which is fine\n assert max_file_handles >= num_file_handles()\n assert c.use_region(base_offset, (size or c.size())).is_valid()\n csize = c.size()\n assert c.buffer()[:] == data[base_offset:base_offset + csize]\n memory_read += csize\n\n assert includes_ofs(base_offset)\n assert includes_ofs(base_offset + csize - 1)\n assert not includes_ofs(base_offset + csize)\n # END while we should do an access\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\n mb = float(1000 * 1000)\n print(\"%s: Read %i mb of memory with %i random on cursor initialized with %s accesses in %fs (%f mb/s)\\n\"\n % (mtype, memory_read / mb, max_random_accesses, type(item), elapsed, (memory_read / mb) / elapsed),\n file=sys.stderr)\n\n # an offset as large as the size doesn't work !\n assert not c.use_region(fc.size, size).is_valid()\n\n # collection - it should be able to collect all\n assert man.num_file_handles()\n assert man.collect()\n assert man.num_file_handles() == 0\n # END for each item\n # END for each manager type\n finally:\n os.close(fd)\n\n[end of smmap/test/test_mman.py]","filename":"smmap/test/test_mman.py","id":"16"},{"content":"\"\"\"Provide base classes for the test system\"\"\"\nfrom unittest import TestCase\nimport os\nimport tempfile\n\n__all__ = ['TestBase', 'FileCreator']\n\n\n#{ Utilities\n\nclass FileCreator:\n\n \"\"\"A instance which creates a temporary file with a prefix and a given size\n and provides this info to the user.\n Once it gets deleted, it will remove the temporary file as well.\"\"\"\n __slots__ = (\"_size\", \"_path\")\n\n def __init__(self, size, prefix=''):\n assert size, \"Require size to be larger 0\"\n\n self._size = size\n\n with tempfile.NamedTemporaryFile(\"wb\", prefix=prefix, delete=False) as file:\n self._path = file.name\n file.seek(size - 1)\n file.write(b'1')\n\n assert os.path.getsize(self.path) == size\n\n def __del__(self):\n try:\n os.remove(self.path)\n except OSError:\n pass\n # END exception handling\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self.__del__()\n\n @property\n def path(self):\n return self._path\n\n @property\n def size(self):\n return self._size\n\n#} END utilities\n\n\nclass TestBase(TestCase):\n\n \"\"\"Foundation used by all tests\"\"\"\n\n #{ Configuration\n k_window_test_size = 1000 * 1000 * 8 + 5195\n #} END configuration\n\n #{ Overrides\n @classmethod\n def setUpAll(cls):\n # nothing for now\n pass\n\n # END overrides\n\n #{ Interface\n\n #} END interface\n\n[end of smmap/test/lib.py]","filename":"smmap/test/lib.py","id":"17"},{"content":"[end of smmap/test/__init__.py]","filename":"smmap/test/__init__.py","id":"18"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.mman import (\n SlidingWindowMapManager,\n StaticWindowMapManager\n)\nfrom smmap.buf import SlidingWindowMapBuffer\n\nfrom random import randint\nfrom time import time\nimport sys\nimport os\n\n\nman_optimal = SlidingWindowMapManager()\nman_worst_case = SlidingWindowMapManager(\n window_size=TestBase.k_window_test_size // 100,\n max_memory_size=TestBase.k_window_test_size // 3,\n max_open_handles=15)\nstatic_man = StaticWindowMapManager()\n\n\nclass TestBuf(TestBase):\n\n def test_basics(self):\n with FileCreator(self.k_window_test_size, \"buffer_test\") as fc:\n\n # invalid paths fail upon construction\n c = man_optimal.make_cursor(fc.path)\n self.assertRaises(ValueError, SlidingWindowMapBuffer, type(c)()) # invalid cursor\n self.assertRaises(ValueError, SlidingWindowMapBuffer, c, fc.size) # offset too large\n\n buf = SlidingWindowMapBuffer() # can create uninitialized buffers\n assert buf.cursor() is None\n\n # can call end access any time\n buf.end_access()\n buf.end_access()\n assert len(buf) == 0\n\n # begin access can revive it, if the offset is suitable\n offset = 100\n assert buf.begin_access(c, fc.size) == False\n assert buf.begin_access(c, offset) == True\n assert len(buf) == fc.size - offset\n assert buf.cursor().is_valid()\n\n # empty begin access keeps it valid on the same path, but alters the offset\n assert buf.begin_access() == True\n assert len(buf) == fc.size\n assert buf.cursor().is_valid()\n\n # simple access\n with open(fc.path, 'rb') as fp:\n data = fp.read()\n assert data[offset] == buf[0]\n assert data[offset:offset * 2] == buf[0:offset]\n\n # negative indices, partial slices\n assert buf[-1] == buf[len(buf) - 1]\n assert buf[-10:] == buf[len(buf) - 10:len(buf)]\n\n # end access makes its cursor invalid\n buf.end_access()\n assert not buf.cursor().is_valid()\n assert buf.cursor().is_associated() # but it remains associated\n\n # an empty begin access fixes it up again\n assert buf.begin_access() == True and buf.cursor().is_valid()\n del(buf) # ends access automatically\n del(c)\n\n assert man_optimal.num_file_handles() == 1\n\n # PERFORMANCE\n # blast away with random access and a full mapping - we don't want to\n # exaggerate the manager's overhead, but measure the buffer overhead\n # We do it once with an optimal setting, and with a worse manager which\n # will produce small mappings only !\n max_num_accesses = 100\n fd = os.open(fc.path, os.O_RDONLY)\n for item in (fc.path, fd):\n for manager, man_id in ((man_optimal, 'optimal'),\n (man_worst_case, 'worst case'),\n (static_man, 'static optimal')):\n buf = SlidingWindowMapBuffer(manager.make_cursor(item))\n assert manager.num_file_handles() == 1\n for access_mode in range(2): # single, multi\n num_accesses_left = max_num_accesses\n num_bytes = 0\n fsize = fc.size\n\n st = time()\n buf.begin_access()\n while num_accesses_left:\n num_accesses_left -= 1\n if access_mode: # multi\n ofs_start = randint(0, fsize)\n ofs_end = randint(ofs_start, fsize)\n d = buf[ofs_start:ofs_end]\n assert len(d) == ofs_end - ofs_start\n assert d == data[ofs_start:ofs_end]\n num_bytes += len(d)\n del d\n else:\n pos = randint(0, fsize)\n assert buf[pos] == data[pos]\n num_bytes += 1\n # END handle mode\n # END handle num accesses\n\n buf.end_access()\n assert manager.num_file_handles()\n assert manager.collect()\n assert manager.num_file_handles() == 0\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\n mb = float(1000 * 1000)\n mode_str = (access_mode and \"slice\") or \"single byte\"\n print(\"%s: Made %i random %s accesses to buffer created from %s reading a total of %f mb in %f s (%f mb/s)\"\n % (man_id, max_num_accesses, mode_str, type(item), num_bytes / mb, elapsed, (num_bytes / mb) / elapsed),\n file=sys.stderr)\n # END handle access mode\n del buf\n # END for each manager\n # END for each input\n os.close(fd)\n\n[end of smmap/test/test_buf.py]","filename":"smmap/test/test_buf.py","id":"19"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.util import (\n MapWindow,\n MapRegion,\n MapRegionList,\n ALLOCATIONGRANULARITY,\n is_64_bit,\n align_to_mmap\n)\n\nimport os\nimport sys\n\n\nclass TestMMan(TestBase):\n\n def test_window(self):\n wl = MapWindow(0, 1) # left\n wc = MapWindow(1, 1) # center\n wc2 = MapWindow(10, 5) # another center\n wr = MapWindow(8000, 50) # right\n\n assert wl.ofs_end() == 1\n assert wc.ofs_end() == 2\n assert wr.ofs_end() == 8050\n\n # extension does nothing if already in place\n maxsize = 100\n wc.extend_left_to(wl, maxsize)\n assert wc.ofs == 1 and wc.size == 1\n wl.extend_right_to(wc, maxsize)\n wl.extend_right_to(wc, maxsize)\n assert wl.ofs == 0 and wl.size == 1\n\n # an actual left extension\n pofs_end = wc2.ofs_end()\n wc2.extend_left_to(wc, maxsize)\n assert wc2.ofs == wc.ofs_end() and pofs_end == wc2.ofs_end()\n\n # respects maxsize\n wc.extend_right_to(wr, maxsize)\n assert wc.ofs == 1 and wc.size == maxsize\n wc.extend_right_to(wr, maxsize)\n assert wc.ofs == 1 and wc.size == maxsize\n\n # without maxsize\n wc.extend_right_to(wr, sys.maxsize)\n assert wc.ofs_end() == wr.ofs and wc.ofs == 1\n\n # extend left\n wr.extend_left_to(wc2, maxsize)\n wr.extend_left_to(wc2, maxsize)\n assert wr.size == maxsize\n\n wr.extend_left_to(wc2, sys.maxsize)\n assert wr.ofs == wc2.ofs_end()\n\n wc.align()\n assert wc.ofs == 0 and wc.size == align_to_mmap(wc.size, True)\n\n def test_region(self):\n with FileCreator(self.k_window_test_size, \"window_test\") as fc:\n half_size = fc.size // 2\n rofs = align_to_mmap(4200, False)\n rfull = MapRegion(fc.path, 0, fc.size)\n rhalfofs = MapRegion(fc.path, rofs, fc.size)\n rhalfsize = MapRegion(fc.path, 0, half_size)\n\n # offsets\n assert rfull.ofs_begin() == 0 and rfull.size() == fc.size\n assert rfull.ofs_end() == fc.size # if this method works, it works always\n\n assert rhalfofs.ofs_begin() == rofs and rhalfofs.size() == fc.size - rofs\n assert rhalfsize.ofs_begin() == 0 and rhalfsize.size() == half_size\n\n assert rfull.includes_ofs(0) and rfull.includes_ofs(fc.size - 1) and rfull.includes_ofs(half_size)\n assert not rfull.includes_ofs(-1) and not rfull.includes_ofs(sys.maxsize)\n\n # auto-refcount\n assert rfull.client_count() == 1\n rfull2 = rfull\n assert rfull.client_count() == 1, \"no auto-counting\"\n\n # window constructor\n w = MapWindow.from_region(rfull)\n assert w.ofs == rfull.ofs_begin() and w.ofs_end() == rfull.ofs_end()\n\n def test_region_list(self):\n with FileCreator(100, \"sample_file\") as fc:\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n for item in (fc.path, fd):\n ml = MapRegionList(item)\n\n assert len(ml) == 0\n assert ml.path_or_fd() == item\n assert ml.file_size() == fc.size\n finally:\n os.close(fd)\n\n def test_util(self):\n assert isinstance(is_64_bit(), bool) # just call it\n assert align_to_mmap(1, False) == 0\n assert align_to_mmap(1, True) == ALLOCATIONGRANULARITY\n\n[end of smmap/test/test_util.py]","filename":"smmap/test/test_util.py","id":"20"},{"content":"from .lib import TestBase\n\n\nclass TestTutorial(TestBase):\n\n def test_example(self):\n # Memory Managers\n ##################\n import smmap\n # This instance should be globally available in your application\n # It is configured to be well suitable for 32-bit or 64 bit applications.\n mman = smmap.SlidingWindowMapManager()\n\n # the manager provides much useful information about its current state\n # like the amount of open file handles or the amount of mapped memory\n assert mman.num_file_handles() == 0\n assert mman.mapped_memory_size() == 0\n # and many more ...\n\n # Cursors\n ##########\n import smmap.test.lib\n with smmap.test.lib.FileCreator(1024 * 1024 * 8, \"test_file\") as fc:\n # obtain a cursor to access some file.\n c = mman.make_cursor(fc.path)\n\n # the cursor is now associated with the file, but not yet usable\n assert c.is_associated()\n assert not c.is_valid()\n\n # before you can use the cursor, you have to specify a window you want to\n # access. The following just says you want as much data as possible starting\n # from offset 0.\n # To be sure your region could be mapped, query for validity\n assert c.use_region().is_valid() # use_region returns self\n\n # once a region was mapped, you must query its dimension regularly\n # to assure you don't try to access its buffer out of its bounds\n assert c.size()\n c.buffer()[0] # first byte\n c.buffer()[1:10] # first 9 bytes\n c.buffer()[c.size() - 1] # last byte\n\n # you can query absolute offsets, and check whether an offset is included\n # in the cursor's data.\n assert c.ofs_begin() < c.ofs_end()\n assert c.includes_ofs(100)\n\n # If you are over out of bounds with one of your region requests, the\n # cursor will be come invalid. It cannot be used in that state\n assert not c.use_region(fc.size, 100).is_valid()\n # map as much as possible after skipping the first 100 bytes\n assert c.use_region(100).is_valid()\n\n # You can explicitly free cursor resources by unusing the cursor's region\n c.unuse_region()\n assert not c.is_valid()\n\n # Buffers\n #########\n # Create a default buffer which can operate on the whole file\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\n\n # you can use it right away\n assert buf.cursor().is_valid()\n\n buf[0] # access the first byte\n buf[-1] # access the last ten bytes on the file\n buf[-10:] # access the last ten bytes\n\n # If you want to keep the instance between different accesses, use the\n # dedicated methods\n buf.end_access()\n assert not buf.cursor().is_valid() # you cannot use the buffer anymore\n assert buf.begin_access(offset=10) # start using the buffer at an offset\n\n[end of smmap/test/test_tutorial.py]","filename":"smmap/test/test_tutorial.py","id":"21"},{"content":".. smmap documentation master file, created by\n sphinx-quickstart on Wed Jun 8 15:14:25 2011.\n You can adapt this file completely to your liking, but it should at least\n contain the root `toctree` directive.\n\nWelcome to smmap's documentation!\n=================================\n**smmap** is a pure python implementation of a sliding memory map to help unifying memory mapped access on 32 and 64 bit systems and to help managing resources more efficiently.\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n \n intro\n tutorial\n api\n changes\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of doc/source/index.rst]","filename":"doc/source/index.rst","id":"22"},{"content":"###########\nMotivation\n###########\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\n\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\n\n########\nOverview\n########\n\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\n\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\n\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\n\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\n\n#############\nPrerequisites\n#############\n* Python 3.7+\n* OSX, Windows or Linux\n\nThe package was tested on all of the previously mentioned configurations.\n\n###########\nLimitations\n###########\n* The memory access is read-only by design.\n\n################\nInstalling smmap\n################\nIts easiest to install smmap using the *pip* program::\n \n $ pip install smmap\n \nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\n\nIf you have downloaded the source archive, the package can be installed by running the ``setup.py`` script::\n \n $ python setup.py install\n\nIt is advised to have a look at the :ref:`Usage Guide <tutorial-label>` for a brief introduction on the different database implementations.\n\n##################\nHomepage and Links\n##################\nThe project is home on github at `https://github.com/gitpython-developers/smmap <https://github.com/gitpython-developers/smmap>`_.\n\nThe latest source can be cloned from github as well:\n\n * git://github.com/gitpython-developers/smmap.git\n \n \nFor support, please use the git-python mailing list:\n\n * http://groups.google.com/group/git-python\n \n\nIssues can be filed on github:\n\n * https://github.com/gitpython-developers/smmap/issues\n \n###################\nLicense Information\n###################\n*smmap* is licensed under the New BSD License.\n\n.. _pip: http://www.pip-installer.org/en/latest/\n\n[end of doc/source/intro.rst]","filename":"doc/source/intro.rst","id":"23"},{"content":"#\n# smmap documentation build configuration file, created by\n# sphinx-quickstart on Wed Jun 8 15:14:25 2011.\n#\n# This file is execfile()d with the current directory set to its containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.append(os.path.abspath('../../'))\n\n# -- General configuration -----------------------------------------------------\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['.templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'smmap'\ncopyright = '2011, Sebastian Thiel'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.8.0'\n# The full version, including alpha/beta/rc tags.\nrelease = '0.8.0'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of documents that shouldn't be included in the build.\n#unused_docs = []\n\n# List of directories, relative to source directory, that shouldn't be searched\n# for source files.\nexclude_trees = []\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. Major themes that come with\n# Sphinx are currently 'default' and 'sphinxdoc'.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['.static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_use_modindex = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# If nonempty, this is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = ''\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'smmapdoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\n# The paper size ('letter' or 'a4').\n#latex_paper_size = 'letter'\n\n# The font size ('10pt', '11pt' or '12pt').\n#latex_font_size = '10pt'\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'smmap.tex', 'smmap Documentation',\n 'Sebastian Thiel', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# Additional stuff for the LaTeX preamble.\n#latex_preamble = ''\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_use_modindex = True\n\n[end of doc/source/conf.py]","filename":"doc/source/conf.py","id":"24"},{"content":".. _tutorial-label:\n\n###########\nUsage Guide\n###########\nThis text briefly introduces you to the basic design decisions and accompanying classes.\n\n******\nDesign\n******\nPer application, there is *MemoryManager* which is held as static instance and used throughout the application. It can be configured to keep your resources within certain limits.\n\nTo access mapped regions, you require a cursor. Cursors point to exactly one file and serve as handles into it. As long as it exists, the respective memory region will remain available.\n\nFor convenience, a buffer implementation is provided which handles cursors and resource allocation behind its simple buffer like interface.\n\n***************\nMemory Managers\n***************\nThere are two types of memory managers, one uses *static* windows, the other one uses *sliding* windows. A window is a region of a file mapped into memory. Although the names might be somewhat misleading as technically windows are always static, the *sliding* version will allocate relatively small windows whereas the *static* version will always map the whole file.\n\nThe *static* manager does nothing more than keeping a client count on the respective memory maps which always map the whole file, which allows to make some assumptions that can lead to simplified data access and increased performance, but reduces the compatibility to 32 bit systems or giant files.\n\nThe *sliding* memory manager therefore should be the default manager when preparing an application for handling huge amounts of data on 32 bit and 64 bit platforms::\n\n import smmap\n # This instance should be globally available in your application\n # It is configured to be well suitable for 32-bit or 64 bit applications.\n mman = smmap.SlidingWindowMapManager()\n \n # the manager provides much useful information about its current state\n # like the amount of open file handles or the amount of mapped memory\n mman.num_file_handles()\n mman.mapped_memory_size()\n # and many more ...\n\n\nCursors\n*******\n*Cursors* are handles that point onto a window, i.e. a region of a file mapped into memory. From them you may obtain a buffer through which the data of that window can actually be accessed::\n\n import smmap.test.lib\n fc = smmap.test.lib.FileCreator(1024*1024*8, \"test_file\")\n \n # obtain a cursor to access some file.\n c = mman.make_cursor(fc.path)\n \n # the cursor is now associated with the file, but not yet usable\n assert c.is_associated()\n assert not c.is_valid()\n \n # before you can use the cursor, you have to specify a window you want to \n # access. The following just says you want as much data as possible starting\n # from offset 0.\n # To be sure your region could be mapped, query for validity\n assert c.use_region().is_valid()\t\t# use_region returns self\n \n # once a region was mapped, you must query its dimension regularly\n # to assure you don't try to access its buffer out of its bounds\n assert c.size()\n c.buffer()[0]\t\t\t# first byte\n c.buffer()[1:10]\t\t\t# first 9 bytes\n c.buffer()[c.size()-1] \t# last byte\n \n # its recommended not to create big slices when feeding the buffer\n # into consumers (e.g. struct or zlib). \n # Instead, either give the buffer directly, or use pythons buffer command.\n buffer(c.buffer(), 1, 9)\t# first 9 bytes without copying them\n \n # you can query absolute offsets, and check whether an offset is included\n # in the cursor's data.\n assert c.ofs_begin() < c.ofs_end()\n assert c.includes_ofs(100)\n \n # If you are over out of bounds with one of your region requests, the \n # cursor will be come invalid. It cannot be used in that state\n assert not c.use_region(fc.size, 100).is_valid()\n # map as much as possible after skipping the first 100 bytes\n assert c.use_region(100).is_valid()\n \n # You can explicitly free cursor resources by unusing the cursor's region\n c.unuse_region()\n assert not c.is_valid()\n \n\nNow you would have to write your algorithms around this interface to properly slide through huge amounts of data. \n \nAlternatively you can use a convenience interface.\n\n*******\nBuffers\n*******\nTo make first use easier, at the expense of performance, there is a Buffer implementation which uses a cursor underneath.\n\nWith it, you can access all data in a possibly huge file without having to take care of setting the cursor to different regions yourself::\n\n # Create a default buffer which can operate on the whole file\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\n \n # you can use it right away\n assert buf.cursor().is_valid()\n \n buf[0]\t# access the first byte\n buf[-1]\t# access the last ten bytes on the file\n buf[-10:]# access the last ten bytes\n \n # If you want to keep the instance between different accesses, use the\n # dedicated methods\n buf.end_access()\n assert not buf.cursor().is_valid()\t# you cannot use the buffer anymore\n assert buf.begin_access(offset=10)\t# start using the buffer at an offset\n \n # it will stop using resources automatically once it goes out of scope\n \nDisadvantages\n*************\nBuffers cannot be used in place of strings or maps, hence you have to slice them to have valid input for the sorts of struct and zlib. A slice means a lot of data handling overhead which makes buffers slower compared to using cursors directly. \n\n\n[end of doc/source/tutorial.rst]","filename":"doc/source/tutorial.rst","id":"25"},{"content":"#########\nChangelog\n#########\n\n******\nv5.0.2\n******\n\n- remove a usage of mktemp\n\n******\nv5.0.1\n******\n\n- Added support for Python 3.12\n\n******\nv6.0.0\n******\n\nYANKED\n\n- Dropped support 3.6 and 3.7\n- Declared support for Python 3.11 and 3.12\n\n******\nv5.0.0\n******\n\n- Dropped support 3.5\n- Added support for Python 3.10\n\n******\nv4.0.0\n******\n\n- Dropped support for Python 2.7 and 3.4\n- Added support for Python 3.7, 3.8, and 3.9\n- Removed unused exc.MemoryManagerError and exc.RegionCollectionError\n\n******\nv3.0.5\n******\n\n- Restored Python 2 support removed in v3.0.2\n- Changed release signature key to 27C50E7F590947D7273A741E85194C08421980C9.\n See https://keybase.io/byronbates for proof of ownership.\n\n******\nv3.0.4\n******\n\n- Signed release (with correct key this time)\n\n******\nv3.0.2\n******\n\n- Signed release\n- Switched to GitHub Actions for CI\n\n******\nv3.0.1\n******\n- Switched back to the smmap package name on PyPI and fixed the smmap2 mirror package\n (`#44 <https://github.com/gitpython-developers/smmap/issues/44>`_)\n- Fixed setup.py ``long_description`` rendering\n (`#40 <https://github.com/gitpython-developers/smmap/pull/40>`_)\n\n**********\nv0.9.0\n**********\n- Fixed issue with resources never being freed as mmaps were never closed.\n- Client counting is now done manually, instead of relying on pyton's reference count\n\n**********\nv0.8.5\n**********\n- Fixed Python 3.0-3.3 regression, which also causes smmap to become about 3 times slower depending on the code path. It's related to this bug (http://bugs.python.org/issue15958), which was fixed in python 3.4\n\n**********\nv0.8.4\n**********\n- Fixed Python 3 performance regression\n\n**********\nv0.8.3\n**********\n- Cleaned up code and assured it works sufficiently well with python 3\n\n**********\nv0.8.1\n**********\n- A single bugfix\n\n**********\nv0.8.0 \n**********\n\n- Initial Release\n\n[end of doc/source/changes.rst]","filename":"doc/source/changes.rst","id":"26"},{"content":".. _api-label:\n\n#############\nAPI Reference\n#############\n\n***********************\nMapped Memory Managers\n***********************\n\n.. automodule:: smmap.mman\n :members:\n :undoc-members:\n\n*******\nBuffers\n*******\n\n.. automodule:: smmap.buf\n :members:\n :undoc-members:\n\n*********\nUtilities\n*********\n\n.. automodule:: smmap.util\n :members:\n :undoc-members:\n\n\n\n\n\n\n[end of doc/source/api.rst]","filename":"doc/source/api.rst","id":"27"}],"string":"[\n {\n \"content\": \"Copyright (C) 2010, 2011 Sebastian Thiel and contributors\\nAll rights reserved.\\n\\nRedistribution and use in source and binary forms, with or without \\nmodification, are permitted provided that the following conditions \\nare met:\\n\\n* Redistributions of source code must retain the above copyright \\nnotice, this list of conditions and the following disclaimer.\\n\\n* Redistributions in binary form must reproduce the above copyright \\nnotice, this list of conditions and the following disclaimer in the \\ndocumentation and/or other materials provided with the distribution.\\n\\n* Neither the name of the async project nor the names of \\nits contributors may be used to endorse or promote products derived \\nfrom this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED \\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR \\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING \\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \".PHONY: all clean release force_release\\n\\nall:\\n\\t@grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all\\n\\nclean:\\n\\trm -rf build/ dist/ .eggs/ .tox/\\n\\nforce_release: clean\\n\\t./build-release.sh\\n\\ttwine upload dist/*\\n\\tgit push --tags origin master\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"1\"\n },\n {\n \"content\": \"# Include the license file\\ninclude LICENSE\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[run]\\nsource = smmap\\n\\n; to make nosetests happy\\n[report]\\nomit = \\n\\t*/yaml*\\n\\t*/tests/*\\n */python?.?/*\\n */site-packages/nose/*\\n[end of .coveragerc]\",\n \"filename\": \".coveragerc\",\n \"id\": \"3\"\n },\n {\n \"content\": \"## Motivation\\n\\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\\n\\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\\n\\n\\n## Limitations\\n\\n* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.\\n* The memory access is read-only by design.\\n\\n\\n## Overview\\n\\n\\n\\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\\n\\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\\n\\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\\n\\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\\n\\n\\n\\n## Prerequisites\\n\\n* Python 3.7+\\n* OSX, Windows or Linux\\n\\nThe package was tested on all of the previously mentioned configurations.\\n\\n## Installing smmap\\n\\n[](https://readthedocs.org/projects/smmap/?badge=latest)\\n\\nIts easiest to install smmap using the [pip](http://www.pip-installer.org/en/latest) program:\\n\\n```bash\\n$ pip install smmap\\n```\\n\\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\\n\\nIf you have downloaded the source archive, the package can be installed by running the `setup.py` script:\\n\\n```bash\\n$ python setup.py install\\n```\\n\\nIt is advised to have a look at the **Usage Guide** for a brief introduction on the different database implementations.\\n\\n\\n\\n## Homepage and Links\\n\\nThe project is home on github at https://github.com/gitpython-developers/smmap .\\n\\nThe latest source can be cloned from github as well:\\n\\n* git://github.com/gitpython-developers/smmap.git\\n\\n\\nFor support, please use the git-python mailing list:\\n\\n* http://groups.google.com/group/git-python\\n\\n\\nIssues can be filed on github:\\n\\n* https://github.com/gitpython-developers/smmap/issues\\n\\nA link to the pypi page related to this repository:\\n\\n* https://pypi.org/project/smmap/\\n\\n\\n## License Information\\n\\n*smmap* is licensed under the New BSD License.\\n\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"#!/usr/bin/env python\\nimport os\\n\\ntry:\\n from setuptools import setup, find_packages\\nexcept ImportError:\\n from ez_setup import use_setuptools\\n use_setuptools()\\n from setuptools import setup, find_packages\\n\\nimport smmap\\n\\nif os.path.exists(\\\"README.md\\\"):\\n long_description = open('README.md', encoding=\\\"utf-8\\\").read().replace('\\\\r\\\\n', '\\\\n')\\nelse:\\n long_description = \\\"See https://github.com/gitpython-developers/smmap\\\"\\n\\nsetup(\\n name=\\\"smmap\\\",\\n version=smmap.__version__,\\n description=\\\"A pure Python implementation of a sliding window memory map manager\\\",\\n author=smmap.__author__,\\n author_email=smmap.__contact__,\\n url=smmap.__homepage__,\\n platforms=[\\\"any\\\"],\\n license=\\\"BSD-3-Clause\\\",\\n packages=find_packages(),\\n zip_safe=True,\\n python_requires=\\\">=3.7\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: Microsoft :: Windows\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.7\\\",\\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 \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: 3 :: Only\\\",\\n ],\\n long_description=long_description,\\n long_description_content_type='text/markdown',\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# Tox (http://tox.testrun.org/) is a tool for running tests\\n# in multiple virtualenvs. This configuration file will run the\\n# test suite on all supported python versions. To use it, \\\"pip install tox\\\"\\n# and then run \\\"tox\\\" from this directory.\\n\\n[tox]\\nenvlist = flake8, py{37, 38, 39, 310, 311, 312}\\n\\n[testenv]\\ncommands = {envpython} -m pytest --cov smmap --cov-report xml {posargs}\\ndeps =\\n pytest\\n pytest-cov\\n\\n[testenv:flake8]\\ncommands = flake8 {posargs}\\ndeps = flake8\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"6\"\n },\n {\n \"content\": \"[flake8]\\nexclude = .tox,.venv,build,dist,doc\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"7\"\n },\n {\n \"content\": \"#!/bin/bash\\n#\\n# This script builds a release. If run in a venv, it auto-installs its tools.\\n# You may want to run \\\"make release\\\" instead of running this script directly.\\n\\nset -eEu\\n\\nfunction release_with() {\\n $1 -m build --sdist --wheel\\n}\\n\\nif test -n \\\"${VIRTUAL_ENV:-}\\\"; then\\n deps=(build twine) # Install twine along with build, as we need it later.\\n echo \\\"Virtual environment detected. Adding packages: ${deps[*]}\\\"\\n pip install --quiet --upgrade \\\"${deps[@]}\\\"\\n echo 'Starting the build.'\\n release_with python\\nelse\\n function suggest_venv() {\\n venv_cmd='python -m venv env && source env/bin/activate'\\n printf \\\"HELP: To avoid this error, use a virtual-env with '%s' instead.\\\\n\\\" \\\"$venv_cmd\\\"\\n }\\n trap suggest_venv ERR # This keeps the original exit (error) code.\\n echo 'Starting the build.'\\n release_with python3 # Outside a venv, use python3.\\nfi\\n\\n[end of build-release.sh]\",\n \"filename\": \"build-release.sh\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# Security Policy\\n\\nSee [GitPython](https://github.com/gitpython-developers/GitPython/blob/main/SECURITY.md). Vulnerabilities found in `smmap` can be reported there.\\n\\n[end of SECURITY.md]\",\n \"filename\": \"SECURITY.md\",\n \"id\": \"9\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\\\"\\\"\\\"\\nfrom .util import (\\n MapWindow,\\n MapRegion,\\n MapRegionList,\\n is_64_bit,\\n)\\n\\nimport sys\\nfrom functools import reduce\\n\\n__all__ = [\\\"StaticWindowMapManager\\\", \\\"SlidingWindowMapManager\\\", \\\"WindowCursor\\\"]\\n#{ Utilities\\n\\n#}END utilities\\n\\n\\nclass WindowCursor:\\n\\n \\\"\\\"\\\"\\n Pointer into the mapped region of the memory manager, keeping the map\\n alive until it is destroyed and no other client uses it.\\n\\n Cursors should not be created manually, but are instead returned by the SlidingWindowMapManager\\n\\n **Note:**: The current implementation is suited for static and sliding window managers, but it also means\\n that it must be suited for the somewhat quite different sliding manager. It could be improved, but\\n I see no real need to do so.\\\"\\\"\\\"\\n __slots__ = (\\n '_manager', # the manager keeping all file regions\\n '_rlist', # a regions list with regions for our file\\n '_region', # our current class:`MapRegion` or None\\n '_ofs', # relative offset from the actually mapped area to our start area\\n '_size' # maximum size we should provide\\n )\\n\\n def __init__(self, manager=None, regions=None):\\n self._manager = manager\\n self._rlist = regions\\n self._region = None\\n self._ofs = 0\\n self._size = 0\\n\\n def __del__(self):\\n self._destroy()\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self._destroy()\\n\\n def _destroy(self):\\n \\\"\\\"\\\"Destruction code to decrement counters\\\"\\\"\\\"\\n self.unuse_region()\\n\\n if self._rlist is not None:\\n # Actual client count, which doesn't include the reference kept by the manager, nor ours\\n # as we are about to be deleted\\n try:\\n if len(self._rlist) == 0:\\n # Free all resources associated with the mapped file\\n self._manager._fdict.pop(self._rlist.path_or_fd())\\n # END remove regions list from manager\\n except (TypeError, KeyError):\\n # sometimes, during shutdown, getrefcount is None. Its possible\\n # to re-import it, however, its probably better to just ignore\\n # this python problem (for now).\\n # The next step is to get rid of the error prone getrefcount altogether.\\n pass\\n # END exception handling\\n # END handle regions\\n\\n def _copy_from(self, rhs):\\n \\\"\\\"\\\"Copy all data from rhs into this instance, handles usage count\\\"\\\"\\\"\\n self._manager = rhs._manager\\n self._rlist = type(rhs._rlist)(rhs._rlist)\\n self._region = rhs._region\\n self._ofs = rhs._ofs\\n self._size = rhs._size\\n\\n for region in self._rlist:\\n region.increment_client_count()\\n\\n if self._region is not None:\\n self._region.increment_client_count()\\n # END handle regions\\n\\n def __copy__(self):\\n \\\"\\\"\\\"copy module interface\\\"\\\"\\\"\\n cpy = type(self)()\\n cpy._copy_from(self)\\n return cpy\\n\\n #{ Interface\\n def assign(self, rhs):\\n \\\"\\\"\\\"Assign rhs to this instance. This is required in order to get a real copy.\\n Alternatively, you can copy an existing instance using the copy module\\\"\\\"\\\"\\n self._destroy()\\n self._copy_from(rhs)\\n\\n def use_region(self, offset=0, size=0, flags=0):\\n \\\"\\\"\\\"Assure we point to a window which allows access to the given offset into the file\\n\\n :param offset: absolute offset in bytes into the file\\n :param size: amount of bytes to map. If 0, all available bytes will be mapped\\n :param flags: additional flags to be given to os.open in case a file handle is initially opened\\n for mapping. Has no effect if a region can actually be reused.\\n :return: this instance - it should be queried for whether it points to a valid memory region.\\n This is not the case if the mapping failed because we reached the end of the file\\n\\n **Note:**: The size actually mapped may be smaller than the given size. If that is the case,\\n either the file has reached its end, or the map was created between two existing regions\\\"\\\"\\\"\\n need_region = True\\n man = self._manager\\n fsize = self._rlist.file_size()\\n size = min(size or fsize, man.window_size() or fsize) # clamp size to window size\\n\\n if self._region is not None:\\n if self._region.includes_ofs(offset):\\n need_region = False\\n else:\\n self.unuse_region()\\n # END handle existing region\\n # END check existing region\\n\\n # offset too large ?\\n if offset >= fsize:\\n return self\\n # END handle offset\\n\\n if need_region:\\n self._region = man._obtain_region(self._rlist, offset, size, flags, False)\\n self._region.increment_client_count()\\n # END need region handling\\n\\n self._ofs = offset - self._region._b\\n self._size = min(size, self._region.ofs_end() - offset)\\n\\n return self\\n\\n def unuse_region(self):\\n \\\"\\\"\\\"Unuse the current region. Does nothing if we have no current region\\n\\n **Note:** the cursor unuses the region automatically upon destruction. It is recommended\\n to un-use the region once you are done reading from it in persistent cursors as it\\n helps to free up resource more quickly\\\"\\\"\\\"\\n if self._region is not None:\\n self._region.increment_client_count(-1)\\n self._region = None\\n # note: should reset ofs and size, but we spare that for performance. Its not\\n # allowed to query information if we are not valid !\\n\\n def buffer(self):\\n \\\"\\\"\\\"Return a buffer object which allows access to our memory region from our offset\\n to the window size. Please note that it might be smaller than you requested when calling use_region()\\n\\n **Note:** You can only obtain a buffer if this instance is_valid() !\\n\\n **Note:** buffers should not be cached passed the duration of your access as it will\\n prevent resources from being freed even though they might not be accounted for anymore !\\\"\\\"\\\"\\n return memoryview(self._region.buffer())[self._ofs:self._ofs+self._size]\\n\\n def map(self):\\n \\\"\\\"\\\"\\n :return: the underlying raw memory map. Please not that the offset and size is likely to be different\\n to what you set as offset and size. Use it only if you are sure about the region it maps, which is the whole\\n file in case of StaticWindowMapManager\\\"\\\"\\\"\\n return self._region.map()\\n\\n def is_valid(self):\\n \\\"\\\"\\\":return: True if we have a valid and usable region\\\"\\\"\\\"\\n return self._region is not None\\n\\n def is_associated(self):\\n \\\"\\\"\\\":return: True if we are associated with a specific file already\\\"\\\"\\\"\\n return self._rlist is not None\\n\\n def ofs_begin(self):\\n \\\"\\\"\\\":return: offset to the first byte pointed to by our cursor\\n\\n **Note:** only if is_valid() is True\\\"\\\"\\\"\\n return self._region._b + self._ofs\\n\\n def ofs_end(self):\\n \\\"\\\"\\\":return: offset to one past the last available byte\\\"\\\"\\\"\\n # unroll method calls for performance !\\n return self._region._b + self._ofs + self._size\\n\\n def size(self):\\n \\\"\\\"\\\":return: amount of bytes we point to\\\"\\\"\\\"\\n return self._size\\n\\n def region(self):\\n \\\"\\\"\\\":return: our mapped region, or None if nothing is mapped yet\\n :raise AssertionError: if we have no current region. This is only useful for debugging\\\"\\\"\\\"\\n return self._region\\n\\n def includes_ofs(self, ofs):\\n \\\"\\\"\\\":return: True if the given absolute offset is contained in the cursors\\n current region\\n\\n **Note:** cursor must be valid for this to work\\\"\\\"\\\"\\n # unroll methods\\n return (self._region._b + self._ofs) <= ofs < (self._region._b + self._ofs + self._size)\\n\\n def file_size(self):\\n \\\"\\\"\\\":return: size of the underlying file\\\"\\\"\\\"\\n return self._rlist.file_size()\\n\\n def path_or_fd(self):\\n \\\"\\\"\\\":return: path or file descriptor of the underlying mapped file\\\"\\\"\\\"\\n return self._rlist.path_or_fd()\\n\\n def path(self):\\n \\\"\\\"\\\":return: path of the underlying mapped file\\n :raise ValueError: if attached path is not a path\\\"\\\"\\\"\\n if isinstance(self._rlist.path_or_fd(), int):\\n raise ValueError(\\\"Path queried although mapping was applied to a file descriptor\\\")\\n # END handle type\\n return self._rlist.path_or_fd()\\n\\n def fd(self):\\n \\\"\\\"\\\":return: file descriptor used to create the underlying mapping.\\n\\n **Note:** it is not required to be valid anymore\\n :raise ValueError: if the mapping was not created by a file descriptor\\\"\\\"\\\"\\n if isinstance(self._rlist.path_or_fd(), str):\\n raise ValueError(\\\"File descriptor queried although mapping was generated from path\\\")\\n # END handle type\\n return self._rlist.path_or_fd()\\n\\n #} END interface\\n\\n\\nclass StaticWindowMapManager:\\n\\n \\\"\\\"\\\"Provides a manager which will produce single size cursors that are allowed\\n to always map the whole file.\\n\\n Clients must be written to specifically know that they are accessing their data\\n through a StaticWindowMapManager, as they otherwise have to deal with their window size.\\n\\n These clients would have to use a SlidingWindowMapBuffer to hide this fact.\\n\\n This type will always use a maximum window size, and optimize certain methods to\\n accommodate this fact\\\"\\\"\\\"\\n\\n __slots__ = [\\n '_fdict', # mapping of path -> StorageHelper (of some kind\\n '_window_size', # maximum size of a window\\n '_max_memory_size', # maximum amount of memory we may allocate\\n '_max_handle_count', # maximum amount of handles to keep open\\n '_memory_size', # currently allocated memory size\\n '_handle_count', # amount of currently allocated file handles\\n ]\\n\\n #{ Configuration\\n MapRegionListCls = MapRegionList\\n MapWindowCls = MapWindow\\n MapRegionCls = MapRegion\\n WindowCursorCls = WindowCursor\\n #} END configuration\\n\\n _MB_in_bytes = 1024 * 1024\\n\\n def __init__(self, window_size=0, max_memory_size=0, max_open_handles=sys.maxsize):\\n \\\"\\\"\\\"initialize the manager with the given parameters.\\n :param window_size: if -1, a default window size will be chosen depending on\\n the operating system's architecture. It will internally be quantified to a multiple of the page size\\n If 0, the window may have any size, which basically results in mapping the whole file at one\\n :param max_memory_size: maximum amount of memory we may map at once before releasing mapped regions.\\n If 0, a viable default will be set depending on the system's architecture.\\n It is a soft limit that is tried to be kept, but nothing bad happens if we have to over-allocate\\n :param max_open_handles: if not maxint, limit the amount of open file handles to the given number.\\n Otherwise the amount is only limited by the system itself. If a system or soft limit is hit,\\n the manager will free as many handles as possible\\\"\\\"\\\"\\n self._fdict = dict()\\n self._window_size = window_size\\n self._max_memory_size = max_memory_size\\n self._max_handle_count = max_open_handles\\n self._memory_size = 0\\n self._handle_count = 0\\n\\n if window_size < 0:\\n coeff = 64\\n if is_64_bit():\\n coeff = 1024\\n # END handle arch\\n self._window_size = coeff * self._MB_in_bytes\\n # END handle max window size\\n\\n if max_memory_size == 0:\\n coeff = 1024\\n if is_64_bit():\\n coeff = 8192\\n # END handle arch\\n self._max_memory_size = coeff * self._MB_in_bytes\\n # END handle max memory size\\n\\n #{ Internal Methods\\n\\n def _collect_lru_region(self, size):\\n \\\"\\\"\\\"Unmap the region which was least-recently used and has no client\\n :param size: size of the region we want to map next (assuming its not already mapped partially or full\\n if 0, we try to free any available region\\n :return: Amount of freed regions\\n\\n .. Note::\\n We don't raise exceptions anymore, in order to keep the system working, allowing temporary overallocation.\\n If the system runs out of memory, it will tell.\\n\\n .. TODO::\\n implement a case where all unusued regions are discarded efficiently.\\n Currently its only brute force\\n \\\"\\\"\\\"\\n num_found = 0\\n while (size == 0) or (self._memory_size + size > self._max_memory_size):\\n lru_region = None\\n lru_list = None\\n for regions in self._fdict.values():\\n for region in regions:\\n # check client count - if it's 1, it's just us\\n if (region.client_count() == 1 and\\n (lru_region is None or region._uc < lru_region._uc)):\\n lru_region = region\\n lru_list = regions\\n # END update lru_region\\n # END for each region\\n # END for each regions list\\n\\n if lru_region is None:\\n break\\n # END handle region not found\\n\\n num_found += 1\\n del(lru_list[lru_list.index(lru_region)])\\n lru_region.increment_client_count(-1)\\n self._memory_size -= lru_region.size()\\n self._handle_count -= 1\\n # END while there is more memory to free\\n return num_found\\n\\n def _obtain_region(self, a, offset, size, flags, is_recursive):\\n \\\"\\\"\\\"Utility to create a new region - for more information on the parameters,\\n see MapCursor.use_region.\\n :param a: A regions (a)rray\\n :return: The newly created region\\\"\\\"\\\"\\n if self._memory_size + size > self._max_memory_size:\\n self._collect_lru_region(size)\\n # END handle collection\\n\\n r = None\\n if a:\\n assert len(a) == 1\\n r = a[0]\\n else:\\n try:\\n r = self.MapRegionCls(a.path_or_fd(), 0, sys.maxsize, flags)\\n except Exception:\\n # apparently we are out of system resources or hit a limit\\n # As many more operations are likely to fail in that condition (\\n # like reading a file from disk, etc) we free up as much as possible\\n # As this invalidates our insert position, we have to recurse here\\n if is_recursive:\\n # we already tried this, and still have no success in obtaining\\n # a mapping. This is an exception, so we propagate it\\n raise\\n # END handle existing recursion\\n self._collect_lru_region(0)\\n return self._obtain_region(a, offset, size, flags, True)\\n # END handle exceptions\\n\\n self._handle_count += 1\\n self._memory_size += r.size()\\n a.append(r)\\n # END handle array\\n\\n assert r.includes_ofs(offset)\\n return r\\n\\n #}END internal methods\\n\\n #{ Interface\\n def make_cursor(self, path_or_fd):\\n \\\"\\\"\\\"\\n :return: a cursor pointing to the given path or file descriptor.\\n It can be used to map new regions of the file into memory\\n\\n **Note:** if a file descriptor is given, it is assumed to be open and valid,\\n but may be closed afterwards. To refer to the same file, you may reuse\\n your existing file descriptor, but keep in mind that new windows can only\\n be mapped as long as it stays valid. This is why the using actual file paths\\n are preferred unless you plan to keep the file descriptor open.\\n\\n **Note:** file descriptors are problematic as they are not necessarily unique, as two\\n different files opened and closed in succession might have the same file descriptor id.\\n\\n **Note:** Using file descriptors directly is faster once new windows are mapped as it\\n prevents the file to be opened again just for the purpose of mapping it.\\\"\\\"\\\"\\n regions = self._fdict.get(path_or_fd)\\n if regions is None:\\n regions = self.MapRegionListCls(path_or_fd)\\n self._fdict[path_or_fd] = regions\\n # END obtain region for path\\n return self.WindowCursorCls(self, regions)\\n\\n def collect(self):\\n \\\"\\\"\\\"Collect all available free-to-collect mapped regions\\n :return: Amount of freed handles\\\"\\\"\\\"\\n return self._collect_lru_region(0)\\n\\n def num_file_handles(self):\\n \\\"\\\"\\\":return: amount of file handles in use. Each mapped region uses one file handle\\\"\\\"\\\"\\n return self._handle_count\\n\\n def num_open_files(self):\\n \\\"\\\"\\\"Amount of opened files in the system\\\"\\\"\\\"\\n return reduce(lambda x, y: x + y, (1 for rlist in self._fdict.values() if len(rlist) > 0), 0)\\n\\n def window_size(self):\\n \\\"\\\"\\\":return: size of each window when allocating new regions\\\"\\\"\\\"\\n return self._window_size\\n\\n def mapped_memory_size(self):\\n \\\"\\\"\\\":return: amount of bytes currently mapped in total\\\"\\\"\\\"\\n return self._memory_size\\n\\n def max_file_handles(self):\\n \\\"\\\"\\\":return: maximum amount of handles we may have opened\\\"\\\"\\\"\\n return self._max_handle_count\\n\\n def max_mapped_memory_size(self):\\n \\\"\\\"\\\":return: maximum amount of memory we may allocate\\\"\\\"\\\"\\n return self._max_memory_size\\n\\n #} END interface\\n\\n #{ Special Purpose Interface\\n\\n def force_map_handle_removal_win(self, base_path):\\n \\\"\\\"\\\"ONLY AVAILABLE ON WINDOWS\\n On windows removing files is not allowed if anybody still has it opened.\\n If this process is ourselves, and if the whole process uses this memory\\n manager (as far as the parent framework is concerned) we can enforce\\n closing all memory maps whose path matches the given base path to\\n allow the respective operation after all.\\n The respective system must NOT access the closed memory regions anymore !\\n This really may only be used if you know that the items which keep\\n the cursors alive will not be using it anymore. They need to be recreated !\\n :return: Amount of closed handles\\n\\n **Note:** does nothing on non-windows platforms\\\"\\\"\\\"\\n if sys.platform != 'win32':\\n return\\n # END early bailout\\n\\n num_closed = 0\\n for path, rlist in self._fdict.items():\\n if path.startswith(base_path):\\n for region in rlist:\\n region.release()\\n num_closed += 1\\n # END path matches\\n # END for each path\\n return num_closed\\n #} END special purpose interface\\n\\n\\nclass SlidingWindowMapManager(StaticWindowMapManager):\\n\\n \\\"\\\"\\\"Maintains a list of ranges of mapped memory regions in one or more files and allows to easily\\n obtain additional regions assuring there is no overlap.\\n Once a certain memory limit is reached globally, or if there cannot be more open file handles\\n which result from each mmap call, the least recently used, and currently unused mapped regions\\n are unloaded automatically.\\n\\n **Note:** currently not thread-safe !\\n\\n **Note:** in the current implementation, we will automatically unload windows if we either cannot\\n create more memory maps (as the open file handles limit is hit) or if we have allocated more than\\n a safe amount of memory already, which would possibly cause memory allocations to fail as our address\\n space is full.\\\"\\\"\\\"\\n\\n __slots__ = tuple()\\n\\n def __init__(self, window_size=-1, max_memory_size=0, max_open_handles=sys.maxsize):\\n \\\"\\\"\\\"Adjusts the default window size to -1\\\"\\\"\\\"\\n super().__init__(window_size, max_memory_size, max_open_handles)\\n\\n def _obtain_region(self, a, offset, size, flags, is_recursive):\\n # bisect to find an existing region. The c++ implementation cannot\\n # do that as it uses a linked list for regions.\\n r = None\\n lo = 0\\n hi = len(a)\\n while lo < hi:\\n mid = (lo + hi) // 2\\n ofs = a[mid]._b\\n if ofs <= offset:\\n if a[mid].includes_ofs(offset):\\n r = a[mid]\\n break\\n # END have region\\n lo = mid + 1\\n else:\\n hi = mid\\n # END handle position\\n # END while bisecting\\n\\n if r is None:\\n window_size = self._window_size\\n left = self.MapWindowCls(0, 0)\\n mid = self.MapWindowCls(offset, size)\\n right = self.MapWindowCls(a.file_size(), 0)\\n\\n # we want to honor the max memory size, and assure we have anough\\n # memory available\\n # Save calls !\\n if self._memory_size + window_size > self._max_memory_size:\\n self._collect_lru_region(window_size)\\n # END handle collection\\n\\n # we assume the list remains sorted by offset\\n insert_pos = 0\\n len_regions = len(a)\\n if len_regions == 1:\\n if a[0]._b <= offset:\\n insert_pos = 1\\n # END maintain sort\\n else:\\n # find insert position\\n insert_pos = len_regions\\n for i, region in enumerate(a):\\n if region._b > offset:\\n insert_pos = i\\n break\\n # END if insert position is correct\\n # END for each region\\n # END obtain insert pos\\n\\n # adjust the actual offset and size values to create the largest\\n # possible mapping\\n if insert_pos == 0:\\n if len_regions:\\n right = self.MapWindowCls.from_region(a[insert_pos])\\n # END adjust right side\\n else:\\n if insert_pos != len_regions:\\n right = self.MapWindowCls.from_region(a[insert_pos])\\n # END adjust right window\\n left = self.MapWindowCls.from_region(a[insert_pos - 1])\\n # END adjust surrounding windows\\n\\n mid.extend_left_to(left, window_size)\\n mid.extend_right_to(right, window_size)\\n mid.align()\\n\\n # it can happen that we align beyond the end of the file\\n if mid.ofs_end() > right.ofs:\\n mid.size = right.ofs - mid.ofs\\n # END readjust size\\n\\n # insert new region at the right offset to keep the order\\n try:\\n if self._handle_count >= self._max_handle_count:\\n raise Exception\\n # END assert own imposed max file handles\\n r = self.MapRegionCls(a.path_or_fd(), mid.ofs, mid.size, flags)\\n except Exception:\\n # apparently we are out of system resources or hit a limit\\n # As many more operations are likely to fail in that condition (\\n # like reading a file from disk, etc) we free up as much as possible\\n # As this invalidates our insert position, we have to recurse here\\n if is_recursive:\\n # we already tried this, and still have no success in obtaining\\n # a mapping. This is an exception, so we propagate it\\n raise\\n # END handle existing recursion\\n self._collect_lru_region(0)\\n return self._obtain_region(a, offset, size, flags, True)\\n # END handle exceptions\\n\\n self._handle_count += 1\\n self._memory_size += r.size()\\n a.insert(insert_pos, r)\\n # END create new region\\n return r\\n\\n[end of smmap/mman.py]\",\n \"filename\": \"smmap/mman.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module with a simple buffer implementation using the memory manager\\\"\\\"\\\"\\nimport sys\\n\\n__all__ = [\\\"SlidingWindowMapBuffer\\\"]\\n\\n\\nclass SlidingWindowMapBuffer:\\n\\n \\\"\\\"\\\"A buffer like object which allows direct byte-wise object and slicing into\\n memory of a mapped file. The mapping is controlled by the provided cursor.\\n\\n The buffer is relative, that is if you map an offset, index 0 will map to the\\n first byte at the offset you used during initialization or begin_access\\n\\n **Note:** Although this type effectively hides the fact that there are mapped windows\\n underneath, it can unfortunately not be used in any non-pure python method which\\n needs a buffer or string\\\"\\\"\\\"\\n __slots__ = (\\n '_c', # our cursor\\n '_size', # our supposed size\\n )\\n\\n def __init__(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\\n \\\"\\\"\\\"Initialize the instance to operate on the given cursor.\\n :param cursor: if not None, the associated cursor to the file you want to access\\n If None, you have call begin_access before using the buffer and provide a cursor\\n :param offset: absolute offset in bytes\\n :param size: the total size of the mapping. Defaults to the maximum possible size\\n From that point on, the __len__ of the buffer will be the given size or the file size.\\n If the size is larger than the mappable area, you can only access the actually available\\n area, although the length of the buffer is reported to be your given size.\\n Hence it is in your own interest to provide a proper size !\\n :param flags: Additional flags to be passed to os.open\\n :raise ValueError: if the buffer could not achieve a valid state\\\"\\\"\\\"\\n self._c = cursor\\n if cursor and not self.begin_access(cursor, offset, size, flags):\\n raise ValueError(\\\"Failed to allocate the buffer - probably the given offset is out of bounds\\\")\\n # END handle offset\\n\\n def __del__(self):\\n self.end_access()\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self.end_access()\\n\\n def __len__(self):\\n return self._size\\n\\n def __getitem__(self, i):\\n if isinstance(i, slice):\\n return self.__getslice__(i.start or 0, i.stop or self._size)\\n c = self._c\\n assert c.is_valid()\\n if i < 0:\\n i = self._size + i\\n if not c.includes_ofs(i):\\n c.use_region(i, 1)\\n # END handle region usage\\n return c.buffer()[i - c.ofs_begin()]\\n\\n def __getslice__(self, i, j):\\n c = self._c\\n # fast path, slice fully included - safes a concatenate operation and\\n # should be the default\\n assert c.is_valid()\\n if i < 0:\\n i = self._size + i\\n if j == sys.maxsize:\\n j = self._size\\n if j < 0:\\n j = self._size + j\\n if (c.ofs_begin() <= i) and (j < c.ofs_end()):\\n b = c.ofs_begin()\\n return c.buffer()[i - b:j - b]\\n else:\\n l = j - i # total length\\n ofs = i\\n # It's fastest to keep tokens and join later, especially in py3, which was 7 times slower\\n # in the previous iteration of this code\\n md = list()\\n while l:\\n c.use_region(ofs, l)\\n assert c.is_valid()\\n d = c.buffer()[:l]\\n ofs += len(d)\\n l -= len(d)\\n # Make sure we don't keep references, as c.use_region() might attempt to free resources, but\\n # can't unless we use pure bytes\\n if hasattr(d, 'tobytes'):\\n d = d.tobytes()\\n md.append(d)\\n # END while there are bytes to read\\n return b''.join(md)\\n # END fast or slow path\\n #{ Interface\\n\\n def begin_access(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\\n \\\"\\\"\\\"Call this before the first use of this instance. The method was already\\n called by the constructor in case sufficient information was provided.\\n\\n For more information no the parameters, see the __init__ method\\n :param path: if cursor is None the existing one will be used.\\n :return: True if the buffer can be used\\\"\\\"\\\"\\n if cursor:\\n self._c = cursor\\n # END update our cursor\\n\\n # reuse existing cursors if possible\\n if self._c is not None and self._c.is_associated():\\n res = self._c.use_region(offset, size, flags).is_valid()\\n if res:\\n # if given size is too large or default, we computer a proper size\\n # If its smaller, we assume the combination between offset and size\\n # as chosen by the user is correct and use it !\\n # If not, the user is in trouble.\\n if size > self._c.file_size():\\n size = self._c.file_size() - offset\\n # END handle size\\n self._size = size\\n # END set size\\n return res\\n # END use our cursor\\n return False\\n\\n def end_access(self):\\n \\\"\\\"\\\"Call this method once you are done using the instance. It is automatically\\n called on destruction, and should be called just in time to allow system\\n resources to be freed.\\n\\n Once you called end_access, you must call begin access before reusing this instance!\\\"\\\"\\\"\\n self._size = 0\\n if self._c is not None:\\n self._c.unuse_region()\\n # END unuse region\\n\\n def cursor(self):\\n \\\"\\\"\\\":return: the currently set cursor which provides access to the data\\\"\\\"\\\"\\n return self._c\\n\\n #}END interface\\n\\n[end of smmap/buf.py]\",\n \"filename\": \"smmap/buf.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\\\"\\\"\\\"\\nimport os\\nimport sys\\n\\nfrom mmap import mmap, ACCESS_READ\\nfrom mmap import ALLOCATIONGRANULARITY\\n\\n__all__ = [\\\"align_to_mmap\\\", \\\"is_64_bit\\\",\\n \\\"MapWindow\\\", \\\"MapRegion\\\", \\\"MapRegionList\\\", \\\"ALLOCATIONGRANULARITY\\\"]\\n\\n#{ Utilities\\n\\n\\ndef align_to_mmap(num, round_up):\\n \\\"\\\"\\\"\\n Align the given integer number to the closest page offset, which usually is 4096 bytes.\\n\\n :param round_up: if True, the next higher multiple of page size is used, otherwise\\n the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)\\n :return: num rounded to closest page\\\"\\\"\\\"\\n res = (num // ALLOCATIONGRANULARITY) * ALLOCATIONGRANULARITY\\n if round_up and (res != num):\\n res += ALLOCATIONGRANULARITY\\n # END handle size\\n return res\\n\\n\\ndef is_64_bit():\\n \\\"\\\"\\\":return: True if the system is 64 bit. Otherwise it can be assumed to be 32 bit\\\"\\\"\\\"\\n return sys.maxsize > (1 << 32) - 1\\n\\n#}END utilities\\n\\n\\n#{ Utility Classes\\n\\nclass MapWindow:\\n\\n \\\"\\\"\\\"Utility type which is used to snap windows towards each other, and to adjust their size\\\"\\\"\\\"\\n __slots__ = (\\n 'ofs', # offset into the file in bytes\\n 'size' # size of the window in bytes\\n )\\n\\n def __init__(self, offset, size):\\n self.ofs = offset\\n self.size = size\\n\\n def __repr__(self):\\n return \\\"MapWindow(%i, %i)\\\" % (self.ofs, self.size)\\n\\n @classmethod\\n def from_region(cls, region):\\n \\\"\\\"\\\":return: new window from a region\\\"\\\"\\\"\\n return cls(region._b, region.size())\\n\\n def ofs_end(self):\\n return self.ofs + self.size\\n\\n def align(self):\\n \\\"\\\"\\\"Assures the previous window area is contained in the new one\\\"\\\"\\\"\\n nofs = align_to_mmap(self.ofs, 0)\\n self.size += self.ofs - nofs # keep size constant\\n self.ofs = nofs\\n self.size = align_to_mmap(self.size, 1)\\n\\n def extend_left_to(self, window, max_size):\\n \\\"\\\"\\\"Adjust the offset to start where the given window on our left ends if possible,\\n but don't make yourself larger than max_size.\\n The resize will assure that the new window still contains the old window area\\\"\\\"\\\"\\n rofs = self.ofs - window.ofs_end()\\n nsize = rofs + self.size\\n rofs -= nsize - min(nsize, max_size)\\n self.ofs -= rofs\\n self.size += rofs\\n\\n def extend_right_to(self, window, max_size):\\n \\\"\\\"\\\"Adjust the size to make our window end where the right window begins, but don't\\n get larger than max_size\\\"\\\"\\\"\\n self.size = min(self.size + (window.ofs - self.ofs_end()), max_size)\\n\\n\\nclass MapRegion:\\n\\n \\\"\\\"\\\"Defines a mapped region of memory, aligned to pagesizes\\n\\n **Note:** deallocates used region automatically on destruction\\\"\\\"\\\"\\n __slots__ = [\\n '_b', # beginning of mapping\\n '_mf', # mapped memory chunk (as returned by mmap)\\n '_uc', # total amount of usages\\n '_size', # cached size of our memory map\\n '__weakref__'\\n ]\\n\\n #{ Configuration\\n #} END configuration\\n\\n def __init__(self, path_or_fd, ofs, size, flags=0):\\n \\\"\\\"\\\"Initialize a region, allocate the memory map\\n :param path_or_fd: path to the file to map, or the opened file descriptor\\n :param ofs: **aligned** offset into the file to be mapped\\n :param size: if size is larger then the file on disk, the whole file will be\\n allocated the the size automatically adjusted\\n :param flags: additional flags to be given when opening the file.\\n :raise Exception: if no memory can be allocated\\\"\\\"\\\"\\n self._b = ofs\\n self._size = 0\\n self._uc = 0\\n\\n if isinstance(path_or_fd, int):\\n fd = path_or_fd\\n else:\\n fd = os.open(path_or_fd, os.O_RDONLY | getattr(os, 'O_BINARY', 0) | flags)\\n # END handle fd\\n\\n try:\\n kwargs = dict(access=ACCESS_READ, offset=ofs)\\n corrected_size = size\\n sizeofs = ofs\\n\\n # have to correct size, otherwise (instead of the c version) it will\\n # bark that the size is too large ... many extra file accesses because\\n # if this ... argh !\\n actual_size = min(os.fstat(fd).st_size - sizeofs, corrected_size)\\n self._mf = mmap(fd, actual_size, **kwargs)\\n # END handle memory mode\\n\\n self._size = len(self._mf)\\n finally:\\n if isinstance(path_or_fd, str):\\n os.close(fd)\\n # END only close it if we opened it\\n # END close file handle\\n # We assume the first one to use us keeps us around\\n self.increment_client_count()\\n\\n def __repr__(self):\\n return \\\"MapRegion<%i, %i>\\\" % (self._b, self.size())\\n\\n #{ Interface\\n\\n def buffer(self):\\n \\\"\\\"\\\":return: a buffer containing the memory\\\"\\\"\\\"\\n return self._mf\\n\\n def map(self):\\n \\\"\\\"\\\":return: a memory map containing the memory\\\"\\\"\\\"\\n return self._mf\\n\\n def ofs_begin(self):\\n \\\"\\\"\\\":return: absolute byte offset to the first byte of the mapping\\\"\\\"\\\"\\n return self._b\\n\\n def size(self):\\n \\\"\\\"\\\":return: total size of the mapped region in bytes\\\"\\\"\\\"\\n return self._size\\n\\n def ofs_end(self):\\n \\\"\\\"\\\":return: Absolute offset to one byte beyond the mapping into the file\\\"\\\"\\\"\\n return self._b + self._size\\n\\n def includes_ofs(self, ofs):\\n \\\"\\\"\\\":return: True if the given offset can be read in our mapped region\\\"\\\"\\\"\\n return self._b <= ofs < self._b + self._size\\n\\n def client_count(self):\\n \\\"\\\"\\\":return: number of clients currently using this region\\\"\\\"\\\"\\n return self._uc\\n\\n def increment_client_count(self, ofs = 1):\\n \\\"\\\"\\\"Adjust the usage count by the given positive or negative offset.\\n If usage count equals 0, we will auto-release our resources\\n :return: True if we released resources, False otherwise. In the latter case, we can still be used\\\"\\\"\\\"\\n self._uc += ofs\\n assert self._uc > -1, \\\"Increments must match decrements, usage counter negative: %i\\\" % self._uc\\n\\n if self.client_count() == 0:\\n self.release()\\n return True\\n else:\\n return False\\n # end handle release\\n\\n def release(self):\\n \\\"\\\"\\\"Release all resources this instance might hold. Must only be called if there usage_count() is zero\\\"\\\"\\\"\\n self._mf.close()\\n\\n #} END interface\\n\\n\\nclass MapRegionList(list):\\n\\n \\\"\\\"\\\"List of MapRegion instances associating a path with a list of regions.\\\"\\\"\\\"\\n __slots__ = (\\n '_path_or_fd', # path or file descriptor which is mapped by all our regions\\n '_file_size' # total size of the file we map\\n )\\n\\n def __new__(cls, path):\\n return super().__new__(cls)\\n\\n def __init__(self, path_or_fd):\\n self._path_or_fd = path_or_fd\\n self._file_size = None\\n\\n def path_or_fd(self):\\n \\\"\\\"\\\":return: path or file descriptor we are attached to\\\"\\\"\\\"\\n return self._path_or_fd\\n\\n def file_size(self):\\n \\\"\\\"\\\":return: size of file we manager\\\"\\\"\\\"\\n if self._file_size is None:\\n if isinstance(self._path_or_fd, str):\\n self._file_size = os.stat(self._path_or_fd).st_size\\n else:\\n self._file_size = os.fstat(self._path_or_fd).st_size\\n # END handle path type\\n # END update file size\\n return self._file_size\\n\\n#} END utility classes\\n\\n[end of smmap/util.py]\",\n \"filename\": \"smmap/util.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Initialize the smmap package\\\"\\\"\\\"\\n\\n__author__ = \\\"Sebastian Thiel\\\"\\n__contact__ = \\\"byronimo@gmail.com\\\"\\n__homepage__ = \\\"https://github.com/gitpython-developers/smmap\\\"\\nversion_info = (5, 0, 2)\\n__version__ = '.'.join(str(i) for i in version_info)\\n\\n# make everything available in root package for convenience\\nfrom .mman import *\\nfrom .buf import *\\n\\n[end of smmap/__init__.py]\",\n \"filename\": \"smmap/__init__.py\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = build\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\\n\\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\t-rm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make all-pdf' or \\\\`make all-ps' in that directory to\\\" \\\\\\n\\t \\\"run these through (pdf)latex.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\n[end of doc/Makefile]\",\n \"filename\": \"doc/Makefile\",\n \"id\": \"14\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\nREM Command file for Sphinx documentation\\n\\nset SPHINXBUILD=sphinx-build\\nset BUILDDIR=build\\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\\nif NOT \\\"%PAPER%\\\" == \\\"\\\" (\\n\\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\\n)\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\nif \\\"%1\\\" == \\\"help\\\" (\\n\\t:help\\n\\techo.Please use `make ^<target^>` where ^<target^> is one of\\n\\techo. html to make standalone HTML files\\n\\techo. dirhtml to make HTML files named index.html in directories\\n\\techo. pickle to make pickle files\\n\\techo. json to make JSON files\\n\\techo. htmlhelp to make HTML files and a HTML help project\\n\\techo. qthelp to make HTML files and a qthelp project\\n\\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\n\\techo. changes to make an overview over all changed/added/deprecated items\\n\\techo. linkcheck to check all external links for integrity\\n\\techo. doctest to run all doctests embedded in the documentation if enabled\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"clean\\\" (\\n\\tfor /d %%i in (%BUILDDIR%\\\\*) do rmdir /q /s %%i\\n\\tdel /q /s %BUILDDIR%\\\\*\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"html\\\" (\\n\\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\\n\\techo.\\n\\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"dirhtml\\\" (\\n\\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\\n\\techo.\\n\\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"pickle\\\" (\\n\\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\\n\\techo.\\n\\techo.Build finished; now you can process the pickle files.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"json\\\" (\\n\\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\\n\\techo.\\n\\techo.Build finished; now you can process the JSON files.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"htmlhelp\\\" (\\n\\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\\n\\techo.\\n\\techo.Build finished; now you can run HTML Help Workshop with the ^\\n.hhp project file in %BUILDDIR%/htmlhelp.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"qthelp\\\" (\\n\\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\\n\\techo.\\n\\techo.Build finished; now you can run \\\"qcollectiongenerator\\\" with the ^\\n.qhcp project file in %BUILDDIR%/qthelp, like this:\\n\\techo.^> qcollectiongenerator %BUILDDIR%\\\\qthelp\\\\smmap.qhcp\\n\\techo.To view the help file:\\n\\techo.^> assistant -collectionFile %BUILDDIR%\\\\qthelp\\\\smmap.ghc\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"latex\\\" (\\n\\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\\n\\techo.\\n\\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"changes\\\" (\\n\\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\\n\\techo.\\n\\techo.The overview file is in %BUILDDIR%/changes.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"linkcheck\\\" (\\n\\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\\n\\techo.\\n\\techo.Link check complete; look for any errors in the above output ^\\nor in %BUILDDIR%/linkcheck/output.txt.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"doctest\\\" (\\n\\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\\n\\techo.\\n\\techo.Testing of doctests in the sources finished, look at the ^\\nresults in %BUILDDIR%/doctest/output.txt.\\n\\tgoto end\\n)\\n\\n:end\\n\\n[end of doc/make.bat]\",\n \"filename\": \"doc/make.bat\",\n \"id\": \"15\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.mman import (\\n WindowCursor,\\n SlidingWindowMapManager,\\n StaticWindowMapManager\\n)\\nfrom smmap.util import align_to_mmap\\n\\nfrom random import randint\\nfrom time import time\\nimport os\\nimport sys\\nfrom copy import copy\\n\\n\\nclass TestMMan(TestBase):\\n\\n def test_cursor(self):\\n with FileCreator(self.k_window_test_size, \\\"cursor_test\\\") as fc:\\n man = SlidingWindowMapManager()\\n ci = WindowCursor(man) # invalid cursor\\n assert not ci.is_valid()\\n assert not ci.is_associated()\\n assert ci.size() == 0 # this is cached, so we can query it in invalid state\\n\\n cv = man.make_cursor(fc.path)\\n assert not cv.is_valid() # no region mapped yet\\n assert cv.is_associated() # but it know where to map it from\\n assert cv.file_size() == fc.size\\n assert cv.path() == fc.path\\n\\n # copy module\\n cio = copy(cv)\\n assert not cio.is_valid() and cio.is_associated()\\n\\n # assign method\\n assert not ci.is_associated()\\n ci.assign(cv)\\n assert not ci.is_valid() and ci.is_associated()\\n\\n # unuse non-existing region is fine\\n cv.unuse_region()\\n cv.unuse_region()\\n\\n # destruction is fine (even multiple times)\\n cv._destroy()\\n WindowCursor(man)._destroy()\\n\\n def test_memory_manager(self):\\n slide_man = SlidingWindowMapManager()\\n static_man = StaticWindowMapManager()\\n\\n for man in (static_man, slide_man):\\n assert man.num_file_handles() == 0\\n assert man.num_open_files() == 0\\n winsize_cmp_val = 0\\n if isinstance(man, StaticWindowMapManager):\\n winsize_cmp_val = -1\\n # END handle window size\\n assert man.window_size() > winsize_cmp_val\\n assert man.mapped_memory_size() == 0\\n assert man.max_mapped_memory_size() > 0\\n\\n # collection doesn't raise in 'any' mode\\n man._collect_lru_region(0)\\n # doesn't raise if we are within the limit\\n man._collect_lru_region(10)\\n\\n # doesn't fail if we over-allocate\\n assert man._collect_lru_region(sys.maxsize) == 0\\n\\n # use a region, verify most basic functionality\\n with FileCreator(self.k_window_test_size, \\\"manager_test\\\") as fc:\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n for item in (fc.path, fd):\\n c = man.make_cursor(item)\\n assert c.path_or_fd() is item\\n assert c.use_region(10, 10).is_valid()\\n assert c.ofs_begin() == 10\\n assert c.size() == 10\\n with open(fc.path, 'rb') as fp:\\n assert c.buffer()[:] == fp.read(20)[10:]\\n\\n if isinstance(item, int):\\n self.assertRaises(ValueError, c.path)\\n else:\\n self.assertRaises(ValueError, c.fd)\\n # END handle value error\\n # END for each input\\n finally:\\n os.close(fd)\\n # END for each manasger type\\n\\n def test_memman_operation(self):\\n # test more access, force it to actually unmap regions\\n with FileCreator(self.k_window_test_size, \\\"manager_operation_test\\\") as fc:\\n with open(fc.path, 'rb') as fp:\\n data = fp.read()\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n max_num_handles = 15\\n # small_size =\\n for mtype, args in ((StaticWindowMapManager, (0, fc.size // 3, max_num_handles)),\\n (SlidingWindowMapManager, (fc.size // 100, fc.size // 3, max_num_handles)),):\\n for item in (fc.path, fd):\\n assert len(data) == fc.size\\n\\n # small windows, a reasonable max memory. Not too many regions at once\\n man = mtype(window_size=args[0], max_memory_size=args[1], max_open_handles=args[2])\\n c = man.make_cursor(item)\\n\\n # still empty (more about that is tested in test_memory_manager()\\n assert man.num_open_files() == 0\\n assert man.mapped_memory_size() == 0\\n\\n base_offset = 5000\\n # window size is 0 for static managers, hence size will be 0. We take that into consideration\\n size = man.window_size() // 2\\n assert c.use_region(base_offset, size).is_valid()\\n rr = c.region()\\n assert rr.client_count() == 2 # the manager and the cursor and us\\n\\n assert man.num_open_files() == 1\\n assert man.num_file_handles() == 1\\n assert man.mapped_memory_size() == rr.size()\\n\\n # assert c.size() == size # the cursor may overallocate in its static version\\n assert c.ofs_begin() == base_offset\\n assert rr.ofs_begin() == 0 # it was aligned and expanded\\n if man.window_size():\\n # but isn't larger than the max window (aligned)\\n assert rr.size() == align_to_mmap(man.window_size(), True)\\n else:\\n assert rr.size() == fc.size\\n # END ignore static managers which dont use windows and are aligned to file boundaries\\n\\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\\n\\n # obtain second window, which spans the first part of the file - it is a still the same window\\n nsize = (size or fc.size) - 10\\n assert c.use_region(0, nsize).is_valid()\\n assert c.region() == rr\\n assert man.num_file_handles() == 1\\n assert c.size() == nsize\\n assert c.ofs_begin() == 0\\n assert c.buffer()[:] == data[:nsize]\\n\\n # map some part at the end, our requested size cannot be kept\\n overshoot = 4000\\n base_offset = fc.size - (size or c.size()) + overshoot\\n assert c.use_region(base_offset, size).is_valid()\\n if man.window_size():\\n assert man.num_file_handles() == 2\\n assert c.size() < size\\n assert c.region() is not rr # old region is still available, but has not cursor ref anymore\\n assert rr.client_count() == 1 # only held by manager\\n else:\\n assert c.size() < fc.size\\n # END ignore static managers which only have one handle per file\\n rr = c.region()\\n assert rr.client_count() == 2 # manager + cursor\\n assert rr.ofs_begin() < c.ofs_begin() # it should have extended itself to the left\\n assert rr.ofs_end() <= fc.size # it cannot be larger than the file\\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\\n\\n # unising a region makes the cursor invalid\\n c.unuse_region()\\n assert not c.is_valid()\\n if man.window_size():\\n # but doesn't change anything regarding the handle count - we cache it and only\\n # remove mapped regions if we have to\\n assert man.num_file_handles() == 2\\n # END ignore this for static managers\\n\\n # iterate through the windows, verify data contents\\n # this will trigger map collection after a while\\n max_random_accesses = 5000\\n num_random_accesses = max_random_accesses\\n memory_read = 0\\n st = time()\\n\\n # cache everything to get some more performance\\n includes_ofs = c.includes_ofs\\n max_mapped_memory_size = man.max_mapped_memory_size()\\n max_file_handles = man.max_file_handles()\\n mapped_memory_size = man.mapped_memory_size\\n num_file_handles = man.num_file_handles\\n while num_random_accesses:\\n num_random_accesses -= 1\\n base_offset = randint(0, fc.size - 1)\\n\\n # precondition\\n if man.window_size():\\n assert max_mapped_memory_size >= mapped_memory_size()\\n # END statistics will overshoot, which is fine\\n assert max_file_handles >= num_file_handles()\\n assert c.use_region(base_offset, (size or c.size())).is_valid()\\n csize = c.size()\\n assert c.buffer()[:] == data[base_offset:base_offset + csize]\\n memory_read += csize\\n\\n assert includes_ofs(base_offset)\\n assert includes_ofs(base_offset + csize - 1)\\n assert not includes_ofs(base_offset + csize)\\n # END while we should do an access\\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\\n mb = float(1000 * 1000)\\n print(\\\"%s: Read %i mb of memory with %i random on cursor initialized with %s accesses in %fs (%f mb/s)\\\\n\\\"\\n % (mtype, memory_read / mb, max_random_accesses, type(item), elapsed, (memory_read / mb) / elapsed),\\n file=sys.stderr)\\n\\n # an offset as large as the size doesn't work !\\n assert not c.use_region(fc.size, size).is_valid()\\n\\n # collection - it should be able to collect all\\n assert man.num_file_handles()\\n assert man.collect()\\n assert man.num_file_handles() == 0\\n # END for each item\\n # END for each manager type\\n finally:\\n os.close(fd)\\n\\n[end of smmap/test/test_mman.py]\",\n \"filename\": \"smmap/test/test_mman.py\",\n \"id\": \"16\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Provide base classes for the test system\\\"\\\"\\\"\\nfrom unittest import TestCase\\nimport os\\nimport tempfile\\n\\n__all__ = ['TestBase', 'FileCreator']\\n\\n\\n#{ Utilities\\n\\nclass FileCreator:\\n\\n \\\"\\\"\\\"A instance which creates a temporary file with a prefix and a given size\\n and provides this info to the user.\\n Once it gets deleted, it will remove the temporary file as well.\\\"\\\"\\\"\\n __slots__ = (\\\"_size\\\", \\\"_path\\\")\\n\\n def __init__(self, size, prefix=''):\\n assert size, \\\"Require size to be larger 0\\\"\\n\\n self._size = size\\n\\n with tempfile.NamedTemporaryFile(\\\"wb\\\", prefix=prefix, delete=False) as file:\\n self._path = file.name\\n file.seek(size - 1)\\n file.write(b'1')\\n\\n assert os.path.getsize(self.path) == size\\n\\n def __del__(self):\\n try:\\n os.remove(self.path)\\n except OSError:\\n pass\\n # END exception handling\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self.__del__()\\n\\n @property\\n def path(self):\\n return self._path\\n\\n @property\\n def size(self):\\n return self._size\\n\\n#} END utilities\\n\\n\\nclass TestBase(TestCase):\\n\\n \\\"\\\"\\\"Foundation used by all tests\\\"\\\"\\\"\\n\\n #{ Configuration\\n k_window_test_size = 1000 * 1000 * 8 + 5195\\n #} END configuration\\n\\n #{ Overrides\\n @classmethod\\n def setUpAll(cls):\\n # nothing for now\\n pass\\n\\n # END overrides\\n\\n #{ Interface\\n\\n #} END interface\\n\\n[end of smmap/test/lib.py]\",\n \"filename\": \"smmap/test/lib.py\",\n \"id\": \"17\"\n },\n {\n \"content\": \"[end of smmap/test/__init__.py]\",\n \"filename\": \"smmap/test/__init__.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.mman import (\\n SlidingWindowMapManager,\\n StaticWindowMapManager\\n)\\nfrom smmap.buf import SlidingWindowMapBuffer\\n\\nfrom random import randint\\nfrom time import time\\nimport sys\\nimport os\\n\\n\\nman_optimal = SlidingWindowMapManager()\\nman_worst_case = SlidingWindowMapManager(\\n window_size=TestBase.k_window_test_size // 100,\\n max_memory_size=TestBase.k_window_test_size // 3,\\n max_open_handles=15)\\nstatic_man = StaticWindowMapManager()\\n\\n\\nclass TestBuf(TestBase):\\n\\n def test_basics(self):\\n with FileCreator(self.k_window_test_size, \\\"buffer_test\\\") as fc:\\n\\n # invalid paths fail upon construction\\n c = man_optimal.make_cursor(fc.path)\\n self.assertRaises(ValueError, SlidingWindowMapBuffer, type(c)()) # invalid cursor\\n self.assertRaises(ValueError, SlidingWindowMapBuffer, c, fc.size) # offset too large\\n\\n buf = SlidingWindowMapBuffer() # can create uninitialized buffers\\n assert buf.cursor() is None\\n\\n # can call end access any time\\n buf.end_access()\\n buf.end_access()\\n assert len(buf) == 0\\n\\n # begin access can revive it, if the offset is suitable\\n offset = 100\\n assert buf.begin_access(c, fc.size) == False\\n assert buf.begin_access(c, offset) == True\\n assert len(buf) == fc.size - offset\\n assert buf.cursor().is_valid()\\n\\n # empty begin access keeps it valid on the same path, but alters the offset\\n assert buf.begin_access() == True\\n assert len(buf) == fc.size\\n assert buf.cursor().is_valid()\\n\\n # simple access\\n with open(fc.path, 'rb') as fp:\\n data = fp.read()\\n assert data[offset] == buf[0]\\n assert data[offset:offset * 2] == buf[0:offset]\\n\\n # negative indices, partial slices\\n assert buf[-1] == buf[len(buf) - 1]\\n assert buf[-10:] == buf[len(buf) - 10:len(buf)]\\n\\n # end access makes its cursor invalid\\n buf.end_access()\\n assert not buf.cursor().is_valid()\\n assert buf.cursor().is_associated() # but it remains associated\\n\\n # an empty begin access fixes it up again\\n assert buf.begin_access() == True and buf.cursor().is_valid()\\n del(buf) # ends access automatically\\n del(c)\\n\\n assert man_optimal.num_file_handles() == 1\\n\\n # PERFORMANCE\\n # blast away with random access and a full mapping - we don't want to\\n # exaggerate the manager's overhead, but measure the buffer overhead\\n # We do it once with an optimal setting, and with a worse manager which\\n # will produce small mappings only !\\n max_num_accesses = 100\\n fd = os.open(fc.path, os.O_RDONLY)\\n for item in (fc.path, fd):\\n for manager, man_id in ((man_optimal, 'optimal'),\\n (man_worst_case, 'worst case'),\\n (static_man, 'static optimal')):\\n buf = SlidingWindowMapBuffer(manager.make_cursor(item))\\n assert manager.num_file_handles() == 1\\n for access_mode in range(2): # single, multi\\n num_accesses_left = max_num_accesses\\n num_bytes = 0\\n fsize = fc.size\\n\\n st = time()\\n buf.begin_access()\\n while num_accesses_left:\\n num_accesses_left -= 1\\n if access_mode: # multi\\n ofs_start = randint(0, fsize)\\n ofs_end = randint(ofs_start, fsize)\\n d = buf[ofs_start:ofs_end]\\n assert len(d) == ofs_end - ofs_start\\n assert d == data[ofs_start:ofs_end]\\n num_bytes += len(d)\\n del d\\n else:\\n pos = randint(0, fsize)\\n assert buf[pos] == data[pos]\\n num_bytes += 1\\n # END handle mode\\n # END handle num accesses\\n\\n buf.end_access()\\n assert manager.num_file_handles()\\n assert manager.collect()\\n assert manager.num_file_handles() == 0\\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\\n mb = float(1000 * 1000)\\n mode_str = (access_mode and \\\"slice\\\") or \\\"single byte\\\"\\n print(\\\"%s: Made %i random %s accesses to buffer created from %s reading a total of %f mb in %f s (%f mb/s)\\\"\\n % (man_id, max_num_accesses, mode_str, type(item), num_bytes / mb, elapsed, (num_bytes / mb) / elapsed),\\n file=sys.stderr)\\n # END handle access mode\\n del buf\\n # END for each manager\\n # END for each input\\n os.close(fd)\\n\\n[end of smmap/test/test_buf.py]\",\n \"filename\": \"smmap/test/test_buf.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.util import (\\n MapWindow,\\n MapRegion,\\n MapRegionList,\\n ALLOCATIONGRANULARITY,\\n is_64_bit,\\n align_to_mmap\\n)\\n\\nimport os\\nimport sys\\n\\n\\nclass TestMMan(TestBase):\\n\\n def test_window(self):\\n wl = MapWindow(0, 1) # left\\n wc = MapWindow(1, 1) # center\\n wc2 = MapWindow(10, 5) # another center\\n wr = MapWindow(8000, 50) # right\\n\\n assert wl.ofs_end() == 1\\n assert wc.ofs_end() == 2\\n assert wr.ofs_end() == 8050\\n\\n # extension does nothing if already in place\\n maxsize = 100\\n wc.extend_left_to(wl, maxsize)\\n assert wc.ofs == 1 and wc.size == 1\\n wl.extend_right_to(wc, maxsize)\\n wl.extend_right_to(wc, maxsize)\\n assert wl.ofs == 0 and wl.size == 1\\n\\n # an actual left extension\\n pofs_end = wc2.ofs_end()\\n wc2.extend_left_to(wc, maxsize)\\n assert wc2.ofs == wc.ofs_end() and pofs_end == wc2.ofs_end()\\n\\n # respects maxsize\\n wc.extend_right_to(wr, maxsize)\\n assert wc.ofs == 1 and wc.size == maxsize\\n wc.extend_right_to(wr, maxsize)\\n assert wc.ofs == 1 and wc.size == maxsize\\n\\n # without maxsize\\n wc.extend_right_to(wr, sys.maxsize)\\n assert wc.ofs_end() == wr.ofs and wc.ofs == 1\\n\\n # extend left\\n wr.extend_left_to(wc2, maxsize)\\n wr.extend_left_to(wc2, maxsize)\\n assert wr.size == maxsize\\n\\n wr.extend_left_to(wc2, sys.maxsize)\\n assert wr.ofs == wc2.ofs_end()\\n\\n wc.align()\\n assert wc.ofs == 0 and wc.size == align_to_mmap(wc.size, True)\\n\\n def test_region(self):\\n with FileCreator(self.k_window_test_size, \\\"window_test\\\") as fc:\\n half_size = fc.size // 2\\n rofs = align_to_mmap(4200, False)\\n rfull = MapRegion(fc.path, 0, fc.size)\\n rhalfofs = MapRegion(fc.path, rofs, fc.size)\\n rhalfsize = MapRegion(fc.path, 0, half_size)\\n\\n # offsets\\n assert rfull.ofs_begin() == 0 and rfull.size() == fc.size\\n assert rfull.ofs_end() == fc.size # if this method works, it works always\\n\\n assert rhalfofs.ofs_begin() == rofs and rhalfofs.size() == fc.size - rofs\\n assert rhalfsize.ofs_begin() == 0 and rhalfsize.size() == half_size\\n\\n assert rfull.includes_ofs(0) and rfull.includes_ofs(fc.size - 1) and rfull.includes_ofs(half_size)\\n assert not rfull.includes_ofs(-1) and not rfull.includes_ofs(sys.maxsize)\\n\\n # auto-refcount\\n assert rfull.client_count() == 1\\n rfull2 = rfull\\n assert rfull.client_count() == 1, \\\"no auto-counting\\\"\\n\\n # window constructor\\n w = MapWindow.from_region(rfull)\\n assert w.ofs == rfull.ofs_begin() and w.ofs_end() == rfull.ofs_end()\\n\\n def test_region_list(self):\\n with FileCreator(100, \\\"sample_file\\\") as fc:\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n for item in (fc.path, fd):\\n ml = MapRegionList(item)\\n\\n assert len(ml) == 0\\n assert ml.path_or_fd() == item\\n assert ml.file_size() == fc.size\\n finally:\\n os.close(fd)\\n\\n def test_util(self):\\n assert isinstance(is_64_bit(), bool) # just call it\\n assert align_to_mmap(1, False) == 0\\n assert align_to_mmap(1, True) == ALLOCATIONGRANULARITY\\n\\n[end of smmap/test/test_util.py]\",\n \"filename\": \"smmap/test/test_util.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"from .lib import TestBase\\n\\n\\nclass TestTutorial(TestBase):\\n\\n def test_example(self):\\n # Memory Managers\\n ##################\\n import smmap\\n # This instance should be globally available in your application\\n # It is configured to be well suitable for 32-bit or 64 bit applications.\\n mman = smmap.SlidingWindowMapManager()\\n\\n # the manager provides much useful information about its current state\\n # like the amount of open file handles or the amount of mapped memory\\n assert mman.num_file_handles() == 0\\n assert mman.mapped_memory_size() == 0\\n # and many more ...\\n\\n # Cursors\\n ##########\\n import smmap.test.lib\\n with smmap.test.lib.FileCreator(1024 * 1024 * 8, \\\"test_file\\\") as fc:\\n # obtain a cursor to access some file.\\n c = mman.make_cursor(fc.path)\\n\\n # the cursor is now associated with the file, but not yet usable\\n assert c.is_associated()\\n assert not c.is_valid()\\n\\n # before you can use the cursor, you have to specify a window you want to\\n # access. The following just says you want as much data as possible starting\\n # from offset 0.\\n # To be sure your region could be mapped, query for validity\\n assert c.use_region().is_valid() # use_region returns self\\n\\n # once a region was mapped, you must query its dimension regularly\\n # to assure you don't try to access its buffer out of its bounds\\n assert c.size()\\n c.buffer()[0] # first byte\\n c.buffer()[1:10] # first 9 bytes\\n c.buffer()[c.size() - 1] # last byte\\n\\n # you can query absolute offsets, and check whether an offset is included\\n # in the cursor's data.\\n assert c.ofs_begin() < c.ofs_end()\\n assert c.includes_ofs(100)\\n\\n # If you are over out of bounds with one of your region requests, the\\n # cursor will be come invalid. It cannot be used in that state\\n assert not c.use_region(fc.size, 100).is_valid()\\n # map as much as possible after skipping the first 100 bytes\\n assert c.use_region(100).is_valid()\\n\\n # You can explicitly free cursor resources by unusing the cursor's region\\n c.unuse_region()\\n assert not c.is_valid()\\n\\n # Buffers\\n #########\\n # Create a default buffer which can operate on the whole file\\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\\n\\n # you can use it right away\\n assert buf.cursor().is_valid()\\n\\n buf[0] # access the first byte\\n buf[-1] # access the last ten bytes on the file\\n buf[-10:] # access the last ten bytes\\n\\n # If you want to keep the instance between different accesses, use the\\n # dedicated methods\\n buf.end_access()\\n assert not buf.cursor().is_valid() # you cannot use the buffer anymore\\n assert buf.begin_access(offset=10) # start using the buffer at an offset\\n\\n[end of smmap/test/test_tutorial.py]\",\n \"filename\": \"smmap/test/test_tutorial.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. smmap documentation master file, created by\\n sphinx-quickstart on Wed Jun 8 15:14:25 2011.\\n You can adapt this file completely to your liking, but it should at least\\n contain the root `toctree` directive.\\n\\nWelcome to smmap's documentation!\\n=================================\\n**smmap** is a pure python implementation of a sliding memory map to help unifying memory mapped access on 32 and 64 bit systems and to help managing resources more efficiently.\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n \\n intro\\n tutorial\\n api\\n changes\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of doc/source/index.rst]\",\n \"filename\": \"doc/source/index.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"###########\\nMotivation\\n###########\\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\\n\\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\\n\\n########\\nOverview\\n########\\n\\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\\n\\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\\n\\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\\n\\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\\n\\n#############\\nPrerequisites\\n#############\\n* Python 3.7+\\n* OSX, Windows or Linux\\n\\nThe package was tested on all of the previously mentioned configurations.\\n\\n###########\\nLimitations\\n###########\\n* The memory access is read-only by design.\\n\\n################\\nInstalling smmap\\n################\\nIts easiest to install smmap using the *pip* program::\\n \\n $ pip install smmap\\n \\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\\n\\nIf you have downloaded the source archive, the package can be installed by running the ``setup.py`` script::\\n \\n $ python setup.py install\\n\\nIt is advised to have a look at the :ref:`Usage Guide <tutorial-label>` for a brief introduction on the different database implementations.\\n\\n##################\\nHomepage and Links\\n##################\\nThe project is home on github at `https://github.com/gitpython-developers/smmap <https://github.com/gitpython-developers/smmap>`_.\\n\\nThe latest source can be cloned from github as well:\\n\\n * git://github.com/gitpython-developers/smmap.git\\n \\n \\nFor support, please use the git-python mailing list:\\n\\n * http://groups.google.com/group/git-python\\n \\n\\nIssues can be filed on github:\\n\\n * https://github.com/gitpython-developers/smmap/issues\\n \\n###################\\nLicense Information\\n###################\\n*smmap* is licensed under the New BSD License.\\n\\n.. _pip: http://www.pip-installer.org/en/latest/\\n\\n[end of doc/source/intro.rst]\",\n \"filename\": \"doc/source/intro.rst\",\n \"id\": \"23\"\n },\n {\n \"content\": \"#\\n# smmap documentation build configuration file, created by\\n# sphinx-quickstart on Wed Jun 8 15:14:25 2011.\\n#\\n# This file is execfile()d with the current directory set to its containing dir.\\n#\\n# Note that not all possible configuration values are present in this\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.append(os.path.abspath('../../'))\\n\\n# -- General configuration -----------------------------------------------------\\n\\n# Add any Sphinx extension module names here, as strings. They can be extensions\\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['.templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = 'smmap'\\ncopyright = '2011, Sebastian Thiel'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.8.0'\\n# The full version, including alpha/beta/rc tags.\\nrelease = '0.8.0'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of documents that shouldn't be included in the build.\\n#unused_docs = []\\n\\n# List of directories, relative to source directory, that shouldn't be searched\\n# for source files.\\nexclude_trees = []\\n\\n# The reST default role (used for this markup: `text`) to use for all documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n\\n# -- Options for HTML output ---------------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. Major themes that come with\\n# Sphinx are currently 'default' and 'sphinxdoc'.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['.static']\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_use_modindex = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# If nonempty, this is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = ''\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'smmapdoc'\\n\\n\\n# -- Options for LaTeX output --------------------------------------------------\\n\\n# The paper size ('letter' or 'a4').\\n#latex_paper_size = 'letter'\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#latex_font_size = '10pt'\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title, author, documentclass [howto/manual]).\\nlatex_documents = [\\n ('index', 'smmap.tex', 'smmap Documentation',\\n 'Sebastian Thiel', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# Additional stuff for the LaTeX preamble.\\n#latex_preamble = ''\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_use_modindex = True\\n\\n[end of doc/source/conf.py]\",\n \"filename\": \"doc/source/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \".. _tutorial-label:\\n\\n###########\\nUsage Guide\\n###########\\nThis text briefly introduces you to the basic design decisions and accompanying classes.\\n\\n******\\nDesign\\n******\\nPer application, there is *MemoryManager* which is held as static instance and used throughout the application. It can be configured to keep your resources within certain limits.\\n\\nTo access mapped regions, you require a cursor. Cursors point to exactly one file and serve as handles into it. As long as it exists, the respective memory region will remain available.\\n\\nFor convenience, a buffer implementation is provided which handles cursors and resource allocation behind its simple buffer like interface.\\n\\n***************\\nMemory Managers\\n***************\\nThere are two types of memory managers, one uses *static* windows, the other one uses *sliding* windows. A window is a region of a file mapped into memory. Although the names might be somewhat misleading as technically windows are always static, the *sliding* version will allocate relatively small windows whereas the *static* version will always map the whole file.\\n\\nThe *static* manager does nothing more than keeping a client count on the respective memory maps which always map the whole file, which allows to make some assumptions that can lead to simplified data access and increased performance, but reduces the compatibility to 32 bit systems or giant files.\\n\\nThe *sliding* memory manager therefore should be the default manager when preparing an application for handling huge amounts of data on 32 bit and 64 bit platforms::\\n\\n import smmap\\n # This instance should be globally available in your application\\n # It is configured to be well suitable for 32-bit or 64 bit applications.\\n mman = smmap.SlidingWindowMapManager()\\n \\n # the manager provides much useful information about its current state\\n # like the amount of open file handles or the amount of mapped memory\\n mman.num_file_handles()\\n mman.mapped_memory_size()\\n # and many more ...\\n\\n\\nCursors\\n*******\\n*Cursors* are handles that point onto a window, i.e. a region of a file mapped into memory. From them you may obtain a buffer through which the data of that window can actually be accessed::\\n\\n import smmap.test.lib\\n fc = smmap.test.lib.FileCreator(1024*1024*8, \\\"test_file\\\")\\n \\n # obtain a cursor to access some file.\\n c = mman.make_cursor(fc.path)\\n \\n # the cursor is now associated with the file, but not yet usable\\n assert c.is_associated()\\n assert not c.is_valid()\\n \\n # before you can use the cursor, you have to specify a window you want to \\n # access. The following just says you want as much data as possible starting\\n # from offset 0.\\n # To be sure your region could be mapped, query for validity\\n assert c.use_region().is_valid()\\t\\t# use_region returns self\\n \\n # once a region was mapped, you must query its dimension regularly\\n # to assure you don't try to access its buffer out of its bounds\\n assert c.size()\\n c.buffer()[0]\\t\\t\\t# first byte\\n c.buffer()[1:10]\\t\\t\\t# first 9 bytes\\n c.buffer()[c.size()-1] \\t# last byte\\n \\n # its recommended not to create big slices when feeding the buffer\\n # into consumers (e.g. struct or zlib). \\n # Instead, either give the buffer directly, or use pythons buffer command.\\n buffer(c.buffer(), 1, 9)\\t# first 9 bytes without copying them\\n \\n # you can query absolute offsets, and check whether an offset is included\\n # in the cursor's data.\\n assert c.ofs_begin() < c.ofs_end()\\n assert c.includes_ofs(100)\\n \\n # If you are over out of bounds with one of your region requests, the \\n # cursor will be come invalid. It cannot be used in that state\\n assert not c.use_region(fc.size, 100).is_valid()\\n # map as much as possible after skipping the first 100 bytes\\n assert c.use_region(100).is_valid()\\n \\n # You can explicitly free cursor resources by unusing the cursor's region\\n c.unuse_region()\\n assert not c.is_valid()\\n \\n\\nNow you would have to write your algorithms around this interface to properly slide through huge amounts of data. \\n \\nAlternatively you can use a convenience interface.\\n\\n*******\\nBuffers\\n*******\\nTo make first use easier, at the expense of performance, there is a Buffer implementation which uses a cursor underneath.\\n\\nWith it, you can access all data in a possibly huge file without having to take care of setting the cursor to different regions yourself::\\n\\n # Create a default buffer which can operate on the whole file\\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\\n \\n # you can use it right away\\n assert buf.cursor().is_valid()\\n \\n buf[0]\\t# access the first byte\\n buf[-1]\\t# access the last ten bytes on the file\\n buf[-10:]# access the last ten bytes\\n \\n # If you want to keep the instance between different accesses, use the\\n # dedicated methods\\n buf.end_access()\\n assert not buf.cursor().is_valid()\\t# you cannot use the buffer anymore\\n assert buf.begin_access(offset=10)\\t# start using the buffer at an offset\\n \\n # it will stop using resources automatically once it goes out of scope\\n \\nDisadvantages\\n*************\\nBuffers cannot be used in place of strings or maps, hence you have to slice them to have valid input for the sorts of struct and zlib. A slice means a lot of data handling overhead which makes buffers slower compared to using cursors directly. \\n\\n\\n[end of doc/source/tutorial.rst]\",\n \"filename\": \"doc/source/tutorial.rst\",\n \"id\": \"25\"\n },\n {\n \"content\": \"#########\\nChangelog\\n#########\\n\\n******\\nv5.0.2\\n******\\n\\n- remove a usage of mktemp\\n\\n******\\nv5.0.1\\n******\\n\\n- Added support for Python 3.12\\n\\n******\\nv6.0.0\\n******\\n\\nYANKED\\n\\n- Dropped support 3.6 and 3.7\\n- Declared support for Python 3.11 and 3.12\\n\\n******\\nv5.0.0\\n******\\n\\n- Dropped support 3.5\\n- Added support for Python 3.10\\n\\n******\\nv4.0.0\\n******\\n\\n- Dropped support for Python 2.7 and 3.4\\n- Added support for Python 3.7, 3.8, and 3.9\\n- Removed unused exc.MemoryManagerError and exc.RegionCollectionError\\n\\n******\\nv3.0.5\\n******\\n\\n- Restored Python 2 support removed in v3.0.2\\n- Changed release signature key to 27C50E7F590947D7273A741E85194C08421980C9.\\n See https://keybase.io/byronbates for proof of ownership.\\n\\n******\\nv3.0.4\\n******\\n\\n- Signed release (with correct key this time)\\n\\n******\\nv3.0.2\\n******\\n\\n- Signed release\\n- Switched to GitHub Actions for CI\\n\\n******\\nv3.0.1\\n******\\n- Switched back to the smmap package name on PyPI and fixed the smmap2 mirror package\\n (`#44 <https://github.com/gitpython-developers/smmap/issues/44>`_)\\n- Fixed setup.py ``long_description`` rendering\\n (`#40 <https://github.com/gitpython-developers/smmap/pull/40>`_)\\n\\n**********\\nv0.9.0\\n**********\\n- Fixed issue with resources never being freed as mmaps were never closed.\\n- Client counting is now done manually, instead of relying on pyton's reference count\\n\\n**********\\nv0.8.5\\n**********\\n- Fixed Python 3.0-3.3 regression, which also causes smmap to become about 3 times slower depending on the code path. It's related to this bug (http://bugs.python.org/issue15958), which was fixed in python 3.4\\n\\n**********\\nv0.8.4\\n**********\\n- Fixed Python 3 performance regression\\n\\n**********\\nv0.8.3\\n**********\\n- Cleaned up code and assured it works sufficiently well with python 3\\n\\n**********\\nv0.8.1\\n**********\\n- A single bugfix\\n\\n**********\\nv0.8.0 \\n**********\\n\\n- Initial Release\\n\\n[end of doc/source/changes.rst]\",\n \"filename\": \"doc/source/changes.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \".. _api-label:\\n\\n#############\\nAPI Reference\\n#############\\n\\n***********************\\nMapped Memory Managers\\n***********************\\n\\n.. automodule:: smmap.mman\\n :members:\\n :undoc-members:\\n\\n*******\\nBuffers\\n*******\\n\\n.. automodule:: smmap.buf\\n :members:\\n :undoc-members:\\n\\n*********\\nUtilities\\n*********\\n\\n.. automodule:: smmap.util\\n :members:\\n :undoc-members:\\n\\n\\n\\n\\n\\n\\n[end of doc/source/api.rst]\",\n \"filename\": \"doc/source/api.rst\",\n \"id\": \"27\"\n }\n]","isConversational":false}}},{"rowIdx":72,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 72,\n \"num_files\": 28,\n \"repo_id\": \"repo_0072\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"Copyright (C) 2010, 2011 Sebastian Thiel and contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions \nare met:\n\n* Redistributions of source code must retain the above copyright \nnotice, this list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright \nnotice, this list of conditions and the following disclaimer in the \ndocumentation and/or other materials provided with the distribution.\n\n* Neither the name of the async project nor the names of \nits contributors may be used to endorse or promote products derived \nfrom this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED \nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR \nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING \nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":".PHONY: all clean release force_release\n\nall:\n\t@grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all\n\nclean:\n\trm -rf build/ dist/ .eggs/ .tox/\n\nforce_release: clean\n\t./build-release.sh\n\ttwine upload dist/*\n\tgit push --tags origin master\n\n[end of Makefile]","filename":"Makefile","id":"1"},{"content":"# Include the license file\ninclude LICENSE\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"2"},{"content":"[run]\nsource = smmap\n\n; to make nosetests happy\n[report]\nomit = \n\t*/yaml*\n\t*/tests/*\n */python?.?/*\n */site-packages/nose/*\n[end of .coveragerc]","filename":".coveragerc","id":"3"},{"content":"## Motivation\n\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\n\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\n\n\n## Limitations\n\n* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.\n* The memory access is read-only by design.\n\n\n## Overview\n\n\n\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\n\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\n\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\n\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\n\n\n\n## Prerequisites\n\n* Python 3.7+\n* OSX, Windows or Linux\n\nThe package was tested on all of the previously mentioned configurations.\n\n## Installing smmap\n\n[](https://readthedocs.org/projects/smmap/?badge=latest)\n\nIts easiest to install smmap using the [pip](http://www.pip-installer.org/en/latest) program:\n\n```bash\n$ pip install smmap\n```\n\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\n\nIf you have downloaded the source archive, the package can be installed by running the `setup.py` script:\n\n```bash\n$ python setup.py install\n```\n\nIt is advised to have a look at the **Usage Guide** for a brief introduction on the different database implementations.\n\n\n\n## Homepage and Links\n\nThe project is home on github at https://github.com/gitpython-developers/smmap .\n\nThe latest source can be cloned from github as well:\n\n* git://github.com/gitpython-developers/smmap.git\n\n\nFor support, please use the git-python mailing list:\n\n* http://groups.google.com/group/git-python\n\n\nIssues can be filed on github:\n\n* https://github.com/gitpython-developers/smmap/issues\n\nA link to the pypi page related to this repository:\n\n* https://pypi.org/project/smmap/\n\n\n## License Information\n\n*smmap* is licensed under the New BSD License.\n\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"#!/usr/bin/env python\nimport os\n\ntry:\n from setuptools import setup, find_packages\nexcept ImportError:\n from ez_setup import use_setuptools\n use_setuptools()\n from setuptools import setup, find_packages\n\nimport smmap\n\nif os.path.exists(\"README.md\"):\n long_description = open('README.md', encoding=\"utf-8\").read().replace('\\r\\n', '\\n')\nelse:\n long_description = \"See https://github.com/gitpython-developers/smmap\"\n\nsetup(\n name=\"smmap\",\n version=smmap.__version__,\n description=\"A pure Python implementation of a sliding window memory map manager\",\n author=smmap.__author__,\n author_email=smmap.__contact__,\n url=smmap.__homepage__,\n platforms=[\"any\"],\n license=\"BSD-3-Clause\",\n packages=find_packages(),\n zip_safe=True,\n python_requires=\">=3.7\",\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Operating System :: POSIX\",\n \"Operating System :: Microsoft :: Windows\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.7\",\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 \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3 :: Only\",\n ],\n long_description=long_description,\n long_description_content_type='text/markdown',\n)\n\n[end of setup.py]","filename":"setup.py","id":"5"},{"content":"# Tox (http://tox.testrun.org/) is a tool for running tests\n# in multiple virtualenvs. This configuration file will run the\n# test suite on all supported python versions. To use it, \"pip install tox\"\n# and then run \"tox\" from this directory.\n\n[tox]\nenvlist = flake8, py{37, 38, 39, 310, 311, 312}\n\n[testenv]\ncommands = {envpython} -m pytest --cov smmap --cov-report xml {posargs}\ndeps =\n pytest\n pytest-cov\n\n[testenv:flake8]\ncommands = flake8 {posargs}\ndeps = flake8\n\n[end of tox.ini]","filename":"tox.ini","id":"6"},{"content":"[flake8]\nexclude = .tox,.venv,build,dist,doc\n\n[end of setup.cfg]","filename":"setup.cfg","id":"7"},{"content":"#!/bin/bash\n#\n# This script builds a release. If run in a venv, it auto-installs its tools.\n# You may want to run \"make release\" instead of running this script directly.\n\nset -eEu\n\nfunction release_with() {\n $1 -m build --sdist --wheel\n}\n\nif test -n \"${VIRTUAL_ENV:-}\"; then\n deps=(build twine) # Install twine along with build, as we need it later.\n echo \"Virtual environment detected. Adding packages: ${deps[*]}\"\n pip install --quiet --upgrade \"${deps[@]}\"\n echo 'Starting the build.'\n release_with python\nelse\n function suggest_venv() {\n venv_cmd='python -m venv env && source env/bin/activate'\n printf \"HELP: To avoid this error, use a virtual-env with '%s' instead.\\n\" \"$venv_cmd\"\n }\n trap suggest_venv ERR # This keeps the original exit (error) code.\n echo 'Starting the build.'\n release_with python3 # Outside a venv, use python3.\nfi\n\n[end of build-release.sh]","filename":"build-release.sh","id":"8"},{"content":"# Security Policy\n\nSee [GitPython](https://github.com/gitpython-developers/GitPython/blob/main/SECURITY.md). Vulnerabilities found in `smmap` can be reported there.\n\n[end of SECURITY.md]","filename":"SECURITY.md","id":"9"},{"content":"\"\"\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\"\"\"\nfrom .util import (\n MapWindow,\n MapRegion,\n MapRegionList,\n is_64_bit,\n)\n\nimport sys\nfrom functools import reduce\n\n__all__ = [\"StaticWindowMapManager\", \"SlidingWindowMapManager\", \"WindowCursor\"]\n#{ Utilities\n\n#}END utilities\n\n\nclass WindowCursor:\n\n \"\"\"\n Pointer into the mapped region of the memory manager, keeping the map\n alive until it is destroyed and no other client uses it.\n\n Cursors should not be created manually, but are instead returned by the SlidingWindowMapManager\n\n **Note:**: The current implementation is suited for static and sliding window managers, but it also means\n that it must be suited for the somewhat quite different sliding manager. It could be improved, but\n I see no real need to do so.\"\"\"\n __slots__ = (\n '_manager', # the manager keeping all file regions\n '_rlist', # a regions list with regions for our file\n '_region', # our current class:`MapRegion` or None\n '_ofs', # relative offset from the actually mapped area to our start area\n '_size' # maximum size we should provide\n )\n\n def __init__(self, manager=None, regions=None):\n self._manager = manager\n self._rlist = regions\n self._region = None\n self._ofs = 0\n self._size = 0\n\n def __del__(self):\n self._destroy()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self._destroy()\n\n def _destroy(self):\n \"\"\"Destruction code to decrement counters\"\"\"\n self.unuse_region()\n\n if self._rlist is not None:\n # Actual client count, which doesn't include the reference kept by the manager, nor ours\n # as we are about to be deleted\n try:\n if len(self._rlist) == 0:\n # Free all resources associated with the mapped file\n self._manager._fdict.pop(self._rlist.path_or_fd())\n # END remove regions list from manager\n except (TypeError, KeyError):\n # sometimes, during shutdown, getrefcount is None. Its possible\n # to re-import it, however, its probably better to just ignore\n # this python problem (for now).\n # The next step is to get rid of the error prone getrefcount altogether.\n pass\n # END exception handling\n # END handle regions\n\n def _copy_from(self, rhs):\n \"\"\"Copy all data from rhs into this instance, handles usage count\"\"\"\n self._manager = rhs._manager\n self._rlist = type(rhs._rlist)(rhs._rlist)\n self._region = rhs._region\n self._ofs = rhs._ofs\n self._size = rhs._size\n\n for region in self._rlist:\n region.increment_client_count()\n\n if self._region is not None:\n self._region.increment_client_count()\n # END handle regions\n\n def __copy__(self):\n \"\"\"copy module interface\"\"\"\n cpy = type(self)()\n cpy._copy_from(self)\n return cpy\n\n #{ Interface\n def assign(self, rhs):\n \"\"\"Assign rhs to this instance. This is required in order to get a real copy.\n Alternatively, you can copy an existing instance using the copy module\"\"\"\n self._destroy()\n self._copy_from(rhs)\n\n def use_region(self, offset=0, size=0, flags=0):\n \"\"\"Assure we point to a window which allows access to the given offset into the file\n\n :param offset: absolute offset in bytes into the file\n :param size: amount of bytes to map. If 0, all available bytes will be mapped\n :param flags: additional flags to be given to os.open in case a file handle is initially opened\n for mapping. Has no effect if a region can actually be reused.\n :return: this instance - it should be queried for whether it points to a valid memory region.\n This is not the case if the mapping failed because we reached the end of the file\n\n **Note:**: The size actually mapped may be smaller than the given size. If that is the case,\n either the file has reached its end, or the map was created between two existing regions\"\"\"\n need_region = True\n man = self._manager\n fsize = self._rlist.file_size()\n size = min(size or fsize, man.window_size() or fsize) # clamp size to window size\n\n if self._region is not None:\n if self._region.includes_ofs(offset):\n need_region = False\n else:\n self.unuse_region()\n # END handle existing region\n # END check existing region\n\n # offset too large ?\n if offset >= fsize:\n return self\n # END handle offset\n\n if need_region:\n self._region = man._obtain_region(self._rlist, offset, size, flags, False)\n self._region.increment_client_count()\n # END need region handling\n\n self._ofs = offset - self._region._b\n self._size = min(size, self._region.ofs_end() - offset)\n\n return self\n\n def unuse_region(self):\n \"\"\"Unuse the current region. Does nothing if we have no current region\n\n **Note:** the cursor unuses the region automatically upon destruction. It is recommended\n to un-use the region once you are done reading from it in persistent cursors as it\n helps to free up resource more quickly\"\"\"\n if self._region is not None:\n self._region.increment_client_count(-1)\n self._region = None\n # note: should reset ofs and size, but we spare that for performance. Its not\n # allowed to query information if we are not valid !\n\n def buffer(self):\n \"\"\"Return a buffer object which allows access to our memory region from our offset\n to the window size. Please note that it might be smaller than you requested when calling use_region()\n\n **Note:** You can only obtain a buffer if this instance is_valid() !\n\n **Note:** buffers should not be cached passed the duration of your access as it will\n prevent resources from being freed even though they might not be accounted for anymore !\"\"\"\n return memoryview(self._region.buffer())[self._ofs:self._ofs+self._size]\n\n def map(self):\n \"\"\"\n :return: the underlying raw memory map. Please not that the offset and size is likely to be different\n to what you set as offset and size. Use it only if you are sure about the region it maps, which is the whole\n file in case of StaticWindowMapManager\"\"\"\n return self._region.map()\n\n def is_valid(self):\n \"\"\":return: True if we have a valid and usable region\"\"\"\n return self._region is not None\n\n def is_associated(self):\n \"\"\":return: True if we are associated with a specific file already\"\"\"\n return self._rlist is not None\n\n def ofs_begin(self):\n \"\"\":return: offset to the first byte pointed to by our cursor\n\n **Note:** only if is_valid() is True\"\"\"\n return self._region._b + self._ofs\n\n def ofs_end(self):\n \"\"\":return: offset to one past the last available byte\"\"\"\n # unroll method calls for performance !\n return self._region._b + self._ofs + self._size\n\n def size(self):\n \"\"\":return: amount of bytes we point to\"\"\"\n return self._size\n\n def region(self):\n \"\"\":return: our mapped region, or None if nothing is mapped yet\n :raise AssertionError: if we have no current region. This is only useful for debugging\"\"\"\n return self._region\n\n def includes_ofs(self, ofs):\n \"\"\":return: True if the given absolute offset is contained in the cursors\n current region\n\n **Note:** cursor must be valid for this to work\"\"\"\n # unroll methods\n return (self._region._b + self._ofs) <= ofs < (self._region._b + self._ofs + self._size)\n\n def file_size(self):\n \"\"\":return: size of the underlying file\"\"\"\n return self._rlist.file_size()\n\n def path_or_fd(self):\n \"\"\":return: path or file descriptor of the underlying mapped file\"\"\"\n return self._rlist.path_or_fd()\n\n def path(self):\n \"\"\":return: path of the underlying mapped file\n :raise ValueError: if attached path is not a path\"\"\"\n if isinstance(self._rlist.path_or_fd(), int):\n raise ValueError(\"Path queried although mapping was applied to a file descriptor\")\n # END handle type\n return self._rlist.path_or_fd()\n\n def fd(self):\n \"\"\":return: file descriptor used to create the underlying mapping.\n\n **Note:** it is not required to be valid anymore\n :raise ValueError: if the mapping was not created by a file descriptor\"\"\"\n if isinstance(self._rlist.path_or_fd(), str):\n raise ValueError(\"File descriptor queried although mapping was generated from path\")\n # END handle type\n return self._rlist.path_or_fd()\n\n #} END interface\n\n\nclass StaticWindowMapManager:\n\n \"\"\"Provides a manager which will produce single size cursors that are allowed\n to always map the whole file.\n\n Clients must be written to specifically know that they are accessing their data\n through a StaticWindowMapManager, as they otherwise have to deal with their window size.\n\n These clients would have to use a SlidingWindowMapBuffer to hide this fact.\n\n This type will always use a maximum window size, and optimize certain methods to\n accommodate this fact\"\"\"\n\n __slots__ = [\n '_fdict', # mapping of path -> StorageHelper (of some kind\n '_window_size', # maximum size of a window\n '_max_memory_size', # maximum amount of memory we may allocate\n '_max_handle_count', # maximum amount of handles to keep open\n '_memory_size', # currently allocated memory size\n '_handle_count', # amount of currently allocated file handles\n ]\n\n #{ Configuration\n MapRegionListCls = MapRegionList\n MapWindowCls = MapWindow\n MapRegionCls = MapRegion\n WindowCursorCls = WindowCursor\n #} END configuration\n\n _MB_in_bytes = 1024 * 1024\n\n def __init__(self, window_size=0, max_memory_size=0, max_open_handles=sys.maxsize):\n \"\"\"initialize the manager with the given parameters.\n :param window_size: if -1, a default window size will be chosen depending on\n the operating system's architecture. It will internally be quantified to a multiple of the page size\n If 0, the window may have any size, which basically results in mapping the whole file at one\n :param max_memory_size: maximum amount of memory we may map at once before releasing mapped regions.\n If 0, a viable default will be set depending on the system's architecture.\n It is a soft limit that is tried to be kept, but nothing bad happens if we have to over-allocate\n :param max_open_handles: if not maxint, limit the amount of open file handles to the given number.\n Otherwise the amount is only limited by the system itself. If a system or soft limit is hit,\n the manager will free as many handles as possible\"\"\"\n self._fdict = dict()\n self._window_size = window_size\n self._max_memory_size = max_memory_size\n self._max_handle_count = max_open_handles\n self._memory_size = 0\n self._handle_count = 0\n\n if window_size < 0:\n coeff = 64\n if is_64_bit():\n coeff = 1024\n # END handle arch\n self._window_size = coeff * self._MB_in_bytes\n # END handle max window size\n\n if max_memory_size == 0:\n coeff = 1024\n if is_64_bit():\n coeff = 8192\n # END handle arch\n self._max_memory_size = coeff * self._MB_in_bytes\n # END handle max memory size\n\n #{ Internal Methods\n\n def _collect_lru_region(self, size):\n \"\"\"Unmap the region which was least-recently used and has no client\n :param size: size of the region we want to map next (assuming its not already mapped partially or full\n if 0, we try to free any available region\n :return: Amount of freed regions\n\n .. Note::\n We don't raise exceptions anymore, in order to keep the system working, allowing temporary overallocation.\n If the system runs out of memory, it will tell.\n\n .. TODO::\n implement a case where all unusued regions are discarded efficiently.\n Currently its only brute force\n \"\"\"\n num_found = 0\n while (size == 0) or (self._memory_size + size > self._max_memory_size):\n lru_region = None\n lru_list = None\n for regions in self._fdict.values():\n for region in regions:\n # check client count - if it's 1, it's just us\n if (region.client_count() == 1 and\n (lru_region is None or region._uc < lru_region._uc)):\n lru_region = region\n lru_list = regions\n # END update lru_region\n # END for each region\n # END for each regions list\n\n if lru_region is None:\n break\n # END handle region not found\n\n num_found += 1\n del(lru_list[lru_list.index(lru_region)])\n lru_region.increment_client_count(-1)\n self._memory_size -= lru_region.size()\n self._handle_count -= 1\n # END while there is more memory to free\n return num_found\n\n def _obtain_region(self, a, offset, size, flags, is_recursive):\n \"\"\"Utility to create a new region - for more information on the parameters,\n see MapCursor.use_region.\n :param a: A regions (a)rray\n :return: The newly created region\"\"\"\n if self._memory_size + size > self._max_memory_size:\n self._collect_lru_region(size)\n # END handle collection\n\n r = None\n if a:\n assert len(a) == 1\n r = a[0]\n else:\n try:\n r = self.MapRegionCls(a.path_or_fd(), 0, sys.maxsize, flags)\n except Exception:\n # apparently we are out of system resources or hit a limit\n # As many more operations are likely to fail in that condition (\n # like reading a file from disk, etc) we free up as much as possible\n # As this invalidates our insert position, we have to recurse here\n if is_recursive:\n # we already tried this, and still have no success in obtaining\n # a mapping. This is an exception, so we propagate it\n raise\n # END handle existing recursion\n self._collect_lru_region(0)\n return self._obtain_region(a, offset, size, flags, True)\n # END handle exceptions\n\n self._handle_count += 1\n self._memory_size += r.size()\n a.append(r)\n # END handle array\n\n assert r.includes_ofs(offset)\n return r\n\n #}END internal methods\n\n #{ Interface\n def make_cursor(self, path_or_fd):\n \"\"\"\n :return: a cursor pointing to the given path or file descriptor.\n It can be used to map new regions of the file into memory\n\n **Note:** if a file descriptor is given, it is assumed to be open and valid,\n but may be closed afterwards. To refer to the same file, you may reuse\n your existing file descriptor, but keep in mind that new windows can only\n be mapped as long as it stays valid. This is why the using actual file paths\n are preferred unless you plan to keep the file descriptor open.\n\n **Note:** file descriptors are problematic as they are not necessarily unique, as two\n different files opened and closed in succession might have the same file descriptor id.\n\n **Note:** Using file descriptors directly is faster once new windows are mapped as it\n prevents the file to be opened again just for the purpose of mapping it.\"\"\"\n regions = self._fdict.get(path_or_fd)\n if regions is None:\n regions = self.MapRegionListCls(path_or_fd)\n self._fdict[path_or_fd] = regions\n # END obtain region for path\n return self.WindowCursorCls(self, regions)\n\n def collect(self):\n \"\"\"Collect all available free-to-collect mapped regions\n :return: Amount of freed handles\"\"\"\n return self._collect_lru_region(0)\n\n def num_file_handles(self):\n \"\"\":return: amount of file handles in use. Each mapped region uses one file handle\"\"\"\n return self._handle_count\n\n def num_open_files(self):\n \"\"\"Amount of opened files in the system\"\"\"\n return reduce(lambda x, y: x + y, (1 for rlist in self._fdict.values() if len(rlist) > 0), 0)\n\n def window_size(self):\n \"\"\":return: size of each window when allocating new regions\"\"\"\n return self._window_size\n\n def mapped_memory_size(self):\n \"\"\":return: amount of bytes currently mapped in total\"\"\"\n return self._memory_size\n\n def max_file_handles(self):\n \"\"\":return: maximum amount of handles we may have opened\"\"\"\n return self._max_handle_count\n\n def max_mapped_memory_size(self):\n \"\"\":return: maximum amount of memory we may allocate\"\"\"\n return self._max_memory_size\n\n #} END interface\n\n #{ Special Purpose Interface\n\n def force_map_handle_removal_win(self, base_path):\n \"\"\"ONLY AVAILABLE ON WINDOWS\n On windows removing files is not allowed if anybody still has it opened.\n If this process is ourselves, and if the whole process uses this memory\n manager (as far as the parent framework is concerned) we can enforce\n closing all memory maps whose path matches the given base path to\n allow the respective operation after all.\n The respective system must NOT access the closed memory regions anymore !\n This really may only be used if you know that the items which keep\n the cursors alive will not be using it anymore. They need to be recreated !\n :return: Amount of closed handles\n\n **Note:** does nothing on non-windows platforms\"\"\"\n if sys.platform != 'win32':\n return\n # END early bailout\n\n num_closed = 0\n for path, rlist in self._fdict.items():\n if path.startswith(base_path):\n for region in rlist:\n region.release()\n num_closed += 1\n # END path matches\n # END for each path\n return num_closed\n #} END special purpose interface\n\n\nclass SlidingWindowMapManager(StaticWindowMapManager):\n\n \"\"\"Maintains a list of ranges of mapped memory regions in one or more files and allows to easily\n obtain additional regions assuring there is no overlap.\n Once a certain memory limit is reached globally, or if there cannot be more open file handles\n which result from each mmap call, the least recently used, and currently unused mapped regions\n are unloaded automatically.\n\n **Note:** currently not thread-safe !\n\n **Note:** in the current implementation, we will automatically unload windows if we either cannot\n create more memory maps (as the open file handles limit is hit) or if we have allocated more than\n a safe amount of memory already, which would possibly cause memory allocations to fail as our address\n space is full.\"\"\"\n\n __slots__ = tuple()\n\n def __init__(self, window_size=-1, max_memory_size=0, max_open_handles=sys.maxsize):\n \"\"\"Adjusts the default window size to -1\"\"\"\n super().__init__(window_size, max_memory_size, max_open_handles)\n\n def _obtain_region(self, a, offset, size, flags, is_recursive):\n # bisect to find an existing region. The c++ implementation cannot\n # do that as it uses a linked list for regions.\n r = None\n lo = 0\n hi = len(a)\n while lo < hi:\n mid = (lo + hi) // 2\n ofs = a[mid]._b\n if ofs <= offset:\n if a[mid].includes_ofs(offset):\n r = a[mid]\n break\n # END have region\n lo = mid + 1\n else:\n hi = mid\n # END handle position\n # END while bisecting\n\n if r is None:\n window_size = self._window_size\n left = self.MapWindowCls(0, 0)\n mid = self.MapWindowCls(offset, size)\n right = self.MapWindowCls(a.file_size(), 0)\n\n # we want to honor the max memory size, and assure we have anough\n # memory available\n # Save calls !\n if self._memory_size + window_size > self._max_memory_size:\n self._collect_lru_region(window_size)\n # END handle collection\n\n # we assume the list remains sorted by offset\n insert_pos = 0\n len_regions = len(a)\n if len_regions == 1:\n if a[0]._b <= offset:\n insert_pos = 1\n # END maintain sort\n else:\n # find insert position\n insert_pos = len_regions\n for i, region in enumerate(a):\n if region._b > offset:\n insert_pos = i\n break\n # END if insert position is correct\n # END for each region\n # END obtain insert pos\n\n # adjust the actual offset and size values to create the largest\n # possible mapping\n if insert_pos == 0:\n if len_regions:\n right = self.MapWindowCls.from_region(a[insert_pos])\n # END adjust right side\n else:\n if insert_pos != len_regions:\n right = self.MapWindowCls.from_region(a[insert_pos])\n # END adjust right window\n left = self.MapWindowCls.from_region(a[insert_pos - 1])\n # END adjust surrounding windows\n\n mid.extend_left_to(left, window_size)\n mid.extend_right_to(right, window_size)\n mid.align()\n\n # it can happen that we align beyond the end of the file\n if mid.ofs_end() > right.ofs:\n mid.size = right.ofs - mid.ofs\n # END readjust size\n\n # insert new region at the right offset to keep the order\n try:\n if self._handle_count >= self._max_handle_count:\n raise Exception\n # END assert own imposed max file handles\n r = self.MapRegionCls(a.path_or_fd(), mid.ofs, mid.size, flags)\n except Exception:\n # apparently we are out of system resources or hit a limit\n # As many more operations are likely to fail in that condition (\n # like reading a file from disk, etc) we free up as much as possible\n # As this invalidates our insert position, we have to recurse here\n if is_recursive:\n # we already tried this, and still have no success in obtaining\n # a mapping. This is an exception, so we propagate it\n raise\n # END handle existing recursion\n self._collect_lru_region(0)\n return self._obtain_region(a, offset, size, flags, True)\n # END handle exceptions\n\n self._handle_count += 1\n self._memory_size += r.size()\n a.insert(insert_pos, r)\n # END create new region\n return r\n\n[end of smmap/mman.py]","filename":"smmap/mman.py","id":"10"},{"content":"\"\"\"Module with a simple buffer implementation using the memory manager\"\"\"\nimport sys\n\n__all__ = [\"SlidingWindowMapBuffer\"]\n\n\nclass SlidingWindowMapBuffer:\n\n \"\"\"A buffer like object which allows direct byte-wise object and slicing into\n memory of a mapped file. The mapping is controlled by the provided cursor.\n\n The buffer is relative, that is if you map an offset, index 0 will map to the\n first byte at the offset you used during initialization or begin_access\n\n **Note:** Although this type effectively hides the fact that there are mapped windows\n underneath, it can unfortunately not be used in any non-pure python method which\n needs a buffer or string\"\"\"\n __slots__ = (\n '_c', # our cursor\n '_size', # our supposed size\n )\n\n def __init__(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\n \"\"\"Initialize the instance to operate on the given cursor.\n :param cursor: if not None, the associated cursor to the file you want to access\n If None, you have call begin_access before using the buffer and provide a cursor\n :param offset: absolute offset in bytes\n :param size: the total size of the mapping. Defaults to the maximum possible size\n From that point on, the __len__ of the buffer will be the given size or the file size.\n If the size is larger than the mappable area, you can only access the actually available\n area, although the length of the buffer is reported to be your given size.\n Hence it is in your own interest to provide a proper size !\n :param flags: Additional flags to be passed to os.open\n :raise ValueError: if the buffer could not achieve a valid state\"\"\"\n self._c = cursor\n if cursor and not self.begin_access(cursor, offset, size, flags):\n raise ValueError(\"Failed to allocate the buffer - probably the given offset is out of bounds\")\n # END handle offset\n\n def __del__(self):\n self.end_access()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self.end_access()\n\n def __len__(self):\n return self._size\n\n def __getitem__(self, i):\n if isinstance(i, slice):\n return self.__getslice__(i.start or 0, i.stop or self._size)\n c = self._c\n assert c.is_valid()\n if i < 0:\n i = self._size + i\n if not c.includes_ofs(i):\n c.use_region(i, 1)\n # END handle region usage\n return c.buffer()[i - c.ofs_begin()]\n\n def __getslice__(self, i, j):\n c = self._c\n # fast path, slice fully included - safes a concatenate operation and\n # should be the default\n assert c.is_valid()\n if i < 0:\n i = self._size + i\n if j == sys.maxsize:\n j = self._size\n if j < 0:\n j = self._size + j\n if (c.ofs_begin() <= i) and (j < c.ofs_end()):\n b = c.ofs_begin()\n return c.buffer()[i - b:j - b]\n else:\n l = j - i # total length\n ofs = i\n # It's fastest to keep tokens and join later, especially in py3, which was 7 times slower\n # in the previous iteration of this code\n md = list()\n while l:\n c.use_region(ofs, l)\n assert c.is_valid()\n d = c.buffer()[:l]\n ofs += len(d)\n l -= len(d)\n # Make sure we don't keep references, as c.use_region() might attempt to free resources, but\n # can't unless we use pure bytes\n if hasattr(d, 'tobytes'):\n d = d.tobytes()\n md.append(d)\n # END while there are bytes to read\n return b''.join(md)\n # END fast or slow path\n #{ Interface\n\n def begin_access(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\n \"\"\"Call this before the first use of this instance. The method was already\n called by the constructor in case sufficient information was provided.\n\n For more information no the parameters, see the __init__ method\n :param path: if cursor is None the existing one will be used.\n :return: True if the buffer can be used\"\"\"\n if cursor:\n self._c = cursor\n # END update our cursor\n\n # reuse existing cursors if possible\n if self._c is not None and self._c.is_associated():\n res = self._c.use_region(offset, size, flags).is_valid()\n if res:\n # if given size is too large or default, we computer a proper size\n # If its smaller, we assume the combination between offset and size\n # as chosen by the user is correct and use it !\n # If not, the user is in trouble.\n if size > self._c.file_size():\n size = self._c.file_size() - offset\n # END handle size\n self._size = size\n # END set size\n return res\n # END use our cursor\n return False\n\n def end_access(self):\n \"\"\"Call this method once you are done using the instance. It is automatically\n called on destruction, and should be called just in time to allow system\n resources to be freed.\n\n Once you called end_access, you must call begin access before reusing this instance!\"\"\"\n self._size = 0\n if self._c is not None:\n self._c.unuse_region()\n # END unuse region\n\n def cursor(self):\n \"\"\":return: the currently set cursor which provides access to the data\"\"\"\n return self._c\n\n #}END interface\n\n[end of smmap/buf.py]","filename":"smmap/buf.py","id":"11"},{"content":"\"\"\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\"\"\"\nimport os\nimport sys\n\nfrom mmap import mmap, ACCESS_READ\nfrom mmap import ALLOCATIONGRANULARITY\n\n__all__ = [\"align_to_mmap\", \"is_64_bit\",\n \"MapWindow\", \"MapRegion\", \"MapRegionList\", \"ALLOCATIONGRANULARITY\"]\n\n#{ Utilities\n\n\ndef align_to_mmap(num, round_up):\n \"\"\"\n Align the given integer number to the closest page offset, which usually is 4096 bytes.\n\n :param round_up: if True, the next higher multiple of page size is used, otherwise\n the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)\n :return: num rounded to closest page\"\"\"\n res = (num // ALLOCATIONGRANULARITY) * ALLOCATIONGRANULARITY\n if round_up and (res != num):\n res += ALLOCATIONGRANULARITY\n # END handle size\n return res\n\n\ndef is_64_bit():\n \"\"\":return: True if the system is 64 bit. Otherwise it can be assumed to be 32 bit\"\"\"\n return sys.maxsize > (1 << 32) - 1\n\n#}END utilities\n\n\n#{ Utility Classes\n\nclass MapWindow:\n\n \"\"\"Utility type which is used to snap windows towards each other, and to adjust their size\"\"\"\n __slots__ = (\n 'ofs', # offset into the file in bytes\n 'size' # size of the window in bytes\n )\n\n def __init__(self, offset, size):\n self.ofs = offset\n self.size = size\n\n def __repr__(self):\n return \"MapWindow(%i, %i)\" % (self.ofs, self.size)\n\n @classmethod\n def from_region(cls, region):\n \"\"\":return: new window from a region\"\"\"\n return cls(region._b, region.size())\n\n def ofs_end(self):\n return self.ofs + self.size\n\n def align(self):\n \"\"\"Assures the previous window area is contained in the new one\"\"\"\n nofs = align_to_mmap(self.ofs, 0)\n self.size += self.ofs - nofs # keep size constant\n self.ofs = nofs\n self.size = align_to_mmap(self.size, 1)\n\n def extend_left_to(self, window, max_size):\n \"\"\"Adjust the offset to start where the given window on our left ends if possible,\n but don't make yourself larger than max_size.\n The resize will assure that the new window still contains the old window area\"\"\"\n rofs = self.ofs - window.ofs_end()\n nsize = rofs + self.size\n rofs -= nsize - min(nsize, max_size)\n self.ofs -= rofs\n self.size += rofs\n\n def extend_right_to(self, window, max_size):\n \"\"\"Adjust the size to make our window end where the right window begins, but don't\n get larger than max_size\"\"\"\n self.size = min(self.size + (window.ofs - self.ofs_end()), max_size)\n\n\nclass MapRegion:\n\n \"\"\"Defines a mapped region of memory, aligned to pagesizes\n\n **Note:** deallocates used region automatically on destruction\"\"\"\n __slots__ = [\n '_b', # beginning of mapping\n '_mf', # mapped memory chunk (as returned by mmap)\n '_uc', # total amount of usages\n '_size', # cached size of our memory map\n '__weakref__'\n ]\n\n #{ Configuration\n #} END configuration\n\n def __init__(self, path_or_fd, ofs, size, flags=0):\n \"\"\"Initialize a region, allocate the memory map\n :param path_or_fd: path to the file to map, or the opened file descriptor\n :param ofs: **aligned** offset into the file to be mapped\n :param size: if size is larger then the file on disk, the whole file will be\n allocated the the size automatically adjusted\n :param flags: additional flags to be given when opening the file.\n :raise Exception: if no memory can be allocated\"\"\"\n self._b = ofs\n self._size = 0\n self._uc = 0\n\n if isinstance(path_or_fd, int):\n fd = path_or_fd\n else:\n fd = os.open(path_or_fd, os.O_RDONLY | getattr(os, 'O_BINARY', 0) | flags)\n # END handle fd\n\n try:\n kwargs = dict(access=ACCESS_READ, offset=ofs)\n corrected_size = size\n sizeofs = ofs\n\n # have to correct size, otherwise (instead of the c version) it will\n # bark that the size is too large ... many extra file accesses because\n # if this ... argh !\n actual_size = min(os.fstat(fd).st_size - sizeofs, corrected_size)\n self._mf = mmap(fd, actual_size, **kwargs)\n # END handle memory mode\n\n self._size = len(self._mf)\n finally:\n if isinstance(path_or_fd, str):\n os.close(fd)\n # END only close it if we opened it\n # END close file handle\n # We assume the first one to use us keeps us around\n self.increment_client_count()\n\n def __repr__(self):\n return \"MapRegion<%i, %i>\" % (self._b, self.size())\n\n #{ Interface\n\n def buffer(self):\n \"\"\":return: a buffer containing the memory\"\"\"\n return self._mf\n\n def map(self):\n \"\"\":return: a memory map containing the memory\"\"\"\n return self._mf\n\n def ofs_begin(self):\n \"\"\":return: absolute byte offset to the first byte of the mapping\"\"\"\n return self._b\n\n def size(self):\n \"\"\":return: total size of the mapped region in bytes\"\"\"\n return self._size\n\n def ofs_end(self):\n \"\"\":return: Absolute offset to one byte beyond the mapping into the file\"\"\"\n return self._b + self._size\n\n def includes_ofs(self, ofs):\n \"\"\":return: True if the given offset can be read in our mapped region\"\"\"\n return self._b <= ofs < self._b + self._size\n\n def client_count(self):\n \"\"\":return: number of clients currently using this region\"\"\"\n return self._uc\n\n def increment_client_count(self, ofs = 1):\n \"\"\"Adjust the usage count by the given positive or negative offset.\n If usage count equals 0, we will auto-release our resources\n :return: True if we released resources, False otherwise. In the latter case, we can still be used\"\"\"\n self._uc += ofs\n assert self._uc > -1, \"Increments must match decrements, usage counter negative: %i\" % self._uc\n\n if self.client_count() == 0:\n self.release()\n return True\n else:\n return False\n # end handle release\n\n def release(self):\n \"\"\"Release all resources this instance might hold. Must only be called if there usage_count() is zero\"\"\"\n self._mf.close()\n\n #} END interface\n\n\nclass MapRegionList(list):\n\n \"\"\"List of MapRegion instances associating a path with a list of regions.\"\"\"\n __slots__ = (\n '_path_or_fd', # path or file descriptor which is mapped by all our regions\n '_file_size' # total size of the file we map\n )\n\n def __new__(cls, path):\n return super().__new__(cls)\n\n def __init__(self, path_or_fd):\n self._path_or_fd = path_or_fd\n self._file_size = None\n\n def path_or_fd(self):\n \"\"\":return: path or file descriptor we are attached to\"\"\"\n return self._path_or_fd\n\n def file_size(self):\n \"\"\":return: size of file we manager\"\"\"\n if self._file_size is None:\n if isinstance(self._path_or_fd, str):\n self._file_size = os.stat(self._path_or_fd).st_size\n else:\n self._file_size = os.fstat(self._path_or_fd).st_size\n # END handle path type\n # END update file size\n return self._file_size\n\n#} END utility classes\n\n[end of smmap/util.py]","filename":"smmap/util.py","id":"12"},{"content":"\"\"\"Initialize the smmap package\"\"\"\n\n__author__ = \"Sebastian Thiel\"\n__contact__ = \"byronimo@gmail.com\"\n__homepage__ = \"https://github.com/gitpython-developers/smmap\"\nversion_info = (5, 0, 2)\n__version__ = '.'.join(str(i) for i in version_info)\n\n# make everything available in root package for convenience\nfrom .mman import *\nfrom .buf import *\n\n[end of smmap/__init__.py]","filename":"smmap/__init__.py","id":"13"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = build\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\n\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\t-rm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make all-pdf' or \\`make all-ps' in that directory to\" \\\n\t \"run these through (pdf)latex.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\n[end of doc/Makefile]","filename":"doc/Makefile","id":"14"},{"content":"@ECHO OFF\n\nREM Command file for Sphinx documentation\n\nset SPHINXBUILD=sphinx-build\nset BUILDDIR=build\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\nif NOT \"%PAPER%\" == \"\" (\n\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\n)\n\nif \"%1\" == \"\" goto help\n\nif \"%1\" == \"help\" (\n\t:help\n\techo.Please use `make ^<target^>` where ^<target^> is one of\n\techo. html to make standalone HTML files\n\techo. dirhtml to make HTML files named index.html in directories\n\techo. pickle to make pickle files\n\techo. json to make JSON files\n\techo. htmlhelp to make HTML files and a HTML help project\n\techo. qthelp to make HTML files and a qthelp project\n\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\n\techo. changes to make an overview over all changed/added/deprecated items\n\techo. linkcheck to check all external links for integrity\n\techo. doctest to run all doctests embedded in the documentation if enabled\n\tgoto end\n)\n\nif \"%1\" == \"clean\" (\n\tfor /d %%i in (%BUILDDIR%\\*) do rmdir /q /s %%i\n\tdel /q /s %BUILDDIR%\\*\n\tgoto end\n)\n\nif \"%1\" == \"html\" (\n\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\n\tgoto end\n)\n\nif \"%1\" == \"dirhtml\" (\n\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\n\techo.\n\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\n\tgoto end\n)\n\nif \"%1\" == \"pickle\" (\n\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\n\techo.\n\techo.Build finished; now you can process the pickle files.\n\tgoto end\n)\n\nif \"%1\" == \"json\" (\n\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\n\techo.\n\techo.Build finished; now you can process the JSON files.\n\tgoto end\n)\n\nif \"%1\" == \"htmlhelp\" (\n\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\n\techo.\n\techo.Build finished; now you can run HTML Help Workshop with the ^\n.hhp project file in %BUILDDIR%/htmlhelp.\n\tgoto end\n)\n\nif \"%1\" == \"qthelp\" (\n\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\n\techo.\n\techo.Build finished; now you can run \"qcollectiongenerator\" with the ^\n.qhcp project file in %BUILDDIR%/qthelp, like this:\n\techo.^> qcollectiongenerator %BUILDDIR%\\qthelp\\smmap.qhcp\n\techo.To view the help file:\n\techo.^> assistant -collectionFile %BUILDDIR%\\qthelp\\smmap.ghc\n\tgoto end\n)\n\nif \"%1\" == \"latex\" (\n\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\n\techo.\n\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\n\tgoto end\n)\n\nif \"%1\" == \"changes\" (\n\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\n\techo.\n\techo.The overview file is in %BUILDDIR%/changes.\n\tgoto end\n)\n\nif \"%1\" == \"linkcheck\" (\n\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\n\techo.\n\techo.Link check complete; look for any errors in the above output ^\nor in %BUILDDIR%/linkcheck/output.txt.\n\tgoto end\n)\n\nif \"%1\" == \"doctest\" (\n\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\n\techo.\n\techo.Testing of doctests in the sources finished, look at the ^\nresults in %BUILDDIR%/doctest/output.txt.\n\tgoto end\n)\n\n:end\n\n[end of doc/make.bat]","filename":"doc/make.bat","id":"15"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.mman import (\n WindowCursor,\n SlidingWindowMapManager,\n StaticWindowMapManager\n)\nfrom smmap.util import align_to_mmap\n\nfrom random import randint\nfrom time import time\nimport os\nimport sys\nfrom copy import copy\n\n\nclass TestMMan(TestBase):\n\n def test_cursor(self):\n with FileCreator(self.k_window_test_size, \"cursor_test\") as fc:\n man = SlidingWindowMapManager()\n ci = WindowCursor(man) # invalid cursor\n assert not ci.is_valid()\n assert not ci.is_associated()\n assert ci.size() == 0 # this is cached, so we can query it in invalid state\n\n cv = man.make_cursor(fc.path)\n assert not cv.is_valid() # no region mapped yet\n assert cv.is_associated() # but it know where to map it from\n assert cv.file_size() == fc.size\n assert cv.path() == fc.path\n\n # copy module\n cio = copy(cv)\n assert not cio.is_valid() and cio.is_associated()\n\n # assign method\n assert not ci.is_associated()\n ci.assign(cv)\n assert not ci.is_valid() and ci.is_associated()\n\n # unuse non-existing region is fine\n cv.unuse_region()\n cv.unuse_region()\n\n # destruction is fine (even multiple times)\n cv._destroy()\n WindowCursor(man)._destroy()\n\n def test_memory_manager(self):\n slide_man = SlidingWindowMapManager()\n static_man = StaticWindowMapManager()\n\n for man in (static_man, slide_man):\n assert man.num_file_handles() == 0\n assert man.num_open_files() == 0\n winsize_cmp_val = 0\n if isinstance(man, StaticWindowMapManager):\n winsize_cmp_val = -1\n # END handle window size\n assert man.window_size() > winsize_cmp_val\n assert man.mapped_memory_size() == 0\n assert man.max_mapped_memory_size() > 0\n\n # collection doesn't raise in 'any' mode\n man._collect_lru_region(0)\n # doesn't raise if we are within the limit\n man._collect_lru_region(10)\n\n # doesn't fail if we over-allocate\n assert man._collect_lru_region(sys.maxsize) == 0\n\n # use a region, verify most basic functionality\n with FileCreator(self.k_window_test_size, \"manager_test\") as fc:\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n for item in (fc.path, fd):\n c = man.make_cursor(item)\n assert c.path_or_fd() is item\n assert c.use_region(10, 10).is_valid()\n assert c.ofs_begin() == 10\n assert c.size() == 10\n with open(fc.path, 'rb') as fp:\n assert c.buffer()[:] == fp.read(20)[10:]\n\n if isinstance(item, int):\n self.assertRaises(ValueError, c.path)\n else:\n self.assertRaises(ValueError, c.fd)\n # END handle value error\n # END for each input\n finally:\n os.close(fd)\n # END for each manasger type\n\n def test_memman_operation(self):\n # test more access, force it to actually unmap regions\n with FileCreator(self.k_window_test_size, \"manager_operation_test\") as fc:\n with open(fc.path, 'rb') as fp:\n data = fp.read()\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n max_num_handles = 15\n # small_size =\n for mtype, args in ((StaticWindowMapManager, (0, fc.size // 3, max_num_handles)),\n (SlidingWindowMapManager, (fc.size // 100, fc.size // 3, max_num_handles)),):\n for item in (fc.path, fd):\n assert len(data) == fc.size\n\n # small windows, a reasonable max memory. Not too many regions at once\n man = mtype(window_size=args[0], max_memory_size=args[1], max_open_handles=args[2])\n c = man.make_cursor(item)\n\n # still empty (more about that is tested in test_memory_manager()\n assert man.num_open_files() == 0\n assert man.mapped_memory_size() == 0\n\n base_offset = 5000\n # window size is 0 for static managers, hence size will be 0. We take that into consideration\n size = man.window_size() // 2\n assert c.use_region(base_offset, size).is_valid()\n rr = c.region()\n assert rr.client_count() == 2 # the manager and the cursor and us\n\n assert man.num_open_files() == 1\n assert man.num_file_handles() == 1\n assert man.mapped_memory_size() == rr.size()\n\n # assert c.size() == size # the cursor may overallocate in its static version\n assert c.ofs_begin() == base_offset\n assert rr.ofs_begin() == 0 # it was aligned and expanded\n if man.window_size():\n # but isn't larger than the max window (aligned)\n assert rr.size() == align_to_mmap(man.window_size(), True)\n else:\n assert rr.size() == fc.size\n # END ignore static managers which dont use windows and are aligned to file boundaries\n\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\n\n # obtain second window, which spans the first part of the file - it is a still the same window\n nsize = (size or fc.size) - 10\n assert c.use_region(0, nsize).is_valid()\n assert c.region() == rr\n assert man.num_file_handles() == 1\n assert c.size() == nsize\n assert c.ofs_begin() == 0\n assert c.buffer()[:] == data[:nsize]\n\n # map some part at the end, our requested size cannot be kept\n overshoot = 4000\n base_offset = fc.size - (size or c.size()) + overshoot\n assert c.use_region(base_offset, size).is_valid()\n if man.window_size():\n assert man.num_file_handles() == 2\n assert c.size() < size\n assert c.region() is not rr # old region is still available, but has not cursor ref anymore\n assert rr.client_count() == 1 # only held by manager\n else:\n assert c.size() < fc.size\n # END ignore static managers which only have one handle per file\n rr = c.region()\n assert rr.client_count() == 2 # manager + cursor\n assert rr.ofs_begin() < c.ofs_begin() # it should have extended itself to the left\n assert rr.ofs_end() <= fc.size # it cannot be larger than the file\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\n\n # unising a region makes the cursor invalid\n c.unuse_region()\n assert not c.is_valid()\n if man.window_size():\n # but doesn't change anything regarding the handle count - we cache it and only\n # remove mapped regions if we have to\n assert man.num_file_handles() == 2\n # END ignore this for static managers\n\n # iterate through the windows, verify data contents\n # this will trigger map collection after a while\n max_random_accesses = 5000\n num_random_accesses = max_random_accesses\n memory_read = 0\n st = time()\n\n # cache everything to get some more performance\n includes_ofs = c.includes_ofs\n max_mapped_memory_size = man.max_mapped_memory_size()\n max_file_handles = man.max_file_handles()\n mapped_memory_size = man.mapped_memory_size\n num_file_handles = man.num_file_handles\n while num_random_accesses:\n num_random_accesses -= 1\n base_offset = randint(0, fc.size - 1)\n\n # precondition\n if man.window_size():\n assert max_mapped_memory_size >= mapped_memory_size()\n # END statistics will overshoot, which is fine\n assert max_file_handles >= num_file_handles()\n assert c.use_region(base_offset, (size or c.size())).is_valid()\n csize = c.size()\n assert c.buffer()[:] == data[base_offset:base_offset + csize]\n memory_read += csize\n\n assert includes_ofs(base_offset)\n assert includes_ofs(base_offset + csize - 1)\n assert not includes_ofs(base_offset + csize)\n # END while we should do an access\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\n mb = float(1000 * 1000)\n print(\"%s: Read %i mb of memory with %i random on cursor initialized with %s accesses in %fs (%f mb/s)\\n\"\n % (mtype, memory_read / mb, max_random_accesses, type(item), elapsed, (memory_read / mb) / elapsed),\n file=sys.stderr)\n\n # an offset as large as the size doesn't work !\n assert not c.use_region(fc.size, size).is_valid()\n\n # collection - it should be able to collect all\n assert man.num_file_handles()\n assert man.collect()\n assert man.num_file_handles() == 0\n # END for each item\n # END for each manager type\n finally:\n os.close(fd)\n\n[end of smmap/test/test_mman.py]","filename":"smmap/test/test_mman.py","id":"16"},{"content":"\"\"\"Provide base classes for the test system\"\"\"\nfrom unittest import TestCase\nimport os\nimport tempfile\n\n__all__ = ['TestBase', 'FileCreator']\n\n\n#{ Utilities\n\nclass FileCreator:\n\n \"\"\"A instance which creates a temporary file with a prefix and a given size\n and provides this info to the user.\n Once it gets deleted, it will remove the temporary file as well.\"\"\"\n __slots__ = (\"_size\", \"_path\")\n\n def __init__(self, size, prefix=''):\n assert size, \"Require size to be larger 0\"\n\n self._size = size\n\n with tempfile.NamedTemporaryFile(\"wb\", prefix=prefix, delete=False) as file:\n self._path = file.name\n file.seek(size - 1)\n file.write(b'1')\n\n assert os.path.getsize(self.path) == size\n\n def __del__(self):\n try:\n os.remove(self.path)\n except OSError:\n pass\n # END exception handling\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n self.__del__()\n\n @property\n def path(self):\n return self._path\n\n @property\n def size(self):\n return self._size\n\n#} END utilities\n\n\nclass TestBase(TestCase):\n\n \"\"\"Foundation used by all tests\"\"\"\n\n #{ Configuration\n k_window_test_size = 1000 * 1000 * 8 + 5195\n #} END configuration\n\n #{ Overrides\n @classmethod\n def setUpAll(cls):\n # nothing for now\n pass\n\n # END overrides\n\n #{ Interface\n\n #} END interface\n\n[end of smmap/test/lib.py]","filename":"smmap/test/lib.py","id":"17"},{"content":"[end of smmap/test/__init__.py]","filename":"smmap/test/__init__.py","id":"18"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.mman import (\n SlidingWindowMapManager,\n StaticWindowMapManager\n)\nfrom smmap.buf import SlidingWindowMapBuffer\n\nfrom random import randint\nfrom time import time\nimport sys\nimport os\n\n\nman_optimal = SlidingWindowMapManager()\nman_worst_case = SlidingWindowMapManager(\n window_size=TestBase.k_window_test_size // 100,\n max_memory_size=TestBase.k_window_test_size // 3,\n max_open_handles=15)\nstatic_man = StaticWindowMapManager()\n\n\nclass TestBuf(TestBase):\n\n def test_basics(self):\n with FileCreator(self.k_window_test_size, \"buffer_test\") as fc:\n\n # invalid paths fail upon construction\n c = man_optimal.make_cursor(fc.path)\n self.assertRaises(ValueError, SlidingWindowMapBuffer, type(c)()) # invalid cursor\n self.assertRaises(ValueError, SlidingWindowMapBuffer, c, fc.size) # offset too large\n\n buf = SlidingWindowMapBuffer() # can create uninitialized buffers\n assert buf.cursor() is None\n\n # can call end access any time\n buf.end_access()\n buf.end_access()\n assert len(buf) == 0\n\n # begin access can revive it, if the offset is suitable\n offset = 100\n assert buf.begin_access(c, fc.size) == False\n assert buf.begin_access(c, offset) == True\n assert len(buf) == fc.size - offset\n assert buf.cursor().is_valid()\n\n # empty begin access keeps it valid on the same path, but alters the offset\n assert buf.begin_access() == True\n assert len(buf) == fc.size\n assert buf.cursor().is_valid()\n\n # simple access\n with open(fc.path, 'rb') as fp:\n data = fp.read()\n assert data[offset] == buf[0]\n assert data[offset:offset * 2] == buf[0:offset]\n\n # negative indices, partial slices\n assert buf[-1] == buf[len(buf) - 1]\n assert buf[-10:] == buf[len(buf) - 10:len(buf)]\n\n # end access makes its cursor invalid\n buf.end_access()\n assert not buf.cursor().is_valid()\n assert buf.cursor().is_associated() # but it remains associated\n\n # an empty begin access fixes it up again\n assert buf.begin_access() == True and buf.cursor().is_valid()\n del(buf) # ends access automatically\n del(c)\n\n assert man_optimal.num_file_handles() == 1\n\n # PERFORMANCE\n # blast away with random access and a full mapping - we don't want to\n # exaggerate the manager's overhead, but measure the buffer overhead\n # We do it once with an optimal setting, and with a worse manager which\n # will produce small mappings only !\n max_num_accesses = 100\n fd = os.open(fc.path, os.O_RDONLY)\n for item in (fc.path, fd):\n for manager, man_id in ((man_optimal, 'optimal'),\n (man_worst_case, 'worst case'),\n (static_man, 'static optimal')):\n buf = SlidingWindowMapBuffer(manager.make_cursor(item))\n assert manager.num_file_handles() == 1\n for access_mode in range(2): # single, multi\n num_accesses_left = max_num_accesses\n num_bytes = 0\n fsize = fc.size\n\n st = time()\n buf.begin_access()\n while num_accesses_left:\n num_accesses_left -= 1\n if access_mode: # multi\n ofs_start = randint(0, fsize)\n ofs_end = randint(ofs_start, fsize)\n d = buf[ofs_start:ofs_end]\n assert len(d) == ofs_end - ofs_start\n assert d == data[ofs_start:ofs_end]\n num_bytes += len(d)\n del d\n else:\n pos = randint(0, fsize)\n assert buf[pos] == data[pos]\n num_bytes += 1\n # END handle mode\n # END handle num accesses\n\n buf.end_access()\n assert manager.num_file_handles()\n assert manager.collect()\n assert manager.num_file_handles() == 0\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\n mb = float(1000 * 1000)\n mode_str = (access_mode and \"slice\") or \"single byte\"\n print(\"%s: Made %i random %s accesses to buffer created from %s reading a total of %f mb in %f s (%f mb/s)\"\n % (man_id, max_num_accesses, mode_str, type(item), num_bytes / mb, elapsed, (num_bytes / mb) / elapsed),\n file=sys.stderr)\n # END handle access mode\n del buf\n # END for each manager\n # END for each input\n os.close(fd)\n\n[end of smmap/test/test_buf.py]","filename":"smmap/test/test_buf.py","id":"19"},{"content":"from .lib import TestBase, FileCreator\n\nfrom smmap.util import (\n MapWindow,\n MapRegion,\n MapRegionList,\n ALLOCATIONGRANULARITY,\n is_64_bit,\n align_to_mmap\n)\n\nimport os\nimport sys\n\n\nclass TestMMan(TestBase):\n\n def test_window(self):\n wl = MapWindow(0, 1) # left\n wc = MapWindow(1, 1) # center\n wc2 = MapWindow(10, 5) # another center\n wr = MapWindow(8000, 50) # right\n\n assert wl.ofs_end() == 1\n assert wc.ofs_end() == 2\n assert wr.ofs_end() == 8050\n\n # extension does nothing if already in place\n maxsize = 100\n wc.extend_left_to(wl, maxsize)\n assert wc.ofs == 1 and wc.size == 1\n wl.extend_right_to(wc, maxsize)\n wl.extend_right_to(wc, maxsize)\n assert wl.ofs == 0 and wl.size == 1\n\n # an actual left extension\n pofs_end = wc2.ofs_end()\n wc2.extend_left_to(wc, maxsize)\n assert wc2.ofs == wc.ofs_end() and pofs_end == wc2.ofs_end()\n\n # respects maxsize\n wc.extend_right_to(wr, maxsize)\n assert wc.ofs == 1 and wc.size == maxsize\n wc.extend_right_to(wr, maxsize)\n assert wc.ofs == 1 and wc.size == maxsize\n\n # without maxsize\n wc.extend_right_to(wr, sys.maxsize)\n assert wc.ofs_end() == wr.ofs and wc.ofs == 1\n\n # extend left\n wr.extend_left_to(wc2, maxsize)\n wr.extend_left_to(wc2, maxsize)\n assert wr.size == maxsize\n\n wr.extend_left_to(wc2, sys.maxsize)\n assert wr.ofs == wc2.ofs_end()\n\n wc.align()\n assert wc.ofs == 0 and wc.size == align_to_mmap(wc.size, True)\n\n def test_region(self):\n with FileCreator(self.k_window_test_size, \"window_test\") as fc:\n half_size = fc.size // 2\n rofs = align_to_mmap(4200, False)\n rfull = MapRegion(fc.path, 0, fc.size)\n rhalfofs = MapRegion(fc.path, rofs, fc.size)\n rhalfsize = MapRegion(fc.path, 0, half_size)\n\n # offsets\n assert rfull.ofs_begin() == 0 and rfull.size() == fc.size\n assert rfull.ofs_end() == fc.size # if this method works, it works always\n\n assert rhalfofs.ofs_begin() == rofs and rhalfofs.size() == fc.size - rofs\n assert rhalfsize.ofs_begin() == 0 and rhalfsize.size() == half_size\n\n assert rfull.includes_ofs(0) and rfull.includes_ofs(fc.size - 1) and rfull.includes_ofs(half_size)\n assert not rfull.includes_ofs(-1) and not rfull.includes_ofs(sys.maxsize)\n\n # auto-refcount\n assert rfull.client_count() == 1\n rfull2 = rfull\n assert rfull.client_count() == 1, \"no auto-counting\"\n\n # window constructor\n w = MapWindow.from_region(rfull)\n assert w.ofs == rfull.ofs_begin() and w.ofs_end() == rfull.ofs_end()\n\n def test_region_list(self):\n with FileCreator(100, \"sample_file\") as fc:\n fd = os.open(fc.path, os.O_RDONLY)\n try:\n for item in (fc.path, fd):\n ml = MapRegionList(item)\n\n assert len(ml) == 0\n assert ml.path_or_fd() == item\n assert ml.file_size() == fc.size\n finally:\n os.close(fd)\n\n def test_util(self):\n assert isinstance(is_64_bit(), bool) # just call it\n assert align_to_mmap(1, False) == 0\n assert align_to_mmap(1, True) == ALLOCATIONGRANULARITY\n\n[end of smmap/test/test_util.py]","filename":"smmap/test/test_util.py","id":"20"},{"content":"from .lib import TestBase\n\n\nclass TestTutorial(TestBase):\n\n def test_example(self):\n # Memory Managers\n ##################\n import smmap\n # This instance should be globally available in your application\n # It is configured to be well suitable for 32-bit or 64 bit applications.\n mman = smmap.SlidingWindowMapManager()\n\n # the manager provides much useful information about its current state\n # like the amount of open file handles or the amount of mapped memory\n assert mman.num_file_handles() == 0\n assert mman.mapped_memory_size() == 0\n # and many more ...\n\n # Cursors\n ##########\n import smmap.test.lib\n with smmap.test.lib.FileCreator(1024 * 1024 * 8, \"test_file\") as fc:\n # obtain a cursor to access some file.\n c = mman.make_cursor(fc.path)\n\n # the cursor is now associated with the file, but not yet usable\n assert c.is_associated()\n assert not c.is_valid()\n\n # before you can use the cursor, you have to specify a window you want to\n # access. The following just says you want as much data as possible starting\n # from offset 0.\n # To be sure your region could be mapped, query for validity\n assert c.use_region().is_valid() # use_region returns self\n\n # once a region was mapped, you must query its dimension regularly\n # to assure you don't try to access its buffer out of its bounds\n assert c.size()\n c.buffer()[0] # first byte\n c.buffer()[1:10] # first 9 bytes\n c.buffer()[c.size() - 1] # last byte\n\n # you can query absolute offsets, and check whether an offset is included\n # in the cursor's data.\n assert c.ofs_begin() < c.ofs_end()\n assert c.includes_ofs(100)\n\n # If you are over out of bounds with one of your region requests, the\n # cursor will be come invalid. It cannot be used in that state\n assert not c.use_region(fc.size, 100).is_valid()\n # map as much as possible after skipping the first 100 bytes\n assert c.use_region(100).is_valid()\n\n # You can explicitly free cursor resources by unusing the cursor's region\n c.unuse_region()\n assert not c.is_valid()\n\n # Buffers\n #########\n # Create a default buffer which can operate on the whole file\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\n\n # you can use it right away\n assert buf.cursor().is_valid()\n\n buf[0] # access the first byte\n buf[-1] # access the last ten bytes on the file\n buf[-10:] # access the last ten bytes\n\n # If you want to keep the instance between different accesses, use the\n # dedicated methods\n buf.end_access()\n assert not buf.cursor().is_valid() # you cannot use the buffer anymore\n assert buf.begin_access(offset=10) # start using the buffer at an offset\n\n[end of smmap/test/test_tutorial.py]","filename":"smmap/test/test_tutorial.py","id":"21"},{"content":".. smmap documentation master file, created by\n sphinx-quickstart on Wed Jun 8 15:14:25 2011.\n You can adapt this file completely to your liking, but it should at least\n contain the root `toctree` directive.\n\nWelcome to smmap's documentation!\n=================================\n**smmap** is a pure python implementation of a sliding memory map to help unifying memory mapped access on 32 and 64 bit systems and to help managing resources more efficiently.\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n \n intro\n tutorial\n api\n changes\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of doc/source/index.rst]","filename":"doc/source/index.rst","id":"22"},{"content":"###########\nMotivation\n###########\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\n\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\n\n########\nOverview\n########\n\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\n\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\n\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\n\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\n\n#############\nPrerequisites\n#############\n* Python 3.7+\n* OSX, Windows or Linux\n\nThe package was tested on all of the previously mentioned configurations.\n\n###########\nLimitations\n###########\n* The memory access is read-only by design.\n\n################\nInstalling smmap\n################\nIts easiest to install smmap using the *pip* program::\n \n $ pip install smmap\n \nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\n\nIf you have downloaded the source archive, the package can be installed by running the ``setup.py`` script::\n \n $ python setup.py install\n\nIt is advised to have a look at the :ref:`Usage Guide <tutorial-label>` for a brief introduction on the different database implementations.\n\n##################\nHomepage and Links\n##################\nThe project is home on github at `https://github.com/gitpython-developers/smmap <https://github.com/gitpython-developers/smmap>`_.\n\nThe latest source can be cloned from github as well:\n\n * git://github.com/gitpython-developers/smmap.git\n \n \nFor support, please use the git-python mailing list:\n\n * http://groups.google.com/group/git-python\n \n\nIssues can be filed on github:\n\n * https://github.com/gitpython-developers/smmap/issues\n \n###################\nLicense Information\n###################\n*smmap* is licensed under the New BSD License.\n\n.. _pip: http://www.pip-installer.org/en/latest/\n\n[end of doc/source/intro.rst]","filename":"doc/source/intro.rst","id":"23"},{"content":"#\n# smmap documentation build configuration file, created by\n# sphinx-quickstart on Wed Jun 8 15:14:25 2011.\n#\n# This file is execfile()d with the current directory set to its containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.append(os.path.abspath('../../'))\n\n# -- General configuration -----------------------------------------------------\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['.templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'smmap'\ncopyright = '2011, Sebastian Thiel'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.8.0'\n# The full version, including alpha/beta/rc tags.\nrelease = '0.8.0'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of documents that shouldn't be included in the build.\n#unused_docs = []\n\n# List of directories, relative to source directory, that shouldn't be searched\n# for source files.\nexclude_trees = []\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. Major themes that come with\n# Sphinx are currently 'default' and 'sphinxdoc'.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['.static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_use_modindex = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# If nonempty, this is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = ''\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'smmapdoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\n# The paper size ('letter' or 'a4').\n#latex_paper_size = 'letter'\n\n# The font size ('10pt', '11pt' or '12pt').\n#latex_font_size = '10pt'\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'smmap.tex', 'smmap Documentation',\n 'Sebastian Thiel', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# Additional stuff for the LaTeX preamble.\n#latex_preamble = ''\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_use_modindex = True\n\n[end of doc/source/conf.py]","filename":"doc/source/conf.py","id":"24"},{"content":".. _tutorial-label:\n\n###########\nUsage Guide\n###########\nThis text briefly introduces you to the basic design decisions and accompanying classes.\n\n******\nDesign\n******\nPer application, there is *MemoryManager* which is held as static instance and used throughout the application. It can be configured to keep your resources within certain limits.\n\nTo access mapped regions, you require a cursor. Cursors point to exactly one file and serve as handles into it. As long as it exists, the respective memory region will remain available.\n\nFor convenience, a buffer implementation is provided which handles cursors and resource allocation behind its simple buffer like interface.\n\n***************\nMemory Managers\n***************\nThere are two types of memory managers, one uses *static* windows, the other one uses *sliding* windows. A window is a region of a file mapped into memory. Although the names might be somewhat misleading as technically windows are always static, the *sliding* version will allocate relatively small windows whereas the *static* version will always map the whole file.\n\nThe *static* manager does nothing more than keeping a client count on the respective memory maps which always map the whole file, which allows to make some assumptions that can lead to simplified data access and increased performance, but reduces the compatibility to 32 bit systems or giant files.\n\nThe *sliding* memory manager therefore should be the default manager when preparing an application for handling huge amounts of data on 32 bit and 64 bit platforms::\n\n import smmap\n # This instance should be globally available in your application\n # It is configured to be well suitable for 32-bit or 64 bit applications.\n mman = smmap.SlidingWindowMapManager()\n \n # the manager provides much useful information about its current state\n # like the amount of open file handles or the amount of mapped memory\n mman.num_file_handles()\n mman.mapped_memory_size()\n # and many more ...\n\n\nCursors\n*******\n*Cursors* are handles that point onto a window, i.e. a region of a file mapped into memory. From them you may obtain a buffer through which the data of that window can actually be accessed::\n\n import smmap.test.lib\n fc = smmap.test.lib.FileCreator(1024*1024*8, \"test_file\")\n \n # obtain a cursor to access some file.\n c = mman.make_cursor(fc.path)\n \n # the cursor is now associated with the file, but not yet usable\n assert c.is_associated()\n assert not c.is_valid()\n \n # before you can use the cursor, you have to specify a window you want to \n # access. The following just says you want as much data as possible starting\n # from offset 0.\n # To be sure your region could be mapped, query for validity\n assert c.use_region().is_valid()\t\t# use_region returns self\n \n # once a region was mapped, you must query its dimension regularly\n # to assure you don't try to access its buffer out of its bounds\n assert c.size()\n c.buffer()[0]\t\t\t# first byte\n c.buffer()[1:10]\t\t\t# first 9 bytes\n c.buffer()[c.size()-1] \t# last byte\n \n # its recommended not to create big slices when feeding the buffer\n # into consumers (e.g. struct or zlib). \n # Instead, either give the buffer directly, or use pythons buffer command.\n buffer(c.buffer(), 1, 9)\t# first 9 bytes without copying them\n \n # you can query absolute offsets, and check whether an offset is included\n # in the cursor's data.\n assert c.ofs_begin() < c.ofs_end()\n assert c.includes_ofs(100)\n \n # If you are over out of bounds with one of your region requests, the \n # cursor will be come invalid. It cannot be used in that state\n assert not c.use_region(fc.size, 100).is_valid()\n # map as much as possible after skipping the first 100 bytes\n assert c.use_region(100).is_valid()\n \n # You can explicitly free cursor resources by unusing the cursor's region\n c.unuse_region()\n assert not c.is_valid()\n \n\nNow you would have to write your algorithms around this interface to properly slide through huge amounts of data. \n \nAlternatively you can use a convenience interface.\n\n*******\nBuffers\n*******\nTo make first use easier, at the expense of performance, there is a Buffer implementation which uses a cursor underneath.\n\nWith it, you can access all data in a possibly huge file without having to take care of setting the cursor to different regions yourself::\n\n # Create a default buffer which can operate on the whole file\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\n \n # you can use it right away\n assert buf.cursor().is_valid()\n \n buf[0]\t# access the first byte\n buf[-1]\t# access the last ten bytes on the file\n buf[-10:]# access the last ten bytes\n \n # If you want to keep the instance between different accesses, use the\n # dedicated methods\n buf.end_access()\n assert not buf.cursor().is_valid()\t# you cannot use the buffer anymore\n assert buf.begin_access(offset=10)\t# start using the buffer at an offset\n \n # it will stop using resources automatically once it goes out of scope\n \nDisadvantages\n*************\nBuffers cannot be used in place of strings or maps, hence you have to slice them to have valid input for the sorts of struct and zlib. A slice means a lot of data handling overhead which makes buffers slower compared to using cursors directly. \n\n\n[end of doc/source/tutorial.rst]","filename":"doc/source/tutorial.rst","id":"25"},{"content":"#########\nChangelog\n#########\n\n******\nv5.0.2\n******\n\n- remove a usage of mktemp\n\n******\nv5.0.1\n******\n\n- Added support for Python 3.12\n\n******\nv6.0.0\n******\n\nYANKED\n\n- Dropped support 3.6 and 3.7\n- Declared support for Python 3.11 and 3.12\n\n******\nv5.0.0\n******\n\n- Dropped support 3.5\n- Added support for Python 3.10\n\n******\nv4.0.0\n******\n\n- Dropped support for Python 2.7 and 3.4\n- Added support for Python 3.7, 3.8, and 3.9\n- Removed unused exc.MemoryManagerError and exc.RegionCollectionError\n\n******\nv3.0.5\n******\n\n- Restored Python 2 support removed in v3.0.2\n- Changed release signature key to 27C50E7F590947D7273A741E85194C08421980C9.\n See https://keybase.io/byronbates for proof of ownership.\n\n******\nv3.0.4\n******\n\n- Signed release (with correct key this time)\n\n******\nv3.0.2\n******\n\n- Signed release\n- Switched to GitHub Actions for CI\n\n******\nv3.0.1\n******\n- Switched back to the smmap package name on PyPI and fixed the smmap2 mirror package\n (`#44 <https://github.com/gitpython-developers/smmap/issues/44>`_)\n- Fixed setup.py ``long_description`` rendering\n (`#40 <https://github.com/gitpython-developers/smmap/pull/40>`_)\n\n**********\nv0.9.0\n**********\n- Fixed issue with resources never being freed as mmaps were never closed.\n- Client counting is now done manually, instead of relying on pyton's reference count\n\n**********\nv0.8.5\n**********\n- Fixed Python 3.0-3.3 regression, which also causes smmap to become about 3 times slower depending on the code path. It's related to this bug (http://bugs.python.org/issue15958), which was fixed in python 3.4\n\n**********\nv0.8.4\n**********\n- Fixed Python 3 performance regression\n\n**********\nv0.8.3\n**********\n- Cleaned up code and assured it works sufficiently well with python 3\n\n**********\nv0.8.1\n**********\n- A single bugfix\n\n**********\nv0.8.0 \n**********\n\n- Initial Release\n\n[end of doc/source/changes.rst]","filename":"doc/source/changes.rst","id":"26"},{"content":".. _api-label:\n\n#############\nAPI Reference\n#############\n\n***********************\nMapped Memory Managers\n***********************\n\n.. automodule:: smmap.mman\n :members:\n :undoc-members:\n\n*******\nBuffers\n*******\n\n.. automodule:: smmap.buf\n :members:\n :undoc-members:\n\n*********\nUtilities\n*********\n\n.. automodule:: smmap.util\n :members:\n :undoc-members:\n\n\n\n\n\n\n[end of doc/source/api.rst]","filename":"doc/source/api.rst","id":"27"}],"string":"[\n {\n \"content\": \"Copyright (C) 2010, 2011 Sebastian Thiel and contributors\\nAll rights reserved.\\n\\nRedistribution and use in source and binary forms, with or without \\nmodification, are permitted provided that the following conditions \\nare met:\\n\\n* Redistributions of source code must retain the above copyright \\nnotice, this list of conditions and the following disclaimer.\\n\\n* Redistributions in binary form must reproduce the above copyright \\nnotice, this list of conditions and the following disclaimer in the \\ndocumentation and/or other materials provided with the distribution.\\n\\n* Neither the name of the async project nor the names of \\nits contributors may be used to endorse or promote products derived \\nfrom this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR \\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT \\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, \\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED \\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR \\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF \\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING \\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS \\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \".PHONY: all clean release force_release\\n\\nall:\\n\\t@grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all\\n\\nclean:\\n\\trm -rf build/ dist/ .eggs/ .tox/\\n\\nforce_release: clean\\n\\t./build-release.sh\\n\\ttwine upload dist/*\\n\\tgit push --tags origin master\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"1\"\n },\n {\n \"content\": \"# Include the license file\\ninclude LICENSE\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[run]\\nsource = smmap\\n\\n; to make nosetests happy\\n[report]\\nomit = \\n\\t*/yaml*\\n\\t*/tests/*\\n */python?.?/*\\n */site-packages/nose/*\\n[end of .coveragerc]\",\n \"filename\": \".coveragerc\",\n \"id\": \"3\"\n },\n {\n \"content\": \"## Motivation\\n\\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\\n\\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\\n\\n\\n## Limitations\\n\\n* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.\\n* The memory access is read-only by design.\\n\\n\\n## Overview\\n\\n\\n\\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\\n\\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\\n\\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\\n\\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\\n\\n\\n\\n## Prerequisites\\n\\n* Python 3.7+\\n* OSX, Windows or Linux\\n\\nThe package was tested on all of the previously mentioned configurations.\\n\\n## Installing smmap\\n\\n[](https://readthedocs.org/projects/smmap/?badge=latest)\\n\\nIts easiest to install smmap using the [pip](http://www.pip-installer.org/en/latest) program:\\n\\n```bash\\n$ pip install smmap\\n```\\n\\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\\n\\nIf you have downloaded the source archive, the package can be installed by running the `setup.py` script:\\n\\n```bash\\n$ python setup.py install\\n```\\n\\nIt is advised to have a look at the **Usage Guide** for a brief introduction on the different database implementations.\\n\\n\\n\\n## Homepage and Links\\n\\nThe project is home on github at https://github.com/gitpython-developers/smmap .\\n\\nThe latest source can be cloned from github as well:\\n\\n* git://github.com/gitpython-developers/smmap.git\\n\\n\\nFor support, please use the git-python mailing list:\\n\\n* http://groups.google.com/group/git-python\\n\\n\\nIssues can be filed on github:\\n\\n* https://github.com/gitpython-developers/smmap/issues\\n\\nA link to the pypi page related to this repository:\\n\\n* https://pypi.org/project/smmap/\\n\\n\\n## License Information\\n\\n*smmap* is licensed under the New BSD License.\\n\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"#!/usr/bin/env python\\nimport os\\n\\ntry:\\n from setuptools import setup, find_packages\\nexcept ImportError:\\n from ez_setup import use_setuptools\\n use_setuptools()\\n from setuptools import setup, find_packages\\n\\nimport smmap\\n\\nif os.path.exists(\\\"README.md\\\"):\\n long_description = open('README.md', encoding=\\\"utf-8\\\").read().replace('\\\\r\\\\n', '\\\\n')\\nelse:\\n long_description = \\\"See https://github.com/gitpython-developers/smmap\\\"\\n\\nsetup(\\n name=\\\"smmap\\\",\\n version=smmap.__version__,\\n description=\\\"A pure Python implementation of a sliding window memory map manager\\\",\\n author=smmap.__author__,\\n author_email=smmap.__contact__,\\n url=smmap.__homepage__,\\n platforms=[\\\"any\\\"],\\n license=\\\"BSD-3-Clause\\\",\\n packages=find_packages(),\\n zip_safe=True,\\n python_requires=\\\">=3.7\\\",\\n classifiers=[\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: Microsoft :: Windows\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Programming Language :: Python :: 3.7\\\",\\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 \\\"Programming Language :: Python :: 3.12\\\",\\n \\\"Programming Language :: Python :: 3.13\\\",\\n \\\"Programming Language :: Python :: 3 :: Only\\\",\\n ],\\n long_description=long_description,\\n long_description_content_type='text/markdown',\\n)\\n\\n[end of setup.py]\",\n \"filename\": \"setup.py\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# Tox (http://tox.testrun.org/) is a tool for running tests\\n# in multiple virtualenvs. This configuration file will run the\\n# test suite on all supported python versions. To use it, \\\"pip install tox\\\"\\n# and then run \\\"tox\\\" from this directory.\\n\\n[tox]\\nenvlist = flake8, py{37, 38, 39, 310, 311, 312}\\n\\n[testenv]\\ncommands = {envpython} -m pytest --cov smmap --cov-report xml {posargs}\\ndeps =\\n pytest\\n pytest-cov\\n\\n[testenv:flake8]\\ncommands = flake8 {posargs}\\ndeps = flake8\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"6\"\n },\n {\n \"content\": \"[flake8]\\nexclude = .tox,.venv,build,dist,doc\\n\\n[end of setup.cfg]\",\n \"filename\": \"setup.cfg\",\n \"id\": \"7\"\n },\n {\n \"content\": \"#!/bin/bash\\n#\\n# This script builds a release. If run in a venv, it auto-installs its tools.\\n# You may want to run \\\"make release\\\" instead of running this script directly.\\n\\nset -eEu\\n\\nfunction release_with() {\\n $1 -m build --sdist --wheel\\n}\\n\\nif test -n \\\"${VIRTUAL_ENV:-}\\\"; then\\n deps=(build twine) # Install twine along with build, as we need it later.\\n echo \\\"Virtual environment detected. Adding packages: ${deps[*]}\\\"\\n pip install --quiet --upgrade \\\"${deps[@]}\\\"\\n echo 'Starting the build.'\\n release_with python\\nelse\\n function suggest_venv() {\\n venv_cmd='python -m venv env && source env/bin/activate'\\n printf \\\"HELP: To avoid this error, use a virtual-env with '%s' instead.\\\\n\\\" \\\"$venv_cmd\\\"\\n }\\n trap suggest_venv ERR # This keeps the original exit (error) code.\\n echo 'Starting the build.'\\n release_with python3 # Outside a venv, use python3.\\nfi\\n\\n[end of build-release.sh]\",\n \"filename\": \"build-release.sh\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# Security Policy\\n\\nSee [GitPython](https://github.com/gitpython-developers/GitPython/blob/main/SECURITY.md). Vulnerabilities found in `smmap` can be reported there.\\n\\n[end of SECURITY.md]\",\n \"filename\": \"SECURITY.md\",\n \"id\": \"9\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\\\"\\\"\\\"\\nfrom .util import (\\n MapWindow,\\n MapRegion,\\n MapRegionList,\\n is_64_bit,\\n)\\n\\nimport sys\\nfrom functools import reduce\\n\\n__all__ = [\\\"StaticWindowMapManager\\\", \\\"SlidingWindowMapManager\\\", \\\"WindowCursor\\\"]\\n#{ Utilities\\n\\n#}END utilities\\n\\n\\nclass WindowCursor:\\n\\n \\\"\\\"\\\"\\n Pointer into the mapped region of the memory manager, keeping the map\\n alive until it is destroyed and no other client uses it.\\n\\n Cursors should not be created manually, but are instead returned by the SlidingWindowMapManager\\n\\n **Note:**: The current implementation is suited for static and sliding window managers, but it also means\\n that it must be suited for the somewhat quite different sliding manager. It could be improved, but\\n I see no real need to do so.\\\"\\\"\\\"\\n __slots__ = (\\n '_manager', # the manager keeping all file regions\\n '_rlist', # a regions list with regions for our file\\n '_region', # our current class:`MapRegion` or None\\n '_ofs', # relative offset from the actually mapped area to our start area\\n '_size' # maximum size we should provide\\n )\\n\\n def __init__(self, manager=None, regions=None):\\n self._manager = manager\\n self._rlist = regions\\n self._region = None\\n self._ofs = 0\\n self._size = 0\\n\\n def __del__(self):\\n self._destroy()\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self._destroy()\\n\\n def _destroy(self):\\n \\\"\\\"\\\"Destruction code to decrement counters\\\"\\\"\\\"\\n self.unuse_region()\\n\\n if self._rlist is not None:\\n # Actual client count, which doesn't include the reference kept by the manager, nor ours\\n # as we are about to be deleted\\n try:\\n if len(self._rlist) == 0:\\n # Free all resources associated with the mapped file\\n self._manager._fdict.pop(self._rlist.path_or_fd())\\n # END remove regions list from manager\\n except (TypeError, KeyError):\\n # sometimes, during shutdown, getrefcount is None. Its possible\\n # to re-import it, however, its probably better to just ignore\\n # this python problem (for now).\\n # The next step is to get rid of the error prone getrefcount altogether.\\n pass\\n # END exception handling\\n # END handle regions\\n\\n def _copy_from(self, rhs):\\n \\\"\\\"\\\"Copy all data from rhs into this instance, handles usage count\\\"\\\"\\\"\\n self._manager = rhs._manager\\n self._rlist = type(rhs._rlist)(rhs._rlist)\\n self._region = rhs._region\\n self._ofs = rhs._ofs\\n self._size = rhs._size\\n\\n for region in self._rlist:\\n region.increment_client_count()\\n\\n if self._region is not None:\\n self._region.increment_client_count()\\n # END handle regions\\n\\n def __copy__(self):\\n \\\"\\\"\\\"copy module interface\\\"\\\"\\\"\\n cpy = type(self)()\\n cpy._copy_from(self)\\n return cpy\\n\\n #{ Interface\\n def assign(self, rhs):\\n \\\"\\\"\\\"Assign rhs to this instance. This is required in order to get a real copy.\\n Alternatively, you can copy an existing instance using the copy module\\\"\\\"\\\"\\n self._destroy()\\n self._copy_from(rhs)\\n\\n def use_region(self, offset=0, size=0, flags=0):\\n \\\"\\\"\\\"Assure we point to a window which allows access to the given offset into the file\\n\\n :param offset: absolute offset in bytes into the file\\n :param size: amount of bytes to map. If 0, all available bytes will be mapped\\n :param flags: additional flags to be given to os.open in case a file handle is initially opened\\n for mapping. Has no effect if a region can actually be reused.\\n :return: this instance - it should be queried for whether it points to a valid memory region.\\n This is not the case if the mapping failed because we reached the end of the file\\n\\n **Note:**: The size actually mapped may be smaller than the given size. If that is the case,\\n either the file has reached its end, or the map was created between two existing regions\\\"\\\"\\\"\\n need_region = True\\n man = self._manager\\n fsize = self._rlist.file_size()\\n size = min(size or fsize, man.window_size() or fsize) # clamp size to window size\\n\\n if self._region is not None:\\n if self._region.includes_ofs(offset):\\n need_region = False\\n else:\\n self.unuse_region()\\n # END handle existing region\\n # END check existing region\\n\\n # offset too large ?\\n if offset >= fsize:\\n return self\\n # END handle offset\\n\\n if need_region:\\n self._region = man._obtain_region(self._rlist, offset, size, flags, False)\\n self._region.increment_client_count()\\n # END need region handling\\n\\n self._ofs = offset - self._region._b\\n self._size = min(size, self._region.ofs_end() - offset)\\n\\n return self\\n\\n def unuse_region(self):\\n \\\"\\\"\\\"Unuse the current region. Does nothing if we have no current region\\n\\n **Note:** the cursor unuses the region automatically upon destruction. It is recommended\\n to un-use the region once you are done reading from it in persistent cursors as it\\n helps to free up resource more quickly\\\"\\\"\\\"\\n if self._region is not None:\\n self._region.increment_client_count(-1)\\n self._region = None\\n # note: should reset ofs and size, but we spare that for performance. Its not\\n # allowed to query information if we are not valid !\\n\\n def buffer(self):\\n \\\"\\\"\\\"Return a buffer object which allows access to our memory region from our offset\\n to the window size. Please note that it might be smaller than you requested when calling use_region()\\n\\n **Note:** You can only obtain a buffer if this instance is_valid() !\\n\\n **Note:** buffers should not be cached passed the duration of your access as it will\\n prevent resources from being freed even though they might not be accounted for anymore !\\\"\\\"\\\"\\n return memoryview(self._region.buffer())[self._ofs:self._ofs+self._size]\\n\\n def map(self):\\n \\\"\\\"\\\"\\n :return: the underlying raw memory map. Please not that the offset and size is likely to be different\\n to what you set as offset and size. Use it only if you are sure about the region it maps, which is the whole\\n file in case of StaticWindowMapManager\\\"\\\"\\\"\\n return self._region.map()\\n\\n def is_valid(self):\\n \\\"\\\"\\\":return: True if we have a valid and usable region\\\"\\\"\\\"\\n return self._region is not None\\n\\n def is_associated(self):\\n \\\"\\\"\\\":return: True if we are associated with a specific file already\\\"\\\"\\\"\\n return self._rlist is not None\\n\\n def ofs_begin(self):\\n \\\"\\\"\\\":return: offset to the first byte pointed to by our cursor\\n\\n **Note:** only if is_valid() is True\\\"\\\"\\\"\\n return self._region._b + self._ofs\\n\\n def ofs_end(self):\\n \\\"\\\"\\\":return: offset to one past the last available byte\\\"\\\"\\\"\\n # unroll method calls for performance !\\n return self._region._b + self._ofs + self._size\\n\\n def size(self):\\n \\\"\\\"\\\":return: amount of bytes we point to\\\"\\\"\\\"\\n return self._size\\n\\n def region(self):\\n \\\"\\\"\\\":return: our mapped region, or None if nothing is mapped yet\\n :raise AssertionError: if we have no current region. This is only useful for debugging\\\"\\\"\\\"\\n return self._region\\n\\n def includes_ofs(self, ofs):\\n \\\"\\\"\\\":return: True if the given absolute offset is contained in the cursors\\n current region\\n\\n **Note:** cursor must be valid for this to work\\\"\\\"\\\"\\n # unroll methods\\n return (self._region._b + self._ofs) <= ofs < (self._region._b + self._ofs + self._size)\\n\\n def file_size(self):\\n \\\"\\\"\\\":return: size of the underlying file\\\"\\\"\\\"\\n return self._rlist.file_size()\\n\\n def path_or_fd(self):\\n \\\"\\\"\\\":return: path or file descriptor of the underlying mapped file\\\"\\\"\\\"\\n return self._rlist.path_or_fd()\\n\\n def path(self):\\n \\\"\\\"\\\":return: path of the underlying mapped file\\n :raise ValueError: if attached path is not a path\\\"\\\"\\\"\\n if isinstance(self._rlist.path_or_fd(), int):\\n raise ValueError(\\\"Path queried although mapping was applied to a file descriptor\\\")\\n # END handle type\\n return self._rlist.path_or_fd()\\n\\n def fd(self):\\n \\\"\\\"\\\":return: file descriptor used to create the underlying mapping.\\n\\n **Note:** it is not required to be valid anymore\\n :raise ValueError: if the mapping was not created by a file descriptor\\\"\\\"\\\"\\n if isinstance(self._rlist.path_or_fd(), str):\\n raise ValueError(\\\"File descriptor queried although mapping was generated from path\\\")\\n # END handle type\\n return self._rlist.path_or_fd()\\n\\n #} END interface\\n\\n\\nclass StaticWindowMapManager:\\n\\n \\\"\\\"\\\"Provides a manager which will produce single size cursors that are allowed\\n to always map the whole file.\\n\\n Clients must be written to specifically know that they are accessing their data\\n through a StaticWindowMapManager, as they otherwise have to deal with their window size.\\n\\n These clients would have to use a SlidingWindowMapBuffer to hide this fact.\\n\\n This type will always use a maximum window size, and optimize certain methods to\\n accommodate this fact\\\"\\\"\\\"\\n\\n __slots__ = [\\n '_fdict', # mapping of path -> StorageHelper (of some kind\\n '_window_size', # maximum size of a window\\n '_max_memory_size', # maximum amount of memory we may allocate\\n '_max_handle_count', # maximum amount of handles to keep open\\n '_memory_size', # currently allocated memory size\\n '_handle_count', # amount of currently allocated file handles\\n ]\\n\\n #{ Configuration\\n MapRegionListCls = MapRegionList\\n MapWindowCls = MapWindow\\n MapRegionCls = MapRegion\\n WindowCursorCls = WindowCursor\\n #} END configuration\\n\\n _MB_in_bytes = 1024 * 1024\\n\\n def __init__(self, window_size=0, max_memory_size=0, max_open_handles=sys.maxsize):\\n \\\"\\\"\\\"initialize the manager with the given parameters.\\n :param window_size: if -1, a default window size will be chosen depending on\\n the operating system's architecture. It will internally be quantified to a multiple of the page size\\n If 0, the window may have any size, which basically results in mapping the whole file at one\\n :param max_memory_size: maximum amount of memory we may map at once before releasing mapped regions.\\n If 0, a viable default will be set depending on the system's architecture.\\n It is a soft limit that is tried to be kept, but nothing bad happens if we have to over-allocate\\n :param max_open_handles: if not maxint, limit the amount of open file handles to the given number.\\n Otherwise the amount is only limited by the system itself. If a system or soft limit is hit,\\n the manager will free as many handles as possible\\\"\\\"\\\"\\n self._fdict = dict()\\n self._window_size = window_size\\n self._max_memory_size = max_memory_size\\n self._max_handle_count = max_open_handles\\n self._memory_size = 0\\n self._handle_count = 0\\n\\n if window_size < 0:\\n coeff = 64\\n if is_64_bit():\\n coeff = 1024\\n # END handle arch\\n self._window_size = coeff * self._MB_in_bytes\\n # END handle max window size\\n\\n if max_memory_size == 0:\\n coeff = 1024\\n if is_64_bit():\\n coeff = 8192\\n # END handle arch\\n self._max_memory_size = coeff * self._MB_in_bytes\\n # END handle max memory size\\n\\n #{ Internal Methods\\n\\n def _collect_lru_region(self, size):\\n \\\"\\\"\\\"Unmap the region which was least-recently used and has no client\\n :param size: size of the region we want to map next (assuming its not already mapped partially or full\\n if 0, we try to free any available region\\n :return: Amount of freed regions\\n\\n .. Note::\\n We don't raise exceptions anymore, in order to keep the system working, allowing temporary overallocation.\\n If the system runs out of memory, it will tell.\\n\\n .. TODO::\\n implement a case where all unusued regions are discarded efficiently.\\n Currently its only brute force\\n \\\"\\\"\\\"\\n num_found = 0\\n while (size == 0) or (self._memory_size + size > self._max_memory_size):\\n lru_region = None\\n lru_list = None\\n for regions in self._fdict.values():\\n for region in regions:\\n # check client count - if it's 1, it's just us\\n if (region.client_count() == 1 and\\n (lru_region is None or region._uc < lru_region._uc)):\\n lru_region = region\\n lru_list = regions\\n # END update lru_region\\n # END for each region\\n # END for each regions list\\n\\n if lru_region is None:\\n break\\n # END handle region not found\\n\\n num_found += 1\\n del(lru_list[lru_list.index(lru_region)])\\n lru_region.increment_client_count(-1)\\n self._memory_size -= lru_region.size()\\n self._handle_count -= 1\\n # END while there is more memory to free\\n return num_found\\n\\n def _obtain_region(self, a, offset, size, flags, is_recursive):\\n \\\"\\\"\\\"Utility to create a new region - for more information on the parameters,\\n see MapCursor.use_region.\\n :param a: A regions (a)rray\\n :return: The newly created region\\\"\\\"\\\"\\n if self._memory_size + size > self._max_memory_size:\\n self._collect_lru_region(size)\\n # END handle collection\\n\\n r = None\\n if a:\\n assert len(a) == 1\\n r = a[0]\\n else:\\n try:\\n r = self.MapRegionCls(a.path_or_fd(), 0, sys.maxsize, flags)\\n except Exception:\\n # apparently we are out of system resources or hit a limit\\n # As many more operations are likely to fail in that condition (\\n # like reading a file from disk, etc) we free up as much as possible\\n # As this invalidates our insert position, we have to recurse here\\n if is_recursive:\\n # we already tried this, and still have no success in obtaining\\n # a mapping. This is an exception, so we propagate it\\n raise\\n # END handle existing recursion\\n self._collect_lru_region(0)\\n return self._obtain_region(a, offset, size, flags, True)\\n # END handle exceptions\\n\\n self._handle_count += 1\\n self._memory_size += r.size()\\n a.append(r)\\n # END handle array\\n\\n assert r.includes_ofs(offset)\\n return r\\n\\n #}END internal methods\\n\\n #{ Interface\\n def make_cursor(self, path_or_fd):\\n \\\"\\\"\\\"\\n :return: a cursor pointing to the given path or file descriptor.\\n It can be used to map new regions of the file into memory\\n\\n **Note:** if a file descriptor is given, it is assumed to be open and valid,\\n but may be closed afterwards. To refer to the same file, you may reuse\\n your existing file descriptor, but keep in mind that new windows can only\\n be mapped as long as it stays valid. This is why the using actual file paths\\n are preferred unless you plan to keep the file descriptor open.\\n\\n **Note:** file descriptors are problematic as they are not necessarily unique, as two\\n different files opened and closed in succession might have the same file descriptor id.\\n\\n **Note:** Using file descriptors directly is faster once new windows are mapped as it\\n prevents the file to be opened again just for the purpose of mapping it.\\\"\\\"\\\"\\n regions = self._fdict.get(path_or_fd)\\n if regions is None:\\n regions = self.MapRegionListCls(path_or_fd)\\n self._fdict[path_or_fd] = regions\\n # END obtain region for path\\n return self.WindowCursorCls(self, regions)\\n\\n def collect(self):\\n \\\"\\\"\\\"Collect all available free-to-collect mapped regions\\n :return: Amount of freed handles\\\"\\\"\\\"\\n return self._collect_lru_region(0)\\n\\n def num_file_handles(self):\\n \\\"\\\"\\\":return: amount of file handles in use. Each mapped region uses one file handle\\\"\\\"\\\"\\n return self._handle_count\\n\\n def num_open_files(self):\\n \\\"\\\"\\\"Amount of opened files in the system\\\"\\\"\\\"\\n return reduce(lambda x, y: x + y, (1 for rlist in self._fdict.values() if len(rlist) > 0), 0)\\n\\n def window_size(self):\\n \\\"\\\"\\\":return: size of each window when allocating new regions\\\"\\\"\\\"\\n return self._window_size\\n\\n def mapped_memory_size(self):\\n \\\"\\\"\\\":return: amount of bytes currently mapped in total\\\"\\\"\\\"\\n return self._memory_size\\n\\n def max_file_handles(self):\\n \\\"\\\"\\\":return: maximum amount of handles we may have opened\\\"\\\"\\\"\\n return self._max_handle_count\\n\\n def max_mapped_memory_size(self):\\n \\\"\\\"\\\":return: maximum amount of memory we may allocate\\\"\\\"\\\"\\n return self._max_memory_size\\n\\n #} END interface\\n\\n #{ Special Purpose Interface\\n\\n def force_map_handle_removal_win(self, base_path):\\n \\\"\\\"\\\"ONLY AVAILABLE ON WINDOWS\\n On windows removing files is not allowed if anybody still has it opened.\\n If this process is ourselves, and if the whole process uses this memory\\n manager (as far as the parent framework is concerned) we can enforce\\n closing all memory maps whose path matches the given base path to\\n allow the respective operation after all.\\n The respective system must NOT access the closed memory regions anymore !\\n This really may only be used if you know that the items which keep\\n the cursors alive will not be using it anymore. They need to be recreated !\\n :return: Amount of closed handles\\n\\n **Note:** does nothing on non-windows platforms\\\"\\\"\\\"\\n if sys.platform != 'win32':\\n return\\n # END early bailout\\n\\n num_closed = 0\\n for path, rlist in self._fdict.items():\\n if path.startswith(base_path):\\n for region in rlist:\\n region.release()\\n num_closed += 1\\n # END path matches\\n # END for each path\\n return num_closed\\n #} END special purpose interface\\n\\n\\nclass SlidingWindowMapManager(StaticWindowMapManager):\\n\\n \\\"\\\"\\\"Maintains a list of ranges of mapped memory regions in one or more files and allows to easily\\n obtain additional regions assuring there is no overlap.\\n Once a certain memory limit is reached globally, or if there cannot be more open file handles\\n which result from each mmap call, the least recently used, and currently unused mapped regions\\n are unloaded automatically.\\n\\n **Note:** currently not thread-safe !\\n\\n **Note:** in the current implementation, we will automatically unload windows if we either cannot\\n create more memory maps (as the open file handles limit is hit) or if we have allocated more than\\n a safe amount of memory already, which would possibly cause memory allocations to fail as our address\\n space is full.\\\"\\\"\\\"\\n\\n __slots__ = tuple()\\n\\n def __init__(self, window_size=-1, max_memory_size=0, max_open_handles=sys.maxsize):\\n \\\"\\\"\\\"Adjusts the default window size to -1\\\"\\\"\\\"\\n super().__init__(window_size, max_memory_size, max_open_handles)\\n\\n def _obtain_region(self, a, offset, size, flags, is_recursive):\\n # bisect to find an existing region. The c++ implementation cannot\\n # do that as it uses a linked list for regions.\\n r = None\\n lo = 0\\n hi = len(a)\\n while lo < hi:\\n mid = (lo + hi) // 2\\n ofs = a[mid]._b\\n if ofs <= offset:\\n if a[mid].includes_ofs(offset):\\n r = a[mid]\\n break\\n # END have region\\n lo = mid + 1\\n else:\\n hi = mid\\n # END handle position\\n # END while bisecting\\n\\n if r is None:\\n window_size = self._window_size\\n left = self.MapWindowCls(0, 0)\\n mid = self.MapWindowCls(offset, size)\\n right = self.MapWindowCls(a.file_size(), 0)\\n\\n # we want to honor the max memory size, and assure we have anough\\n # memory available\\n # Save calls !\\n if self._memory_size + window_size > self._max_memory_size:\\n self._collect_lru_region(window_size)\\n # END handle collection\\n\\n # we assume the list remains sorted by offset\\n insert_pos = 0\\n len_regions = len(a)\\n if len_regions == 1:\\n if a[0]._b <= offset:\\n insert_pos = 1\\n # END maintain sort\\n else:\\n # find insert position\\n insert_pos = len_regions\\n for i, region in enumerate(a):\\n if region._b > offset:\\n insert_pos = i\\n break\\n # END if insert position is correct\\n # END for each region\\n # END obtain insert pos\\n\\n # adjust the actual offset and size values to create the largest\\n # possible mapping\\n if insert_pos == 0:\\n if len_regions:\\n right = self.MapWindowCls.from_region(a[insert_pos])\\n # END adjust right side\\n else:\\n if insert_pos != len_regions:\\n right = self.MapWindowCls.from_region(a[insert_pos])\\n # END adjust right window\\n left = self.MapWindowCls.from_region(a[insert_pos - 1])\\n # END adjust surrounding windows\\n\\n mid.extend_left_to(left, window_size)\\n mid.extend_right_to(right, window_size)\\n mid.align()\\n\\n # it can happen that we align beyond the end of the file\\n if mid.ofs_end() > right.ofs:\\n mid.size = right.ofs - mid.ofs\\n # END readjust size\\n\\n # insert new region at the right offset to keep the order\\n try:\\n if self._handle_count >= self._max_handle_count:\\n raise Exception\\n # END assert own imposed max file handles\\n r = self.MapRegionCls(a.path_or_fd(), mid.ofs, mid.size, flags)\\n except Exception:\\n # apparently we are out of system resources or hit a limit\\n # As many more operations are likely to fail in that condition (\\n # like reading a file from disk, etc) we free up as much as possible\\n # As this invalidates our insert position, we have to recurse here\\n if is_recursive:\\n # we already tried this, and still have no success in obtaining\\n # a mapping. This is an exception, so we propagate it\\n raise\\n # END handle existing recursion\\n self._collect_lru_region(0)\\n return self._obtain_region(a, offset, size, flags, True)\\n # END handle exceptions\\n\\n self._handle_count += 1\\n self._memory_size += r.size()\\n a.insert(insert_pos, r)\\n # END create new region\\n return r\\n\\n[end of smmap/mman.py]\",\n \"filename\": \"smmap/mman.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module with a simple buffer implementation using the memory manager\\\"\\\"\\\"\\nimport sys\\n\\n__all__ = [\\\"SlidingWindowMapBuffer\\\"]\\n\\n\\nclass SlidingWindowMapBuffer:\\n\\n \\\"\\\"\\\"A buffer like object which allows direct byte-wise object and slicing into\\n memory of a mapped file. The mapping is controlled by the provided cursor.\\n\\n The buffer is relative, that is if you map an offset, index 0 will map to the\\n first byte at the offset you used during initialization or begin_access\\n\\n **Note:** Although this type effectively hides the fact that there are mapped windows\\n underneath, it can unfortunately not be used in any non-pure python method which\\n needs a buffer or string\\\"\\\"\\\"\\n __slots__ = (\\n '_c', # our cursor\\n '_size', # our supposed size\\n )\\n\\n def __init__(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\\n \\\"\\\"\\\"Initialize the instance to operate on the given cursor.\\n :param cursor: if not None, the associated cursor to the file you want to access\\n If None, you have call begin_access before using the buffer and provide a cursor\\n :param offset: absolute offset in bytes\\n :param size: the total size of the mapping. Defaults to the maximum possible size\\n From that point on, the __len__ of the buffer will be the given size or the file size.\\n If the size is larger than the mappable area, you can only access the actually available\\n area, although the length of the buffer is reported to be your given size.\\n Hence it is in your own interest to provide a proper size !\\n :param flags: Additional flags to be passed to os.open\\n :raise ValueError: if the buffer could not achieve a valid state\\\"\\\"\\\"\\n self._c = cursor\\n if cursor and not self.begin_access(cursor, offset, size, flags):\\n raise ValueError(\\\"Failed to allocate the buffer - probably the given offset is out of bounds\\\")\\n # END handle offset\\n\\n def __del__(self):\\n self.end_access()\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self.end_access()\\n\\n def __len__(self):\\n return self._size\\n\\n def __getitem__(self, i):\\n if isinstance(i, slice):\\n return self.__getslice__(i.start or 0, i.stop or self._size)\\n c = self._c\\n assert c.is_valid()\\n if i < 0:\\n i = self._size + i\\n if not c.includes_ofs(i):\\n c.use_region(i, 1)\\n # END handle region usage\\n return c.buffer()[i - c.ofs_begin()]\\n\\n def __getslice__(self, i, j):\\n c = self._c\\n # fast path, slice fully included - safes a concatenate operation and\\n # should be the default\\n assert c.is_valid()\\n if i < 0:\\n i = self._size + i\\n if j == sys.maxsize:\\n j = self._size\\n if j < 0:\\n j = self._size + j\\n if (c.ofs_begin() <= i) and (j < c.ofs_end()):\\n b = c.ofs_begin()\\n return c.buffer()[i - b:j - b]\\n else:\\n l = j - i # total length\\n ofs = i\\n # It's fastest to keep tokens and join later, especially in py3, which was 7 times slower\\n # in the previous iteration of this code\\n md = list()\\n while l:\\n c.use_region(ofs, l)\\n assert c.is_valid()\\n d = c.buffer()[:l]\\n ofs += len(d)\\n l -= len(d)\\n # Make sure we don't keep references, as c.use_region() might attempt to free resources, but\\n # can't unless we use pure bytes\\n if hasattr(d, 'tobytes'):\\n d = d.tobytes()\\n md.append(d)\\n # END while there are bytes to read\\n return b''.join(md)\\n # END fast or slow path\\n #{ Interface\\n\\n def begin_access(self, cursor=None, offset=0, size=sys.maxsize, flags=0):\\n \\\"\\\"\\\"Call this before the first use of this instance. The method was already\\n called by the constructor in case sufficient information was provided.\\n\\n For more information no the parameters, see the __init__ method\\n :param path: if cursor is None the existing one will be used.\\n :return: True if the buffer can be used\\\"\\\"\\\"\\n if cursor:\\n self._c = cursor\\n # END update our cursor\\n\\n # reuse existing cursors if possible\\n if self._c is not None and self._c.is_associated():\\n res = self._c.use_region(offset, size, flags).is_valid()\\n if res:\\n # if given size is too large or default, we computer a proper size\\n # If its smaller, we assume the combination between offset and size\\n # as chosen by the user is correct and use it !\\n # If not, the user is in trouble.\\n if size > self._c.file_size():\\n size = self._c.file_size() - offset\\n # END handle size\\n self._size = size\\n # END set size\\n return res\\n # END use our cursor\\n return False\\n\\n def end_access(self):\\n \\\"\\\"\\\"Call this method once you are done using the instance. It is automatically\\n called on destruction, and should be called just in time to allow system\\n resources to be freed.\\n\\n Once you called end_access, you must call begin access before reusing this instance!\\\"\\\"\\\"\\n self._size = 0\\n if self._c is not None:\\n self._c.unuse_region()\\n # END unuse region\\n\\n def cursor(self):\\n \\\"\\\"\\\":return: the currently set cursor which provides access to the data\\\"\\\"\\\"\\n return self._c\\n\\n #}END interface\\n\\n[end of smmap/buf.py]\",\n \"filename\": \"smmap/buf.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Module containing a memory memory manager which provides a sliding window on a number of memory mapped files\\\"\\\"\\\"\\nimport os\\nimport sys\\n\\nfrom mmap import mmap, ACCESS_READ\\nfrom mmap import ALLOCATIONGRANULARITY\\n\\n__all__ = [\\\"align_to_mmap\\\", \\\"is_64_bit\\\",\\n \\\"MapWindow\\\", \\\"MapRegion\\\", \\\"MapRegionList\\\", \\\"ALLOCATIONGRANULARITY\\\"]\\n\\n#{ Utilities\\n\\n\\ndef align_to_mmap(num, round_up):\\n \\\"\\\"\\\"\\n Align the given integer number to the closest page offset, which usually is 4096 bytes.\\n\\n :param round_up: if True, the next higher multiple of page size is used, otherwise\\n the lower page_size will be used (i.e. if True, 1 becomes 4096, otherwise it becomes 0)\\n :return: num rounded to closest page\\\"\\\"\\\"\\n res = (num // ALLOCATIONGRANULARITY) * ALLOCATIONGRANULARITY\\n if round_up and (res != num):\\n res += ALLOCATIONGRANULARITY\\n # END handle size\\n return res\\n\\n\\ndef is_64_bit():\\n \\\"\\\"\\\":return: True if the system is 64 bit. Otherwise it can be assumed to be 32 bit\\\"\\\"\\\"\\n return sys.maxsize > (1 << 32) - 1\\n\\n#}END utilities\\n\\n\\n#{ Utility Classes\\n\\nclass MapWindow:\\n\\n \\\"\\\"\\\"Utility type which is used to snap windows towards each other, and to adjust their size\\\"\\\"\\\"\\n __slots__ = (\\n 'ofs', # offset into the file in bytes\\n 'size' # size of the window in bytes\\n )\\n\\n def __init__(self, offset, size):\\n self.ofs = offset\\n self.size = size\\n\\n def __repr__(self):\\n return \\\"MapWindow(%i, %i)\\\" % (self.ofs, self.size)\\n\\n @classmethod\\n def from_region(cls, region):\\n \\\"\\\"\\\":return: new window from a region\\\"\\\"\\\"\\n return cls(region._b, region.size())\\n\\n def ofs_end(self):\\n return self.ofs + self.size\\n\\n def align(self):\\n \\\"\\\"\\\"Assures the previous window area is contained in the new one\\\"\\\"\\\"\\n nofs = align_to_mmap(self.ofs, 0)\\n self.size += self.ofs - nofs # keep size constant\\n self.ofs = nofs\\n self.size = align_to_mmap(self.size, 1)\\n\\n def extend_left_to(self, window, max_size):\\n \\\"\\\"\\\"Adjust the offset to start where the given window on our left ends if possible,\\n but don't make yourself larger than max_size.\\n The resize will assure that the new window still contains the old window area\\\"\\\"\\\"\\n rofs = self.ofs - window.ofs_end()\\n nsize = rofs + self.size\\n rofs -= nsize - min(nsize, max_size)\\n self.ofs -= rofs\\n self.size += rofs\\n\\n def extend_right_to(self, window, max_size):\\n \\\"\\\"\\\"Adjust the size to make our window end where the right window begins, but don't\\n get larger than max_size\\\"\\\"\\\"\\n self.size = min(self.size + (window.ofs - self.ofs_end()), max_size)\\n\\n\\nclass MapRegion:\\n\\n \\\"\\\"\\\"Defines a mapped region of memory, aligned to pagesizes\\n\\n **Note:** deallocates used region automatically on destruction\\\"\\\"\\\"\\n __slots__ = [\\n '_b', # beginning of mapping\\n '_mf', # mapped memory chunk (as returned by mmap)\\n '_uc', # total amount of usages\\n '_size', # cached size of our memory map\\n '__weakref__'\\n ]\\n\\n #{ Configuration\\n #} END configuration\\n\\n def __init__(self, path_or_fd, ofs, size, flags=0):\\n \\\"\\\"\\\"Initialize a region, allocate the memory map\\n :param path_or_fd: path to the file to map, or the opened file descriptor\\n :param ofs: **aligned** offset into the file to be mapped\\n :param size: if size is larger then the file on disk, the whole file will be\\n allocated the the size automatically adjusted\\n :param flags: additional flags to be given when opening the file.\\n :raise Exception: if no memory can be allocated\\\"\\\"\\\"\\n self._b = ofs\\n self._size = 0\\n self._uc = 0\\n\\n if isinstance(path_or_fd, int):\\n fd = path_or_fd\\n else:\\n fd = os.open(path_or_fd, os.O_RDONLY | getattr(os, 'O_BINARY', 0) | flags)\\n # END handle fd\\n\\n try:\\n kwargs = dict(access=ACCESS_READ, offset=ofs)\\n corrected_size = size\\n sizeofs = ofs\\n\\n # have to correct size, otherwise (instead of the c version) it will\\n # bark that the size is too large ... many extra file accesses because\\n # if this ... argh !\\n actual_size = min(os.fstat(fd).st_size - sizeofs, corrected_size)\\n self._mf = mmap(fd, actual_size, **kwargs)\\n # END handle memory mode\\n\\n self._size = len(self._mf)\\n finally:\\n if isinstance(path_or_fd, str):\\n os.close(fd)\\n # END only close it if we opened it\\n # END close file handle\\n # We assume the first one to use us keeps us around\\n self.increment_client_count()\\n\\n def __repr__(self):\\n return \\\"MapRegion<%i, %i>\\\" % (self._b, self.size())\\n\\n #{ Interface\\n\\n def buffer(self):\\n \\\"\\\"\\\":return: a buffer containing the memory\\\"\\\"\\\"\\n return self._mf\\n\\n def map(self):\\n \\\"\\\"\\\":return: a memory map containing the memory\\\"\\\"\\\"\\n return self._mf\\n\\n def ofs_begin(self):\\n \\\"\\\"\\\":return: absolute byte offset to the first byte of the mapping\\\"\\\"\\\"\\n return self._b\\n\\n def size(self):\\n \\\"\\\"\\\":return: total size of the mapped region in bytes\\\"\\\"\\\"\\n return self._size\\n\\n def ofs_end(self):\\n \\\"\\\"\\\":return: Absolute offset to one byte beyond the mapping into the file\\\"\\\"\\\"\\n return self._b + self._size\\n\\n def includes_ofs(self, ofs):\\n \\\"\\\"\\\":return: True if the given offset can be read in our mapped region\\\"\\\"\\\"\\n return self._b <= ofs < self._b + self._size\\n\\n def client_count(self):\\n \\\"\\\"\\\":return: number of clients currently using this region\\\"\\\"\\\"\\n return self._uc\\n\\n def increment_client_count(self, ofs = 1):\\n \\\"\\\"\\\"Adjust the usage count by the given positive or negative offset.\\n If usage count equals 0, we will auto-release our resources\\n :return: True if we released resources, False otherwise. In the latter case, we can still be used\\\"\\\"\\\"\\n self._uc += ofs\\n assert self._uc > -1, \\\"Increments must match decrements, usage counter negative: %i\\\" % self._uc\\n\\n if self.client_count() == 0:\\n self.release()\\n return True\\n else:\\n return False\\n # end handle release\\n\\n def release(self):\\n \\\"\\\"\\\"Release all resources this instance might hold. Must only be called if there usage_count() is zero\\\"\\\"\\\"\\n self._mf.close()\\n\\n #} END interface\\n\\n\\nclass MapRegionList(list):\\n\\n \\\"\\\"\\\"List of MapRegion instances associating a path with a list of regions.\\\"\\\"\\\"\\n __slots__ = (\\n '_path_or_fd', # path or file descriptor which is mapped by all our regions\\n '_file_size' # total size of the file we map\\n )\\n\\n def __new__(cls, path):\\n return super().__new__(cls)\\n\\n def __init__(self, path_or_fd):\\n self._path_or_fd = path_or_fd\\n self._file_size = None\\n\\n def path_or_fd(self):\\n \\\"\\\"\\\":return: path or file descriptor we are attached to\\\"\\\"\\\"\\n return self._path_or_fd\\n\\n def file_size(self):\\n \\\"\\\"\\\":return: size of file we manager\\\"\\\"\\\"\\n if self._file_size is None:\\n if isinstance(self._path_or_fd, str):\\n self._file_size = os.stat(self._path_or_fd).st_size\\n else:\\n self._file_size = os.fstat(self._path_or_fd).st_size\\n # END handle path type\\n # END update file size\\n return self._file_size\\n\\n#} END utility classes\\n\\n[end of smmap/util.py]\",\n \"filename\": \"smmap/util.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Initialize the smmap package\\\"\\\"\\\"\\n\\n__author__ = \\\"Sebastian Thiel\\\"\\n__contact__ = \\\"byronimo@gmail.com\\\"\\n__homepage__ = \\\"https://github.com/gitpython-developers/smmap\\\"\\nversion_info = (5, 0, 2)\\n__version__ = '.'.join(str(i) for i in version_info)\\n\\n# make everything available in root package for convenience\\nfrom .mman import *\\nfrom .buf import *\\n\\n[end of smmap/__init__.py]\",\n \"filename\": \"smmap/__init__.py\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = build\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source\\n\\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\t-rm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make all-pdf' or \\\\`make all-ps' in that directory to\\\" \\\\\\n\\t \\\"run these through (pdf)latex.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\n[end of doc/Makefile]\",\n \"filename\": \"doc/Makefile\",\n \"id\": \"14\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\nREM Command file for Sphinx documentation\\n\\nset SPHINXBUILD=sphinx-build\\nset BUILDDIR=build\\nset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\\nif NOT \\\"%PAPER%\\\" == \\\"\\\" (\\n\\tset ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\\n)\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\nif \\\"%1\\\" == \\\"help\\\" (\\n\\t:help\\n\\techo.Please use `make ^<target^>` where ^<target^> is one of\\n\\techo. html to make standalone HTML files\\n\\techo. dirhtml to make HTML files named index.html in directories\\n\\techo. pickle to make pickle files\\n\\techo. json to make JSON files\\n\\techo. htmlhelp to make HTML files and a HTML help project\\n\\techo. qthelp to make HTML files and a qthelp project\\n\\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\n\\techo. changes to make an overview over all changed/added/deprecated items\\n\\techo. linkcheck to check all external links for integrity\\n\\techo. doctest to run all doctests embedded in the documentation if enabled\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"clean\\\" (\\n\\tfor /d %%i in (%BUILDDIR%\\\\*) do rmdir /q /s %%i\\n\\tdel /q /s %BUILDDIR%\\\\*\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"html\\\" (\\n\\t%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\\n\\techo.\\n\\techo.Build finished. The HTML pages are in %BUILDDIR%/html.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"dirhtml\\\" (\\n\\t%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\\n\\techo.\\n\\techo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"pickle\\\" (\\n\\t%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\\n\\techo.\\n\\techo.Build finished; now you can process the pickle files.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"json\\\" (\\n\\t%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\\n\\techo.\\n\\techo.Build finished; now you can process the JSON files.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"htmlhelp\\\" (\\n\\t%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\\n\\techo.\\n\\techo.Build finished; now you can run HTML Help Workshop with the ^\\n.hhp project file in %BUILDDIR%/htmlhelp.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"qthelp\\\" (\\n\\t%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\\n\\techo.\\n\\techo.Build finished; now you can run \\\"qcollectiongenerator\\\" with the ^\\n.qhcp project file in %BUILDDIR%/qthelp, like this:\\n\\techo.^> qcollectiongenerator %BUILDDIR%\\\\qthelp\\\\smmap.qhcp\\n\\techo.To view the help file:\\n\\techo.^> assistant -collectionFile %BUILDDIR%\\\\qthelp\\\\smmap.ghc\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"latex\\\" (\\n\\t%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\\n\\techo.\\n\\techo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"changes\\\" (\\n\\t%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\\n\\techo.\\n\\techo.The overview file is in %BUILDDIR%/changes.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"linkcheck\\\" (\\n\\t%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\\n\\techo.\\n\\techo.Link check complete; look for any errors in the above output ^\\nor in %BUILDDIR%/linkcheck/output.txt.\\n\\tgoto end\\n)\\n\\nif \\\"%1\\\" == \\\"doctest\\\" (\\n\\t%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\\n\\techo.\\n\\techo.Testing of doctests in the sources finished, look at the ^\\nresults in %BUILDDIR%/doctest/output.txt.\\n\\tgoto end\\n)\\n\\n:end\\n\\n[end of doc/make.bat]\",\n \"filename\": \"doc/make.bat\",\n \"id\": \"15\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.mman import (\\n WindowCursor,\\n SlidingWindowMapManager,\\n StaticWindowMapManager\\n)\\nfrom smmap.util import align_to_mmap\\n\\nfrom random import randint\\nfrom time import time\\nimport os\\nimport sys\\nfrom copy import copy\\n\\n\\nclass TestMMan(TestBase):\\n\\n def test_cursor(self):\\n with FileCreator(self.k_window_test_size, \\\"cursor_test\\\") as fc:\\n man = SlidingWindowMapManager()\\n ci = WindowCursor(man) # invalid cursor\\n assert not ci.is_valid()\\n assert not ci.is_associated()\\n assert ci.size() == 0 # this is cached, so we can query it in invalid state\\n\\n cv = man.make_cursor(fc.path)\\n assert not cv.is_valid() # no region mapped yet\\n assert cv.is_associated() # but it know where to map it from\\n assert cv.file_size() == fc.size\\n assert cv.path() == fc.path\\n\\n # copy module\\n cio = copy(cv)\\n assert not cio.is_valid() and cio.is_associated()\\n\\n # assign method\\n assert not ci.is_associated()\\n ci.assign(cv)\\n assert not ci.is_valid() and ci.is_associated()\\n\\n # unuse non-existing region is fine\\n cv.unuse_region()\\n cv.unuse_region()\\n\\n # destruction is fine (even multiple times)\\n cv._destroy()\\n WindowCursor(man)._destroy()\\n\\n def test_memory_manager(self):\\n slide_man = SlidingWindowMapManager()\\n static_man = StaticWindowMapManager()\\n\\n for man in (static_man, slide_man):\\n assert man.num_file_handles() == 0\\n assert man.num_open_files() == 0\\n winsize_cmp_val = 0\\n if isinstance(man, StaticWindowMapManager):\\n winsize_cmp_val = -1\\n # END handle window size\\n assert man.window_size() > winsize_cmp_val\\n assert man.mapped_memory_size() == 0\\n assert man.max_mapped_memory_size() > 0\\n\\n # collection doesn't raise in 'any' mode\\n man._collect_lru_region(0)\\n # doesn't raise if we are within the limit\\n man._collect_lru_region(10)\\n\\n # doesn't fail if we over-allocate\\n assert man._collect_lru_region(sys.maxsize) == 0\\n\\n # use a region, verify most basic functionality\\n with FileCreator(self.k_window_test_size, \\\"manager_test\\\") as fc:\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n for item in (fc.path, fd):\\n c = man.make_cursor(item)\\n assert c.path_or_fd() is item\\n assert c.use_region(10, 10).is_valid()\\n assert c.ofs_begin() == 10\\n assert c.size() == 10\\n with open(fc.path, 'rb') as fp:\\n assert c.buffer()[:] == fp.read(20)[10:]\\n\\n if isinstance(item, int):\\n self.assertRaises(ValueError, c.path)\\n else:\\n self.assertRaises(ValueError, c.fd)\\n # END handle value error\\n # END for each input\\n finally:\\n os.close(fd)\\n # END for each manasger type\\n\\n def test_memman_operation(self):\\n # test more access, force it to actually unmap regions\\n with FileCreator(self.k_window_test_size, \\\"manager_operation_test\\\") as fc:\\n with open(fc.path, 'rb') as fp:\\n data = fp.read()\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n max_num_handles = 15\\n # small_size =\\n for mtype, args in ((StaticWindowMapManager, (0, fc.size // 3, max_num_handles)),\\n (SlidingWindowMapManager, (fc.size // 100, fc.size // 3, max_num_handles)),):\\n for item in (fc.path, fd):\\n assert len(data) == fc.size\\n\\n # small windows, a reasonable max memory. Not too many regions at once\\n man = mtype(window_size=args[0], max_memory_size=args[1], max_open_handles=args[2])\\n c = man.make_cursor(item)\\n\\n # still empty (more about that is tested in test_memory_manager()\\n assert man.num_open_files() == 0\\n assert man.mapped_memory_size() == 0\\n\\n base_offset = 5000\\n # window size is 0 for static managers, hence size will be 0. We take that into consideration\\n size = man.window_size() // 2\\n assert c.use_region(base_offset, size).is_valid()\\n rr = c.region()\\n assert rr.client_count() == 2 # the manager and the cursor and us\\n\\n assert man.num_open_files() == 1\\n assert man.num_file_handles() == 1\\n assert man.mapped_memory_size() == rr.size()\\n\\n # assert c.size() == size # the cursor may overallocate in its static version\\n assert c.ofs_begin() == base_offset\\n assert rr.ofs_begin() == 0 # it was aligned and expanded\\n if man.window_size():\\n # but isn't larger than the max window (aligned)\\n assert rr.size() == align_to_mmap(man.window_size(), True)\\n else:\\n assert rr.size() == fc.size\\n # END ignore static managers which dont use windows and are aligned to file boundaries\\n\\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\\n\\n # obtain second window, which spans the first part of the file - it is a still the same window\\n nsize = (size or fc.size) - 10\\n assert c.use_region(0, nsize).is_valid()\\n assert c.region() == rr\\n assert man.num_file_handles() == 1\\n assert c.size() == nsize\\n assert c.ofs_begin() == 0\\n assert c.buffer()[:] == data[:nsize]\\n\\n # map some part at the end, our requested size cannot be kept\\n overshoot = 4000\\n base_offset = fc.size - (size or c.size()) + overshoot\\n assert c.use_region(base_offset, size).is_valid()\\n if man.window_size():\\n assert man.num_file_handles() == 2\\n assert c.size() < size\\n assert c.region() is not rr # old region is still available, but has not cursor ref anymore\\n assert rr.client_count() == 1 # only held by manager\\n else:\\n assert c.size() < fc.size\\n # END ignore static managers which only have one handle per file\\n rr = c.region()\\n assert rr.client_count() == 2 # manager + cursor\\n assert rr.ofs_begin() < c.ofs_begin() # it should have extended itself to the left\\n assert rr.ofs_end() <= fc.size # it cannot be larger than the file\\n assert c.buffer()[:] == data[base_offset:base_offset + (size or c.size())]\\n\\n # unising a region makes the cursor invalid\\n c.unuse_region()\\n assert not c.is_valid()\\n if man.window_size():\\n # but doesn't change anything regarding the handle count - we cache it and only\\n # remove mapped regions if we have to\\n assert man.num_file_handles() == 2\\n # END ignore this for static managers\\n\\n # iterate through the windows, verify data contents\\n # this will trigger map collection after a while\\n max_random_accesses = 5000\\n num_random_accesses = max_random_accesses\\n memory_read = 0\\n st = time()\\n\\n # cache everything to get some more performance\\n includes_ofs = c.includes_ofs\\n max_mapped_memory_size = man.max_mapped_memory_size()\\n max_file_handles = man.max_file_handles()\\n mapped_memory_size = man.mapped_memory_size\\n num_file_handles = man.num_file_handles\\n while num_random_accesses:\\n num_random_accesses -= 1\\n base_offset = randint(0, fc.size - 1)\\n\\n # precondition\\n if man.window_size():\\n assert max_mapped_memory_size >= mapped_memory_size()\\n # END statistics will overshoot, which is fine\\n assert max_file_handles >= num_file_handles()\\n assert c.use_region(base_offset, (size or c.size())).is_valid()\\n csize = c.size()\\n assert c.buffer()[:] == data[base_offset:base_offset + csize]\\n memory_read += csize\\n\\n assert includes_ofs(base_offset)\\n assert includes_ofs(base_offset + csize - 1)\\n assert not includes_ofs(base_offset + csize)\\n # END while we should do an access\\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\\n mb = float(1000 * 1000)\\n print(\\\"%s: Read %i mb of memory with %i random on cursor initialized with %s accesses in %fs (%f mb/s)\\\\n\\\"\\n % (mtype, memory_read / mb, max_random_accesses, type(item), elapsed, (memory_read / mb) / elapsed),\\n file=sys.stderr)\\n\\n # an offset as large as the size doesn't work !\\n assert not c.use_region(fc.size, size).is_valid()\\n\\n # collection - it should be able to collect all\\n assert man.num_file_handles()\\n assert man.collect()\\n assert man.num_file_handles() == 0\\n # END for each item\\n # END for each manager type\\n finally:\\n os.close(fd)\\n\\n[end of smmap/test/test_mman.py]\",\n \"filename\": \"smmap/test/test_mman.py\",\n \"id\": \"16\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Provide base classes for the test system\\\"\\\"\\\"\\nfrom unittest import TestCase\\nimport os\\nimport tempfile\\n\\n__all__ = ['TestBase', 'FileCreator']\\n\\n\\n#{ Utilities\\n\\nclass FileCreator:\\n\\n \\\"\\\"\\\"A instance which creates a temporary file with a prefix and a given size\\n and provides this info to the user.\\n Once it gets deleted, it will remove the temporary file as well.\\\"\\\"\\\"\\n __slots__ = (\\\"_size\\\", \\\"_path\\\")\\n\\n def __init__(self, size, prefix=''):\\n assert size, \\\"Require size to be larger 0\\\"\\n\\n self._size = size\\n\\n with tempfile.NamedTemporaryFile(\\\"wb\\\", prefix=prefix, delete=False) as file:\\n self._path = file.name\\n file.seek(size - 1)\\n file.write(b'1')\\n\\n assert os.path.getsize(self.path) == size\\n\\n def __del__(self):\\n try:\\n os.remove(self.path)\\n except OSError:\\n pass\\n # END exception handling\\n\\n def __enter__(self):\\n return self\\n\\n def __exit__(self, exc_type, exc_value, traceback):\\n self.__del__()\\n\\n @property\\n def path(self):\\n return self._path\\n\\n @property\\n def size(self):\\n return self._size\\n\\n#} END utilities\\n\\n\\nclass TestBase(TestCase):\\n\\n \\\"\\\"\\\"Foundation used by all tests\\\"\\\"\\\"\\n\\n #{ Configuration\\n k_window_test_size = 1000 * 1000 * 8 + 5195\\n #} END configuration\\n\\n #{ Overrides\\n @classmethod\\n def setUpAll(cls):\\n # nothing for now\\n pass\\n\\n # END overrides\\n\\n #{ Interface\\n\\n #} END interface\\n\\n[end of smmap/test/lib.py]\",\n \"filename\": \"smmap/test/lib.py\",\n \"id\": \"17\"\n },\n {\n \"content\": \"[end of smmap/test/__init__.py]\",\n \"filename\": \"smmap/test/__init__.py\",\n \"id\": \"18\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.mman import (\\n SlidingWindowMapManager,\\n StaticWindowMapManager\\n)\\nfrom smmap.buf import SlidingWindowMapBuffer\\n\\nfrom random import randint\\nfrom time import time\\nimport sys\\nimport os\\n\\n\\nman_optimal = SlidingWindowMapManager()\\nman_worst_case = SlidingWindowMapManager(\\n window_size=TestBase.k_window_test_size // 100,\\n max_memory_size=TestBase.k_window_test_size // 3,\\n max_open_handles=15)\\nstatic_man = StaticWindowMapManager()\\n\\n\\nclass TestBuf(TestBase):\\n\\n def test_basics(self):\\n with FileCreator(self.k_window_test_size, \\\"buffer_test\\\") as fc:\\n\\n # invalid paths fail upon construction\\n c = man_optimal.make_cursor(fc.path)\\n self.assertRaises(ValueError, SlidingWindowMapBuffer, type(c)()) # invalid cursor\\n self.assertRaises(ValueError, SlidingWindowMapBuffer, c, fc.size) # offset too large\\n\\n buf = SlidingWindowMapBuffer() # can create uninitialized buffers\\n assert buf.cursor() is None\\n\\n # can call end access any time\\n buf.end_access()\\n buf.end_access()\\n assert len(buf) == 0\\n\\n # begin access can revive it, if the offset is suitable\\n offset = 100\\n assert buf.begin_access(c, fc.size) == False\\n assert buf.begin_access(c, offset) == True\\n assert len(buf) == fc.size - offset\\n assert buf.cursor().is_valid()\\n\\n # empty begin access keeps it valid on the same path, but alters the offset\\n assert buf.begin_access() == True\\n assert len(buf) == fc.size\\n assert buf.cursor().is_valid()\\n\\n # simple access\\n with open(fc.path, 'rb') as fp:\\n data = fp.read()\\n assert data[offset] == buf[0]\\n assert data[offset:offset * 2] == buf[0:offset]\\n\\n # negative indices, partial slices\\n assert buf[-1] == buf[len(buf) - 1]\\n assert buf[-10:] == buf[len(buf) - 10:len(buf)]\\n\\n # end access makes its cursor invalid\\n buf.end_access()\\n assert not buf.cursor().is_valid()\\n assert buf.cursor().is_associated() # but it remains associated\\n\\n # an empty begin access fixes it up again\\n assert buf.begin_access() == True and buf.cursor().is_valid()\\n del(buf) # ends access automatically\\n del(c)\\n\\n assert man_optimal.num_file_handles() == 1\\n\\n # PERFORMANCE\\n # blast away with random access and a full mapping - we don't want to\\n # exaggerate the manager's overhead, but measure the buffer overhead\\n # We do it once with an optimal setting, and with a worse manager which\\n # will produce small mappings only !\\n max_num_accesses = 100\\n fd = os.open(fc.path, os.O_RDONLY)\\n for item in (fc.path, fd):\\n for manager, man_id in ((man_optimal, 'optimal'),\\n (man_worst_case, 'worst case'),\\n (static_man, 'static optimal')):\\n buf = SlidingWindowMapBuffer(manager.make_cursor(item))\\n assert manager.num_file_handles() == 1\\n for access_mode in range(2): # single, multi\\n num_accesses_left = max_num_accesses\\n num_bytes = 0\\n fsize = fc.size\\n\\n st = time()\\n buf.begin_access()\\n while num_accesses_left:\\n num_accesses_left -= 1\\n if access_mode: # multi\\n ofs_start = randint(0, fsize)\\n ofs_end = randint(ofs_start, fsize)\\n d = buf[ofs_start:ofs_end]\\n assert len(d) == ofs_end - ofs_start\\n assert d == data[ofs_start:ofs_end]\\n num_bytes += len(d)\\n del d\\n else:\\n pos = randint(0, fsize)\\n assert buf[pos] == data[pos]\\n num_bytes += 1\\n # END handle mode\\n # END handle num accesses\\n\\n buf.end_access()\\n assert manager.num_file_handles()\\n assert manager.collect()\\n assert manager.num_file_handles() == 0\\n elapsed = max(time() - st, 0.001) # prevent zero division errors on windows\\n mb = float(1000 * 1000)\\n mode_str = (access_mode and \\\"slice\\\") or \\\"single byte\\\"\\n print(\\\"%s: Made %i random %s accesses to buffer created from %s reading a total of %f mb in %f s (%f mb/s)\\\"\\n % (man_id, max_num_accesses, mode_str, type(item), num_bytes / mb, elapsed, (num_bytes / mb) / elapsed),\\n file=sys.stderr)\\n # END handle access mode\\n del buf\\n # END for each manager\\n # END for each input\\n os.close(fd)\\n\\n[end of smmap/test/test_buf.py]\",\n \"filename\": \"smmap/test/test_buf.py\",\n \"id\": \"19\"\n },\n {\n \"content\": \"from .lib import TestBase, FileCreator\\n\\nfrom smmap.util import (\\n MapWindow,\\n MapRegion,\\n MapRegionList,\\n ALLOCATIONGRANULARITY,\\n is_64_bit,\\n align_to_mmap\\n)\\n\\nimport os\\nimport sys\\n\\n\\nclass TestMMan(TestBase):\\n\\n def test_window(self):\\n wl = MapWindow(0, 1) # left\\n wc = MapWindow(1, 1) # center\\n wc2 = MapWindow(10, 5) # another center\\n wr = MapWindow(8000, 50) # right\\n\\n assert wl.ofs_end() == 1\\n assert wc.ofs_end() == 2\\n assert wr.ofs_end() == 8050\\n\\n # extension does nothing if already in place\\n maxsize = 100\\n wc.extend_left_to(wl, maxsize)\\n assert wc.ofs == 1 and wc.size == 1\\n wl.extend_right_to(wc, maxsize)\\n wl.extend_right_to(wc, maxsize)\\n assert wl.ofs == 0 and wl.size == 1\\n\\n # an actual left extension\\n pofs_end = wc2.ofs_end()\\n wc2.extend_left_to(wc, maxsize)\\n assert wc2.ofs == wc.ofs_end() and pofs_end == wc2.ofs_end()\\n\\n # respects maxsize\\n wc.extend_right_to(wr, maxsize)\\n assert wc.ofs == 1 and wc.size == maxsize\\n wc.extend_right_to(wr, maxsize)\\n assert wc.ofs == 1 and wc.size == maxsize\\n\\n # without maxsize\\n wc.extend_right_to(wr, sys.maxsize)\\n assert wc.ofs_end() == wr.ofs and wc.ofs == 1\\n\\n # extend left\\n wr.extend_left_to(wc2, maxsize)\\n wr.extend_left_to(wc2, maxsize)\\n assert wr.size == maxsize\\n\\n wr.extend_left_to(wc2, sys.maxsize)\\n assert wr.ofs == wc2.ofs_end()\\n\\n wc.align()\\n assert wc.ofs == 0 and wc.size == align_to_mmap(wc.size, True)\\n\\n def test_region(self):\\n with FileCreator(self.k_window_test_size, \\\"window_test\\\") as fc:\\n half_size = fc.size // 2\\n rofs = align_to_mmap(4200, False)\\n rfull = MapRegion(fc.path, 0, fc.size)\\n rhalfofs = MapRegion(fc.path, rofs, fc.size)\\n rhalfsize = MapRegion(fc.path, 0, half_size)\\n\\n # offsets\\n assert rfull.ofs_begin() == 0 and rfull.size() == fc.size\\n assert rfull.ofs_end() == fc.size # if this method works, it works always\\n\\n assert rhalfofs.ofs_begin() == rofs and rhalfofs.size() == fc.size - rofs\\n assert rhalfsize.ofs_begin() == 0 and rhalfsize.size() == half_size\\n\\n assert rfull.includes_ofs(0) and rfull.includes_ofs(fc.size - 1) and rfull.includes_ofs(half_size)\\n assert not rfull.includes_ofs(-1) and not rfull.includes_ofs(sys.maxsize)\\n\\n # auto-refcount\\n assert rfull.client_count() == 1\\n rfull2 = rfull\\n assert rfull.client_count() == 1, \\\"no auto-counting\\\"\\n\\n # window constructor\\n w = MapWindow.from_region(rfull)\\n assert w.ofs == rfull.ofs_begin() and w.ofs_end() == rfull.ofs_end()\\n\\n def test_region_list(self):\\n with FileCreator(100, \\\"sample_file\\\") as fc:\\n fd = os.open(fc.path, os.O_RDONLY)\\n try:\\n for item in (fc.path, fd):\\n ml = MapRegionList(item)\\n\\n assert len(ml) == 0\\n assert ml.path_or_fd() == item\\n assert ml.file_size() == fc.size\\n finally:\\n os.close(fd)\\n\\n def test_util(self):\\n assert isinstance(is_64_bit(), bool) # just call it\\n assert align_to_mmap(1, False) == 0\\n assert align_to_mmap(1, True) == ALLOCATIONGRANULARITY\\n\\n[end of smmap/test/test_util.py]\",\n \"filename\": \"smmap/test/test_util.py\",\n \"id\": \"20\"\n },\n {\n \"content\": \"from .lib import TestBase\\n\\n\\nclass TestTutorial(TestBase):\\n\\n def test_example(self):\\n # Memory Managers\\n ##################\\n import smmap\\n # This instance should be globally available in your application\\n # It is configured to be well suitable for 32-bit or 64 bit applications.\\n mman = smmap.SlidingWindowMapManager()\\n\\n # the manager provides much useful information about its current state\\n # like the amount of open file handles or the amount of mapped memory\\n assert mman.num_file_handles() == 0\\n assert mman.mapped_memory_size() == 0\\n # and many more ...\\n\\n # Cursors\\n ##########\\n import smmap.test.lib\\n with smmap.test.lib.FileCreator(1024 * 1024 * 8, \\\"test_file\\\") as fc:\\n # obtain a cursor to access some file.\\n c = mman.make_cursor(fc.path)\\n\\n # the cursor is now associated with the file, but not yet usable\\n assert c.is_associated()\\n assert not c.is_valid()\\n\\n # before you can use the cursor, you have to specify a window you want to\\n # access. The following just says you want as much data as possible starting\\n # from offset 0.\\n # To be sure your region could be mapped, query for validity\\n assert c.use_region().is_valid() # use_region returns self\\n\\n # once a region was mapped, you must query its dimension regularly\\n # to assure you don't try to access its buffer out of its bounds\\n assert c.size()\\n c.buffer()[0] # first byte\\n c.buffer()[1:10] # first 9 bytes\\n c.buffer()[c.size() - 1] # last byte\\n\\n # you can query absolute offsets, and check whether an offset is included\\n # in the cursor's data.\\n assert c.ofs_begin() < c.ofs_end()\\n assert c.includes_ofs(100)\\n\\n # If you are over out of bounds with one of your region requests, the\\n # cursor will be come invalid. It cannot be used in that state\\n assert not c.use_region(fc.size, 100).is_valid()\\n # map as much as possible after skipping the first 100 bytes\\n assert c.use_region(100).is_valid()\\n\\n # You can explicitly free cursor resources by unusing the cursor's region\\n c.unuse_region()\\n assert not c.is_valid()\\n\\n # Buffers\\n #########\\n # Create a default buffer which can operate on the whole file\\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\\n\\n # you can use it right away\\n assert buf.cursor().is_valid()\\n\\n buf[0] # access the first byte\\n buf[-1] # access the last ten bytes on the file\\n buf[-10:] # access the last ten bytes\\n\\n # If you want to keep the instance between different accesses, use the\\n # dedicated methods\\n buf.end_access()\\n assert not buf.cursor().is_valid() # you cannot use the buffer anymore\\n assert buf.begin_access(offset=10) # start using the buffer at an offset\\n\\n[end of smmap/test/test_tutorial.py]\",\n \"filename\": \"smmap/test/test_tutorial.py\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. smmap documentation master file, created by\\n sphinx-quickstart on Wed Jun 8 15:14:25 2011.\\n You can adapt this file completely to your liking, but it should at least\\n contain the root `toctree` directive.\\n\\nWelcome to smmap's documentation!\\n=================================\\n**smmap** is a pure python implementation of a sliding memory map to help unifying memory mapped access on 32 and 64 bit systems and to help managing resources more efficiently.\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n \\n intro\\n tutorial\\n api\\n changes\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of doc/source/index.rst]\",\n \"filename\": \"doc/source/index.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"###########\\nMotivation\\n###########\\nWhen reading from many possibly large files in a fashion similar to random access, it is usually the fastest and most efficient to use memory maps.\\n\\nAlthough memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.\\n\\n########\\nOverview\\n########\\n\\nSmmap wraps an interface around mmap and tracks the mapped files as well as the amount of clients who use it. If the system runs out of resources, or if a memory limit is reached, it will automatically unload unused maps to allow continued operation.\\n\\nTo allow processing large files even on 32 bit systems, it allows only portions of the file to be mapped. Once the user reads beyond the mapped region, smmap will automatically map the next required region, unloading unused regions using a LRU algorithm.\\n\\nAlthough the library can be used most efficiently with its native interface, a Buffer implementation is provided to hide these details behind a simple string-like interface.\\n\\nFor performance critical 64 bit applications, a simplified version of memory mapping is provided which always maps the whole file, but still provides the benefit of unloading unused mappings on demand.\\n\\n#############\\nPrerequisites\\n#############\\n* Python 3.7+\\n* OSX, Windows or Linux\\n\\nThe package was tested on all of the previously mentioned configurations.\\n\\n###########\\nLimitations\\n###########\\n* The memory access is read-only by design.\\n\\n################\\nInstalling smmap\\n################\\nIts easiest to install smmap using the *pip* program::\\n \\n $ pip install smmap\\n \\nAs the command will install smmap in your respective python distribution, you will most likely need root permissions to authorize the required changes.\\n\\nIf you have downloaded the source archive, the package can be installed by running the ``setup.py`` script::\\n \\n $ python setup.py install\\n\\nIt is advised to have a look at the :ref:`Usage Guide <tutorial-label>` for a brief introduction on the different database implementations.\\n\\n##################\\nHomepage and Links\\n##################\\nThe project is home on github at `https://github.com/gitpython-developers/smmap <https://github.com/gitpython-developers/smmap>`_.\\n\\nThe latest source can be cloned from github as well:\\n\\n * git://github.com/gitpython-developers/smmap.git\\n \\n \\nFor support, please use the git-python mailing list:\\n\\n * http://groups.google.com/group/git-python\\n \\n\\nIssues can be filed on github:\\n\\n * https://github.com/gitpython-developers/smmap/issues\\n \\n###################\\nLicense Information\\n###################\\n*smmap* is licensed under the New BSD License.\\n\\n.. _pip: http://www.pip-installer.org/en/latest/\\n\\n[end of doc/source/intro.rst]\",\n \"filename\": \"doc/source/intro.rst\",\n \"id\": \"23\"\n },\n {\n \"content\": \"#\\n# smmap documentation build configuration file, created by\\n# sphinx-quickstart on Wed Jun 8 15:14:25 2011.\\n#\\n# This file is execfile()d with the current directory set to its containing dir.\\n#\\n# Note that not all possible configuration values are present in this\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.append(os.path.abspath('../../'))\\n\\n# -- General configuration -----------------------------------------------------\\n\\n# Add any Sphinx extension module names here, as strings. They can be extensions\\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['.templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = 'smmap'\\ncopyright = '2011, Sebastian Thiel'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.8.0'\\n# The full version, including alpha/beta/rc tags.\\nrelease = '0.8.0'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of documents that shouldn't be included in the build.\\n#unused_docs = []\\n\\n# List of directories, relative to source directory, that shouldn't be searched\\n# for source files.\\nexclude_trees = []\\n\\n# The reST default role (used for this markup: `text`) to use for all documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n\\n# -- Options for HTML output ---------------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. Major themes that come with\\n# Sphinx are currently 'default' and 'sphinxdoc'.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['.static']\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_use_modindex = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# If nonempty, this is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = ''\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'smmapdoc'\\n\\n\\n# -- Options for LaTeX output --------------------------------------------------\\n\\n# The paper size ('letter' or 'a4').\\n#latex_paper_size = 'letter'\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#latex_font_size = '10pt'\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title, author, documentclass [howto/manual]).\\nlatex_documents = [\\n ('index', 'smmap.tex', 'smmap Documentation',\\n 'Sebastian Thiel', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# Additional stuff for the LaTeX preamble.\\n#latex_preamble = ''\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_use_modindex = True\\n\\n[end of doc/source/conf.py]\",\n \"filename\": \"doc/source/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \".. _tutorial-label:\\n\\n###########\\nUsage Guide\\n###########\\nThis text briefly introduces you to the basic design decisions and accompanying classes.\\n\\n******\\nDesign\\n******\\nPer application, there is *MemoryManager* which is held as static instance and used throughout the application. It can be configured to keep your resources within certain limits.\\n\\nTo access mapped regions, you require a cursor. Cursors point to exactly one file and serve as handles into it. As long as it exists, the respective memory region will remain available.\\n\\nFor convenience, a buffer implementation is provided which handles cursors and resource allocation behind its simple buffer like interface.\\n\\n***************\\nMemory Managers\\n***************\\nThere are two types of memory managers, one uses *static* windows, the other one uses *sliding* windows. A window is a region of a file mapped into memory. Although the names might be somewhat misleading as technically windows are always static, the *sliding* version will allocate relatively small windows whereas the *static* version will always map the whole file.\\n\\nThe *static* manager does nothing more than keeping a client count on the respective memory maps which always map the whole file, which allows to make some assumptions that can lead to simplified data access and increased performance, but reduces the compatibility to 32 bit systems or giant files.\\n\\nThe *sliding* memory manager therefore should be the default manager when preparing an application for handling huge amounts of data on 32 bit and 64 bit platforms::\\n\\n import smmap\\n # This instance should be globally available in your application\\n # It is configured to be well suitable for 32-bit or 64 bit applications.\\n mman = smmap.SlidingWindowMapManager()\\n \\n # the manager provides much useful information about its current state\\n # like the amount of open file handles or the amount of mapped memory\\n mman.num_file_handles()\\n mman.mapped_memory_size()\\n # and many more ...\\n\\n\\nCursors\\n*******\\n*Cursors* are handles that point onto a window, i.e. a region of a file mapped into memory. From them you may obtain a buffer through which the data of that window can actually be accessed::\\n\\n import smmap.test.lib\\n fc = smmap.test.lib.FileCreator(1024*1024*8, \\\"test_file\\\")\\n \\n # obtain a cursor to access some file.\\n c = mman.make_cursor(fc.path)\\n \\n # the cursor is now associated with the file, but not yet usable\\n assert c.is_associated()\\n assert not c.is_valid()\\n \\n # before you can use the cursor, you have to specify a window you want to \\n # access. The following just says you want as much data as possible starting\\n # from offset 0.\\n # To be sure your region could be mapped, query for validity\\n assert c.use_region().is_valid()\\t\\t# use_region returns self\\n \\n # once a region was mapped, you must query its dimension regularly\\n # to assure you don't try to access its buffer out of its bounds\\n assert c.size()\\n c.buffer()[0]\\t\\t\\t# first byte\\n c.buffer()[1:10]\\t\\t\\t# first 9 bytes\\n c.buffer()[c.size()-1] \\t# last byte\\n \\n # its recommended not to create big slices when feeding the buffer\\n # into consumers (e.g. struct or zlib). \\n # Instead, either give the buffer directly, or use pythons buffer command.\\n buffer(c.buffer(), 1, 9)\\t# first 9 bytes without copying them\\n \\n # you can query absolute offsets, and check whether an offset is included\\n # in the cursor's data.\\n assert c.ofs_begin() < c.ofs_end()\\n assert c.includes_ofs(100)\\n \\n # If you are over out of bounds with one of your region requests, the \\n # cursor will be come invalid. It cannot be used in that state\\n assert not c.use_region(fc.size, 100).is_valid()\\n # map as much as possible after skipping the first 100 bytes\\n assert c.use_region(100).is_valid()\\n \\n # You can explicitly free cursor resources by unusing the cursor's region\\n c.unuse_region()\\n assert not c.is_valid()\\n \\n\\nNow you would have to write your algorithms around this interface to properly slide through huge amounts of data. \\n \\nAlternatively you can use a convenience interface.\\n\\n*******\\nBuffers\\n*******\\nTo make first use easier, at the expense of performance, there is a Buffer implementation which uses a cursor underneath.\\n\\nWith it, you can access all data in a possibly huge file without having to take care of setting the cursor to different regions yourself::\\n\\n # Create a default buffer which can operate on the whole file\\n buf = smmap.SlidingWindowMapBuffer(mman.make_cursor(fc.path))\\n \\n # you can use it right away\\n assert buf.cursor().is_valid()\\n \\n buf[0]\\t# access the first byte\\n buf[-1]\\t# access the last ten bytes on the file\\n buf[-10:]# access the last ten bytes\\n \\n # If you want to keep the instance between different accesses, use the\\n # dedicated methods\\n buf.end_access()\\n assert not buf.cursor().is_valid()\\t# you cannot use the buffer anymore\\n assert buf.begin_access(offset=10)\\t# start using the buffer at an offset\\n \\n # it will stop using resources automatically once it goes out of scope\\n \\nDisadvantages\\n*************\\nBuffers cannot be used in place of strings or maps, hence you have to slice them to have valid input for the sorts of struct and zlib. A slice means a lot of data handling overhead which makes buffers slower compared to using cursors directly. \\n\\n\\n[end of doc/source/tutorial.rst]\",\n \"filename\": \"doc/source/tutorial.rst\",\n \"id\": \"25\"\n },\n {\n \"content\": \"#########\\nChangelog\\n#########\\n\\n******\\nv5.0.2\\n******\\n\\n- remove a usage of mktemp\\n\\n******\\nv5.0.1\\n******\\n\\n- Added support for Python 3.12\\n\\n******\\nv6.0.0\\n******\\n\\nYANKED\\n\\n- Dropped support 3.6 and 3.7\\n- Declared support for Python 3.11 and 3.12\\n\\n******\\nv5.0.0\\n******\\n\\n- Dropped support 3.5\\n- Added support for Python 3.10\\n\\n******\\nv4.0.0\\n******\\n\\n- Dropped support for Python 2.7 and 3.4\\n- Added support for Python 3.7, 3.8, and 3.9\\n- Removed unused exc.MemoryManagerError and exc.RegionCollectionError\\n\\n******\\nv3.0.5\\n******\\n\\n- Restored Python 2 support removed in v3.0.2\\n- Changed release signature key to 27C50E7F590947D7273A741E85194C08421980C9.\\n See https://keybase.io/byronbates for proof of ownership.\\n\\n******\\nv3.0.4\\n******\\n\\n- Signed release (with correct key this time)\\n\\n******\\nv3.0.2\\n******\\n\\n- Signed release\\n- Switched to GitHub Actions for CI\\n\\n******\\nv3.0.1\\n******\\n- Switched back to the smmap package name on PyPI and fixed the smmap2 mirror package\\n (`#44 <https://github.com/gitpython-developers/smmap/issues/44>`_)\\n- Fixed setup.py ``long_description`` rendering\\n (`#40 <https://github.com/gitpython-developers/smmap/pull/40>`_)\\n\\n**********\\nv0.9.0\\n**********\\n- Fixed issue with resources never being freed as mmaps were never closed.\\n- Client counting is now done manually, instead of relying on pyton's reference count\\n\\n**********\\nv0.8.5\\n**********\\n- Fixed Python 3.0-3.3 regression, which also causes smmap to become about 3 times slower depending on the code path. It's related to this bug (http://bugs.python.org/issue15958), which was fixed in python 3.4\\n\\n**********\\nv0.8.4\\n**********\\n- Fixed Python 3 performance regression\\n\\n**********\\nv0.8.3\\n**********\\n- Cleaned up code and assured it works sufficiently well with python 3\\n\\n**********\\nv0.8.1\\n**********\\n- A single bugfix\\n\\n**********\\nv0.8.0 \\n**********\\n\\n- Initial Release\\n\\n[end of doc/source/changes.rst]\",\n \"filename\": \"doc/source/changes.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \".. _api-label:\\n\\n#############\\nAPI Reference\\n#############\\n\\n***********************\\nMapped Memory Managers\\n***********************\\n\\n.. automodule:: smmap.mman\\n :members:\\n :undoc-members:\\n\\n*******\\nBuffers\\n*******\\n\\n.. automodule:: smmap.buf\\n :members:\\n :undoc-members:\\n\\n*********\\nUtilities\\n*********\\n\\n.. automodule:: smmap.util\\n :members:\\n :undoc-members:\\n\\n\\n\\n\\n\\n\\n[end of doc/source/api.rst]\",\n \"filename\": \"doc/source/api.rst\",\n \"id\": \"27\"\n }\n]","isConversational":false}}},{"rowIdx":73,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 73,\n \"num_files\": 43,\n \"repo_id\": \"repo_0073\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerous itself. Use\none of the following resources for questions about using ItsDangerous or\nissues with your own code:\n\n- The ``#get-help`` channel on our Discord chat:\n https://discord.gg/pallets\n- The mailing list flask@python.org for long term discussion or larger\n issues.\n- Ask on `Stack Overflow`_. Search with Google first using:\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\n\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\n\n\nReporting issues\n----------------\n\nInclude the following information in your post:\n\n- Describe what you expected to happen.\n- If possible, include a `minimal reproducible example`_ to help us\n identify the issue. This also helps check that the issue is not with\n your own code.\n- Describe what actually happened. Include the full traceback if there\n was an exception.\n- List your Python and ItsDangerous versions. If possible, check if\n this issue is already fixed in the latest releases or the latest\n code in the repository.\n\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\n\n\nSubmitting patches\n------------------\n\nIf there is not an open issue for what you want to submit, prefer\nopening one for discussion before working on a PR. You can work on any\nissue that doesn't have an open PR linked to it or a maintainer assigned\nto it. These show up in the sidebar. No need to ask if you can work on\nan issue that interests you.\n\nInclude the following in your patch:\n\n- Use `Black`_ to format your code. This and other tools will run\n automatically if you install `pre-commit`_ using the instructions\n below.\n- Include tests if your patch adds or changes code. Make sure the test\n fails without your patch.\n- Update any relevant docs pages and docstrings. Docs pages and\n docstrings should be wrapped at 72 characters.\n- Add an entry in ``CHANGES.rst``. Use the same style as other\n entries. Also include ``.. versionchanged::`` inline changelogs in\n relevant docstrings.\n\n.. _Black: https://black.readthedocs.io\n.. _pre-commit: https://pre-commit.com\n\n\nFirst time setup\n~~~~~~~~~~~~~~~~\n\n- Download and install the `latest version of git`_.\n- Configure git with your `username`_ and `email`_.\n\n .. code-block:: text\n\n $ git config --global user.name 'your name'\n $ git config --global user.email 'your email'\n\n- Make sure you have a `GitHub account`_.\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\n button.\n- `Clone`_ the main repository locally.\n\n .. code-block:: text\n\n $ git clone https://github.com/pallets/itsdangerous\n $ cd itsdangerous\n\n- Add your fork as a remote to push your work to. Replace\n ``{username}`` with your username. This names the remote \"fork\", the\n default Pallets remote is \"origin\".\n\n .. code-block:: text\n\n $ git remote add fork https://github.com/{username}/itsdangerous\n\n- Create a virtualenv.\n\n .. code-block:: text\n\n $ python3 -m venv env\n $ . env/bin/activate\n\n On Windows, activating is different.\n\n .. code-block:: text\n\n > env\\Scripts\\activate\n\n- Install the development dependencies, then install ItsDangerous in\n editable mode.\n\n .. code-block:: text\n\n $ pip install -r requirements/dev.txt && pip install -e .\n\n- Install the pre-commit hooks.\n\n .. code-block:: text\n\n $ pre-commit install\n\n.. _latest version of git: https://git-scm.com/downloads\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\n.. _GitHub account: https://github.com/join\n.. _Fork: https://github.com/pallets/itsdangerous/fork\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\n\n\nStart coding\n~~~~~~~~~~~~\n\n- Create a branch to identify the issue you would like to work on. If\n you're submitting a bug or documentation fix, branch off of the\n latest \".x\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/2.0.x\n\n If you're submitting a feature addition or change, branch off of the\n \"main\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/main\n\n- Using your favorite editor, make your changes,\n `committing as you go`_.\n- Include tests that cover any code changes you make. Make sure the\n test fails without your patch. Run the tests as described below.\n- Push your commits to your fork on GitHub and\n `create a pull request`_. Link to the issue being addressed with\n ``fixes #123`` in the pull request.\n\n .. code-block:: text\n\n $ git push --set-upstream fork your-branch-name\n\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\n\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nRun the basic test suite with pytest.\n\n.. code-block:: text\n\n $ pytest\n\nThis runs the tests for the current environment, which is usually\nsufficient. CI will run the full suite when you submit your pull\nrequest. You can run the full test suite with tox if you don't want to\nwait.\n\n.. code-block:: text\n\n $ tox\n\n\nRunning test coverage\n~~~~~~~~~~~~~~~~~~~~~\n\nGenerating a report of lines that do not have test coverage can indicate\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\ngenerate a report.\n\n.. code-block:: text\n\n $ pip install coverage\n $ coverage run -m pytest\n $ coverage html\n\nOpen ``htmlcov/index.html`` in your browser to explore the report.\n\nRead more about `coverage <https://coverage.readthedocs.io>`__.\n\n\nBuilding the docs\n~~~~~~~~~~~~~~~~~\n\nBuild the docs in the ``docs`` directory using Sphinx.\n\n.. code-block:: text\n\n $ cd docs\n $ make html\n\nOpen ``_build/html/index.html`` in your browser to view the docs.\n\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\n\n[end of CONTRIBUTING.rst]","filename":"CONTRIBUTING.rst","id":"0"},{"content":"repos:\n - repo: https://github.com/astral-sh/ruff-pre-commit\n rev: v0.7.1\n hooks:\n - id: ruff\n - id: ruff-format\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: check-merge-conflict\n - id: debug-statements\n - id: fix-byte-order-marker\n - id: trailing-whitespace\n - id: end-of-file-fixer\n\n[end of .pre-commit-config.yaml]","filename":".pre-commit-config.yaml","id":"1"},{"content":"[project]\nname = \"itsdangerous\"\nversion = \"2.2.0\"\ndescription = \"Safely pass data to untrusted environments and back.\"\nreadme = \"README.md\"\nlicense = { file = \"LICENSE.txt\" }\nmaintainers = [{ name = \"Pallets\", email = \"contact@palletsprojects.com\" }]\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python\",\n \"Typing :: Typed\",\n]\nrequires-python = \">=3.8\"\n\n[project.urls]\nDonate = \"https://palletsprojects.com/donate\"\nDocumentation = \"https://itsdangerous.palletsprojects.com/\"\nChanges = \"https://itsdangerous.palletsprojects.com/changes/\"\nSource = \"https://github.com/pallets/itsdangerous/\"\nChat = \"https://discord.gg/pallets\"\n\n[build-system]\nrequires = [\"flit_core<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.module]\nname = \"itsdangerous\"\n\n[tool.flit.sdist]\ninclude = [\n \"docs/\",\n \"requirements/\",\n \"tests/\",\n \"CHANGES.rst\",\n \"tox.ini\",\n]\nexclude = [\n \"docs/_build/\",\n]\n\n[tool.pytest.ini_options]\ntestpaths = [\"tests\"]\nfilterwarnings = [\n \"error\",\n]\n\n[tool.coverage.run]\nbranch = true\nsource = [\"itsdangerous\", \"tests\"]\n\n[tool.coverage.paths]\nsource = [\"src\", \"*/site-packages\"]\n\n[tool.mypy]\npython_version = \"3.8\"\nfiles = [\"src/itsdangerous\"]\nshow_error_codes = true\npretty = true\nstrict = true\n\n[tool.pyright]\npythonVersion = \"3.8\"\ninclude = [\"src/itsdangerous\"]\ntypeCheckingMode = \"basic\"\n\n[tool.ruff]\nsrc = [\"src\"]\nfix = true\nshow-fixes = true\noutput-format = \"full\"\n\n[tool.ruff.lint]\nselect = [\n \"B\", # flake8-bugbear\n \"E\", # pycodestyle error\n \"F\", # pyflakes\n \"I\", # isort\n \"UP\", # pyupgrade\n \"W\", # pycodestyle warning\n]\n\n[tool.ruff.lint.isort]\nforce-single-line = true\norder-by-type = false\n\n[tool.gha-update]\ntag-only = [\n \"slsa-framework/slsa-github-generator\",\n]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"root = true\n\n[*]\nindent_style = space\nindent_size = 4\ninsert_final_newline = true\ntrim_trailing_whitespace = true\nend_of_line = lf\ncharset = utf-8\nmax_line_length = 88\n\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"3"},{"content":"# ItsDangerous\n\n... so better sign this\n\nVarious helpers to pass data to untrusted environments and to get it\nback safe and sound. Data is cryptographically signed to ensure that a\ntoken has not been tampered with.\n\nIt's possible to customize how data is serialized. Data is compressed as\nneeded. A timestamp can be added and verified automatically while\nloading a token.\n\n\n## A Simple Example\n\nHere's how you could generate a token for transmitting a user's id and\nname between web requests.\n\n```python\nfrom itsdangerous import URLSafeSerializer\nauth_s = URLSafeSerializer(\"secret key\", \"auth\")\ntoken = auth_s.dumps({\"id\": 5, \"name\": \"itsdangerous\"})\n\nprint(token)\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\n\ndata = auth_s.loads(token)\nprint(data[\"name\"])\n# itsdangerous\n```\n\n\n## Donate\n\nThe Pallets organization develops and supports ItsDangerous and other\npopular packages. In order to grow the community of contributors and\nusers, and allow the maintainers to devote more time to the projects,\n[please donate today][].\n\n[please donate today]: https://palletsprojects.com/donate\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"[tox]\nenvlist =\n py3{13,12,11,10,9,8}\n pypy310\n style\n typing\n docs\nskip_missing_interpreters = true\n\n[testenv]\npackage = wheel\nwheel_build_env = .pkg\nconstrain_package_deps = true\nuse_frozen_constraints = true\ndeps = -r requirements/tests.txt\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\n\n[testenv:style]\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit run --all-files\n\n[testenv:typing]\ndeps = -r requirements/typing.txt\ncommands =\n mypy\n pyright\n pyright --verifytypes itsdangerous --ignoreexternal\n\n[testenv:docs]\ndeps = -r requirements/docs.txt\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\n\n[testenv:update-actions]\nlabels = update\ndeps = gha-update\ncommands = gha-update\n\n[testenv:update-pre_commit]\nlabels = update\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit autoupdate -j4\n\n[testenv:update-requirements]\nlabels = update\ndeps = pip-tools\nskip_install = true\nchange_dir = requirements\ncommands =\n pip-compile build.in -q {posargs:-U}\n pip-compile docs.in -q {posargs:-U}\n pip-compile tests.in -q {posargs:-U}\n pip-compile typing.in -q {posargs:-U}\n pip-compile dev.in -q {posargs:-U}\n\n[end of tox.ini]","filename":"tox.ini","id":"5"},{"content":"Copyright 2011 Pallets\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n1. Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n2. 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\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE.txt]","filename":"LICENSE.txt","id":"6"},{"content":"Version 2.2.0\n-------------\n\nReleased 2024-04-16\n\n- Drop support for Python 3.7. :pr:`372`\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\n :pr:`326`\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\n- Deprecate the ``__version__`` attribute. Use feature detection, or\n ``importlib.metadata.version(\"itsdangerous\")``, instead. :issue:`371`\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\n different ``serializer`` argument is given, it will try to infer the return\n type of its ``dumps`` method. :issue:`347`\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\n access it at import time so the developer has time to change the default.\n :issue:`375`\n\n\nVersion 2.1.2\n-------------\n\nReleased 2022-03-24\n\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\n\n\nVersion 2.1.1\n-------------\n\nReleased 2022-03-09\n\n- Handle date overflow in timed unsign. :pr:`296`\n\n\nVersion 2.1.0\n-------------\n\nReleased 2022-02-17\n\n- Drop support for Python 3.6. :pr:`272`\n- Remove previously deprecated code. :pr:`273`\n\n - JWS functionality: Use a dedicated library such as Authlib\n instead.\n - ``import itsdangerous.json``: Import ``json`` from the standard\n library instead.\n\n\nVersion 2.0.1\n-------------\n\nReleased 2021-05-18\n\n- Mark top-level names as exported so type checking understands\n imports in user projects. :pr:`240`\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\n ``None`` again. :issue:`237`\n\n\nVersion 2.0.0\n-------------\n\nReleased 2021-05-11\n\n- Drop support for Python 2 and 3.5.\n- JWS support (``JSONWebSignatureSerializer``,\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\n JWS/JWT library such as authlib instead. :issue:`129`\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\n ``json`` module instead. :pr:`152`\n- Simplejson is no longer used if it is installed. To use a different\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\n- If a signature has an age less than 0, it will raise\n ``SignatureExpired`` rather than appearing valid. This can happen if\n the timestamp offset is changed. :issue:`126`\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\n rather than an ``int`` in some cases. :issue:`124`\n- Added support for key rotation. A list of keys can be passed as\n ``secret_key``, oldest to newest. The newest key is used for\n signing, all keys are tried for unsigning. :pr:`141`\n- Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``. :issue:`155`\n- Add type information for static typing tools. :pr:`186`\n\n\nVersion 1.1.0\n-------------\n\nReleased 2018-10-26\n\n- Change default signing algorithm back to SHA-1. :pr:`113`\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\n release which defaulted to SHA-512. :pr:`114`\n- Add support for fallback algorithms during deserialization to\n support changing the default in the future without breaking existing\n signatures. :pr:`113`\n- Changed capitalization of packages back to lowercase as the change\n in capitalization broke some tooling. :pr:`113`\n\n\nVersion 1.0.0\n-------------\n\nReleased 2018-10-18\n\nYANKED\n\n*Note*: This release was yanked from PyPI because it changed the default\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\nat SHA1.\n\n- Drop support for Python 2.6 and 3.3.\n- Refactor code from a single module to a package. Any object in the\n API docs is still importable from the top-level ``itsdangerous``\n name, but other imports will need to be changed. A future release\n will remove many of these compatibility imports. :pr:`107`\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\n :pr:`27`\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\n Python 3. :issue:`29`\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\n- More compact JSON dumps for unicode strings. :issue:`38`\n- Use the full timestamp rather than an offset, allowing dates before\n 2011. :issue:`46`\n\n To retain compatibility with signers from previous versions,\n consider using `this shim <https://github.com/pallets/itsdangerous\n /issues/120#issuecomment-456913331>`_ when unsigning.\n- Detect a ``sep`` character that may show up in the signature itself\n and raise a ``ValueError``. :issue:`62`\n- Use a consistent signature for keyword arguments for\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\n- Convert JWS exp header to an int when loading. :pr:`99`\n\n\nVersion 0.24\n------------\n\nReleased 2014-03-28\n\n- Added a ``BadHeader`` exception that is used for bad headers that\n replaces the old ``BadPayload`` exception that was reused in those\n cases.\n\n\nVersion 0.23\n------------\n\nReleased 2013-08-08\n\n- Fixed a packaging mistake that caused the tests and license files to\n not be included.\n\n\nVersion 0.22\n------------\n\nReleased 2013-07-03\n\n- Added support for ``TimedJSONWebSignatureSerializer``.\n- Made it possible to override the signature verification function to\n allow implementing asymmetrical algorithms.\n\n\nVersion 0.21\n------------\n\nReleased 2013-05-26\n\n- Fixed an issue on Python 3 which caused invalid errors to be\n generated.\n\n\nVersion 0.20\n------------\n\nReleased 2013-05-23\n\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\n ItsDangerous on Python 2.6.\n\n\nVersion 0.19\n------------\n\nReleased 2013-05-21\n\n- Dropped support for 2.5 and added support for 3.3.\n\n\nVersion 0.18\n------------\n\nReleased 2013-05-03\n\n- Added support for JSON Web Signatures (JWS).\n\n\nVersion 0.17\n------------\n\nReleased 2012-08-10\n\n- Fixed a name error when overriding the digest method.\n\n\nVersion 0.16\n------------\n\nReleased 2012-07-11\n\n- Made it possible to pass unicode values to ``load_payload`` to make\n it easier to debug certain things.\n\n\nVersion 0.15\n------------\n\nReleased 2012-07-11\n\n- Made standalone ``load_payload`` more robust by raising one specific\n error if something goes wrong.\n- Refactored exceptions to catch more cases individually, added more\n attributes.\n- Fixed an issue that caused ``load_payload`` not work in some\n situations with timestamp based serializers\n- Added an ``loads_unsafe`` method.\n\n\nVersion 0.14\n------------\n\nReleased 2012-06-29\n\n- API refactoring to support different key derivations.\n- Added attributes to exceptions so that you can inspect the data even\n if the signature check failed.\n\n\nVersion 0.13\n------------\n\nReleased 2012-06-10\n\n- Small API change that enables customization of the digest module.\n\n\nVersion 0.12\n------------\n\nReleased 2012-02-22\n\n- Fixed a problem with the local timezone being used for the epoch\n calculation. This might invalidate some of your signatures if you\n were not running in UTC timezone. You can revert to the old behavior\n by monkey patching ``itsdangerous.EPOCH``.\n\n\nVersion 0.11\n------------\n\nReleased 2011-07-07\n\n- Fixed an uncaught value error.\n\n\nVersion 0.10\n------------\n\nReleased 2011-06-25\n\n- Refactored interface that the underlying serializers can be swapped\n by passing in a module instead of having to override the payload\n loaders and dumpers. This makes the interface more compatible with\n Django's recent changes.\n\n[end of CHANGES.rst]","filename":"CHANGES.rst","id":"7"},{"content":"version: 2\nbuild:\n os: ubuntu-22.04\n tools:\n python: '3.12'\npython:\n install:\n - requirements: requirements/docs.txt\n - method: pip\n path: .\nsphinx:\n builder: dirhtml\n fail_on_warning: true\n\n[end of .readthedocs.yaml]","filename":".readthedocs.yaml","id":"8"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile dev.in\n#\nalabaster==1.0.0\n # via\n # -r docs.txt\n # sphinx\nbabel==2.16.0\n # via\n # -r docs.txt\n # sphinx\ncachetools==5.5.0\n # via tox\ncertifi==2024.8.30\n # via\n # -r docs.txt\n # requests\ncfgv==3.4.0\n # via pre-commit\nchardet==5.2.0\n # via tox\ncharset-normalizer==3.4.0\n # via\n # -r docs.txt\n # requests\ncolorama==0.4.6\n # via tox\ndistlib==0.3.9\n # via virtualenv\ndocutils==0.21.2\n # via\n # -r docs.txt\n # sphinx\nfilelock==3.16.1\n # via\n # tox\n # virtualenv\nfreezegun==1.5.1\n # via -r tests.txt\nidentify==2.6.1\n # via pre-commit\nidna==3.10\n # via\n # -r docs.txt\n # requests\nimagesize==1.4.1\n # via\n # -r docs.txt\n # sphinx\niniconfig==2.0.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\njinja2==3.1.4\n # via\n # -r docs.txt\n # sphinx\nmarkupsafe==3.0.2\n # via\n # -r docs.txt\n # jinja2\nmypy==1.13.0\n # via -r typing.txt\nmypy-extensions==1.0.0\n # via\n # -r typing.txt\n # mypy\nnodeenv==1.9.1\n # via\n # -r typing.txt\n # pre-commit\n # pyright\npackaging==24.1\n # via\n # -r docs.txt\n # -r tests.txt\n # -r typing.txt\n # pallets-sphinx-themes\n # pyproject-api\n # pytest\n # sphinx\n # tox\npallets-sphinx-themes==2.3.0\n # via -r docs.txt\nplatformdirs==4.3.6\n # via\n # tox\n # virtualenv\npluggy==1.5.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\n # tox\npre-commit==4.0.1\n # via -r dev.in\npygments==2.18.0\n # via\n # -r docs.txt\n # sphinx\npyproject-api==1.8.0\n # via tox\npyright==1.1.386\n # via -r typing.txt\npytest==8.3.3\n # via\n # -r tests.txt\n # -r typing.txt\npython-dateutil==2.9.0.post0\n # via\n # -r tests.txt\n # freezegun\npyyaml==6.0.2\n # via pre-commit\nrequests==2.32.3\n # via\n # -r docs.txt\n # sphinx\nsix==1.16.0\n # via\n # -r tests.txt\n # python-dateutil\nsnowballstemmer==2.2.0\n # via\n # -r docs.txt\n # sphinx\nsphinx==8.1.3\n # via\n # -r docs.txt\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via\n # -r docs.txt\n # pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-devhelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-jsmath==1.0.1\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.txt\nsphinxcontrib-qthelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via\n # -r docs.txt\n # sphinx\ntox==4.23.2\n # via -r dev.in\ntyping-extensions==4.12.2\n # via\n # -r typing.txt\n # mypy\n # pyright\nurllib3==2.2.3\n # via\n # -r docs.txt\n # requests\nvirtualenv==20.27.0\n # via\n # pre-commit\n # tox\n\n[end of requirements/dev.txt]","filename":"requirements/dev.txt","id":"9"},{"content":"pallets-sphinx-themes\nsphinx\nsphinxcontrib-log-cabinet\n\n[end of requirements/docs.in]","filename":"requirements/docs.in","id":"10"},{"content":"build\n\n[end of requirements/build.in]","filename":"requirements/build.in","id":"11"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile typing.in\n#\niniconfig==2.0.0\n # via pytest\nmypy==1.13.0\n # via -r typing.in\nmypy-extensions==1.0.0\n # via mypy\nnodeenv==1.9.1\n # via pyright\npackaging==24.1\n # via pytest\npluggy==1.5.0\n # via pytest\npyright==1.1.386\n # via -r typing.in\npytest==8.3.3\n # via -r typing.in\ntyping-extensions==4.12.2\n # via\n # mypy\n # pyright\n\n[end of requirements/typing.txt]","filename":"requirements/typing.txt","id":"12"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile build.in\n#\nbuild==1.2.2.post1\n # via -r build.in\npackaging==24.1\n # via build\npyproject-hooks==1.2.0\n # via build\n\n[end of requirements/build.txt]","filename":"requirements/build.txt","id":"13"},{"content":"mypy\npyright\npytest\n\n[end of requirements/typing.in]","filename":"requirements/typing.in","id":"14"},{"content":"-r docs.txt\n-r tests.txt\n-r typing.txt\npre-commit\ntox\n\n[end of requirements/dev.in]","filename":"requirements/dev.in","id":"15"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile docs.in\n#\nalabaster==1.0.0\n # via sphinx\nbabel==2.16.0\n # via sphinx\ncertifi==2024.8.30\n # via requests\ncharset-normalizer==3.4.0\n # via requests\ndocutils==0.21.2\n # via sphinx\nidna==3.10\n # via requests\nimagesize==1.4.1\n # via sphinx\njinja2==3.1.4\n # via sphinx\nmarkupsafe==3.0.2\n # via jinja2\npackaging==24.1\n # via\n # pallets-sphinx-themes\n # sphinx\npallets-sphinx-themes==2.3.0\n # via -r docs.in\npygments==2.18.0\n # via sphinx\nrequests==2.32.3\n # via sphinx\nsnowballstemmer==2.2.0\n # via sphinx\nsphinx==8.1.3\n # via\n # -r docs.in\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via sphinx\nsphinxcontrib-devhelp==2.0.0\n # via sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via sphinx\nsphinxcontrib-jsmath==1.0.1\n # via sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.in\nsphinxcontrib-qthelp==2.0.0\n # via sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via sphinx\nurllib3==2.2.3\n # via requests\n\n[end of requirements/docs.txt]","filename":"requirements/docs.txt","id":"16"},{"content":".. rst-class:: hide-header\n\nItsDangerous\n============\n\n.. image:: _static/itsdangerous-logo.png\n :align: center\n :target: https://palletsprojects.com/p/itsdangerous/\n\nSometimes you want to send some data to untrusted environments, then get\nit back later. To do this safely, the data must be signed to detect\nchanges.\n\nGiven a key only you know, you can cryptographically sign your data and\nhand it over to someone else. When you get the data back you can ensure\nthat nobody tampered with it.\n\nThe receiver can see the data, but they can not modify it unless they\nalso have your key. So if you keep the key secret and complex, you will\nbe fine.\n\n\nInstalling\n----------\n\nInstall and update using `pip`_:\n\n.. code-block:: text\n\n pip install -U itsdangerous\n\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\n\n\nExample Use Cases\n-----------------\n\n- Sign a user ID in a URL and email it to them to unsubscribe from a\n newsletter. This way you don't need to generate one-time tokens and\n store them in the database. Same thing with any kind of activation\n link for accounts and similar things.\n- Signed objects can be stored in cookies or other untrusted sources\n which means you don't need to have sessions stored on the server,\n which reduces the number of necessary database queries.\n- Signed information can safely do a round trip between server and\n client in general which makes them useful for passing server-side\n state to a client and then back.\n\n\nTable of Contents\n-----------------\n\n.. toctree::\n\n concepts\n serializer\n signer\n exceptions\n timed\n url_safe\n encoding\n license\n changes\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"17"},{"content":".. module:: itsdangerous.serializer\n\nSerialization Interface\n=======================\n\nThe :doc:`/signer` only signs bytes. To sign other types, the\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\nsimilar to Python's :mod:`json` module, which serializes the object to a\nstring then signs that.\n\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n s = Serializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\n\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\nthe data.\n\n.. code-block:: python\n\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\n [1, 2, 3, 4]\n\nBy default, data is serialized to JSON with the built-in :mod:`json`\nmodule. This internal serializer can be changed by subclassing.\n\nTo record and validate the age of the signature, see :doc:`/timed`.\nTo serialize to a format that is safe to use in URLs, see\n:doc:`/url_safe`.\n\n\nResponding to Failure\n---------------------\n\nExceptions have helpful attributes which allow you to inspect the\npayload if the signature check failed. This has to be done with extra\ncare because at that point you know that someone tampered with your data\nbut it might be useful for debugging purposes.\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n from itsdangerous.exc import BadSignature, BadData\n\n s = URLSafeSerializer(\"secret-key\")\n decoded_payload = None\n\n try:\n decoded_payload = s.loads(data)\n # This payload is decoded and safe\n except BadSignature as e:\n if e.payload is not None:\n try:\n decoded_payload = s.load_payload(e.payload)\n except BadData:\n pass\n # This payload is decoded but unsafe because someone\n # tampered with the signature. The decode (load_payload)\n # step is explicit because it might be unsafe to unserialize\n # the payload (think pickle instead of json!)\n\nIf you don't want to inspect attributes to figure out what exactly went\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\n\n.. code-block:: python\n\n sig_okay, payload = s.loads_unsafe(data)\n\nThe first item in the returned tuple is a boolean that indicates if the\nsignature was correct.\n\n\nFallback Signers\n----------------\n\nYou may want to upgrade the signing parameters without invalidating\nexisting signatures immediately. For example, you may decide that you\nwant to use a different digest method. New signatures should use the new\nmethod, but old signatures should still validate.\n\nA list of ``fallback_signers`` can be given that will be tried if\nunsigning with the current signer fails. Each item in the list can be:\n\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\n passed to the serializer.\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\n serializer.\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\n given class with the given args.\n\nFor example, this is a serializer that signs using SHA-512, but will\nunsign using either SHA-512 or SHA-1:\n\n.. code-block:: python\n\n s = Serializer(\n signer_kwargs={\"digest_method\": hashlib.sha512},\n fallback_signers=[{\"digest_method\": hashlib.sha1}]\n )\n\n\n\nAPI\n---\n\n.. autoclass:: Serializer\n :members:\n\n[end of docs/serializer.rst]","filename":"docs/serializer.rst","id":"18"},{"content":".. module:: itsdangerous.signer\n\nSigning Interface\n=================\n\nThe most basic interface is the signing interface. The :class:`Signer`\nclass can be used to attach a signature to a specific string:\n\n.. code-block:: python\n\n from itsdangerous import Signer\n s = Signer(\"secret-key\")\n s.sign(\"my string\")\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\n\nThe signature is appended to the string, separated by a dot. To validate\nthe string, use the :meth:`~Signer.unsign` method:\n\n.. code-block:: python\n\n s.unsign(b\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n b'my string'\n\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\nHowever after unsigning you won't be able to tell if it was unicode or\na bytestring.\n\nIf the value is changed, the signature will no longer match, and\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\n\n.. code-block:: python\n\n s.unsign(b\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nTo record and validate the age of a signature, see :doc:`/timed`.\n\n.. autoclass:: Signer\n :members:\n\n\nSigning Algorithms\n------------------\n\n.. autoclass:: NoneAlgorithm\n\n.. autoclass:: HMACAlgorithm\n\n[end of docs/signer.rst]","filename":"docs/signer.rst","id":"19"},{"content":"General Concepts\n================\n\n\nSerializer vs Signer\n--------------------\n\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\nthe basic system that signs a given ``bytes`` value based on the given\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\nserializing and signing other data besides ``bytes``.\n\nTypically, you'll want to use a serializer, not a signer. You can\nconfigure the signing parameters through the serializer, and even\nprovide fallback signers to upgrade old tokens to new parameters.\n\n\nThe Secret Key\n--------------\n\nSignatures are secured by the ``secret_key``. Typically one secret key\nis used with all signers, and the salt is used to distinguish different\ncontexts. Changing the secret key will invalidate existing tokens.\n\nIt should be a long random string of bytes. This value must be kept\nsecret and should not be saved in source code or committed to version\ncontrol. If an attacker learns the secret key, they can change and\nresign data to look valid. If you suspect this happened, change the\nsecret key to invalidate existing tokens.\n\nOne way to keep the secret key separate is to read it from an\nenvironment variable. When deploying for the first time, generate a key\nand set the environment variable when running the application. All\nprocess managers (like systemd) and hosting services have a way to\nspecify environment variables.\n\n.. code-block:: python\n\n import os\n from itsdangerous.serializer import Serializer\n SECRET_KEY = os.environ.get(\"SECRET_KEY\")\n s = Serializer(SECRET_KEY)\n\n.. code-block:: text\n\n $ export SECRET_KEY=\"base64 encoded random bytes\"\n $ python application.py\n\nOne way to generate a key is to use :func:`os.urandom`.\n\n.. code-block:: text\n\n $ python3 -c 'import os; print(os.urandom(16).hex())'\n\n\nThe Salt\n--------\n\nThe salt is combined with the secret key to derive a unique key for\ndistinguishing different contexts. Unlike the secret key, the salt\ndoesn't have to be random, and can be saved in code. It only has to be\nunique between contexts, not private.\n\nFor example, you want to email activation links to activate user\naccounts, and upgrade links to upgrade users to a paid accounts. If all\nyou sign is the user id, and you don't use different salts, a user could\nreuse the token from the activation link to upgrade the account. If you\nuse different salts, the signatures will be different and will not be\nvalid in the other context.\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n\n s1 = URLSafeSerializer(\"secret-key\", salt=\"activate\")\n s1.dumps(42)\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\n\n s2 = URLSafeSerializer(\"secret-key\", salt=\"upgrade\")\n s2.dumps(42)\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\n\nThe second serializer can't load data dumped with the first because the\nsalts differ.\n\n.. code-block:: python\n\n s2.loads(s1.dumps(42))\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nOnly the serializer with the same salt can load the data.\n\n.. code-block:: python\n\n s2.loads(s2.dumps(42))\n 42\n\n\nKey Rotation\n------------\n\nKey rotation can provide an extra layer of mitigation against an\nattacker discovering a secret key. A rotation system will keep a list of\nvalid keys, generating a new key and removing the oldest key\nperiodically. If it takes four weeks for an attacker to crack a key, but\nthe key is rotated out after three weeks, they will not be able to use\nany keys they crack. However, if a user doesn't refresh their token\nwithin three weeks it will be invalid too.\n\nThe system that generates and maintains this list is outside the scope\nof ItsDangerous, but ItsDangerous does support validating against a list\nof keys.\n\nInstead of passing a single key, you can pass a list of keys, oldest to\nnewest. When signing the last (newest) key will be used, and when\nvalidating each key will be tried from newest to oldest before raising\na validation error.\n\n.. code-block:: python\n\n SECRET_KEYS = [\"2b9cd98e\", \"169d7886\", \"b6af09f5\"]\n\n # sign some data with the latest key\n s = Serializer(SECRET_KEYS)\n t = s.dumps({\"id\": 42})\n\n # rotate a new key in and the oldest key out\n SECRET_KEYS.append(\"cf9b3588\")\n del SECRET_KEYS[0]\n\n s = Serializer(SECRET_KEYS)\n s.loads(t) # valid even though it was signed with a previous key\n\n\nDigest Method Security\n----------------------\n\nA signer is configured with a ``digest_method``, a hash function that\nis used as an intermediate step when generating the HMAC signature. The\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\nconcerned about this default because they have heard about hash\ncollisions with SHA-1.\n\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\nhash alone doesn't apply when used in HMAC.\n\nIf a project considers SHA-1 a risk anyway, they can configure the\nsigner with a different digest method such as :func:`hashlib.sha512`.\nA fallback signer for SHA-1 can be configured so that old tokens will be\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\nspace, which is relevant in cookies and URLs.\n\n[end of docs/concepts.rst]","filename":"docs/concepts.rst","id":"20"},{"content":".. module:: itsdangerous.url_safe\n\nURL Safe Serialization\n======================\n\nOften it is helpful if you can pass these trusted strings in places\nwhere you only have a limited set of characters available. Because of\nthis, ItsDangerous also provides URL safe serializers:\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n s = URLSafeSerializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\n s.loads(\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\")\n [1, 2, 3, 4]\n\n.. autoclass:: URLSafeSerializer\n\n.. autoclass:: URLSafeTimedSerializer\n\n[end of docs/url_safe.rst]","filename":"docs/url_safe.rst","id":"21"},{"content":".. module:: itsdangerous.encoding\n\nEncoding Utilities\n==================\n\n.. autofunction:: base64_encode\n\n.. autofunction:: base64_decode\n\n[end of docs/encoding.rst]","filename":"docs/encoding.rst","id":"22"},{"content":"# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSOURCEDIR = .\nBUILDDIR = _build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"23"},{"content":"from pallets_sphinx_themes import get_version\nfrom pallets_sphinx_themes import ProjectLink\n\n# Project --------------------------------------------------------------\n\nproject = \"ItsDangerous\"\ncopyright = \"2011 Pallets\"\nauthor = \"Pallets\"\nrelease, version = get_version(\"itsdangerous\")\n\n# General --------------------------------------------------------------\n\ndefault_role = \"code\"\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.extlinks\",\n \"sphinx.ext.intersphinx\",\n \"sphinxcontrib.log_cabinet\",\n \"pallets_sphinx_themes\",\n]\nautoclass_content = \"both\"\nautodoc_member_order = \"bysource\"\nautodoc_typehints = \"description\"\nautodoc_preserve_defaults = True\nextlinks = {\n \"issue\": (\"https://github.com/pallets/itsdangerous/issues/%s\", \"#%s\"),\n \"pr\": (\"https://github.com/pallets/itsdangerous/pull/%s\", \"#%s\"),\n}\nintersphinx_mapping = {\n \"python\": (\"https://docs.python.org/3/\", None),\n}\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = \"flask\"\nhtml_theme_options = {\"index_sidebar_logo\": False}\nhtml_context = {\n \"project_links\": [\n ProjectLink(\"Donate\", \"https://palletsprojects.com/donate\"),\n ProjectLink(\"PyPI Releases\", \"https://pypi.org/project/itsdangerous/\"),\n ProjectLink(\"Source Code\", \"https://github.com/pallets/itsdangerous/\"),\n ProjectLink(\"Issue Tracker\", \"https://github.com/pallets/itsdangerous/issues/\"),\n ProjectLink(\"Chat\", \"https://discord.gg/pallets\"),\n ]\n}\nhtml_sidebars = {\n \"index\": [\"project.html\", \"localtoc.html\", \"searchbox.html\", \"ethicalads.html\"],\n \"**\": [\"localtoc.html\", \"relations.html\", \"searchbox.html\", \"ethicalads.html\"],\n}\nsinglehtml_sidebars = {\"index\": [\"project.html\", \"localtoc.html\", \"ethicalads.html\"]}\nhtml_static_path = [\"_static\"]\nhtml_favicon = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_logo = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_title = f\"{project} Documentation ({version})\"\nhtml_show_sourcelink = False\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"24"},{"content":"@ECHO OFF\n\npushd %~dp0\n\nREM Command file for Sphinx documentation\n\nif \"%SPHINXBUILD%\" == \"\" (\n\tset SPHINXBUILD=sphinx-build\n)\nset SOURCEDIR=.\nset BUILDDIR=_build\n\nif \"%1\" == \"\" goto help\n\n%SPHINXBUILD% >NUL 2>NUL\nif errorlevel 9009 (\n\techo.\n\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\n\techo.installed, then set the SPHINXBUILD environment variable to point\n\techo.to the full path of the 'sphinx-build' executable. Alternatively you\n\techo.may add the Sphinx directory to PATH.\n\techo.\n\techo.If you don't have Sphinx installed, grab it from\n\techo.http://sphinx-doc.org/\n\texit /b 1\n)\n\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\ngoto end\n\n:help\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\n\n:end\npopd\n\n[end of docs/make.bat]","filename":"docs/make.bat","id":"25"},{"content":".. module:: itsdangerous.timed\n\nSigning With Timestamps\n=======================\n\nIf you want to expire signatures you can use the\n:class:`TimestampSigner` class which adds timestamp information and\nsigns it. On unsigning you can validate that the timestamp is not older\nthan a given age.\n\n.. code-block:: python\n\n from itsdangerous import TimestampSigner\n s = TimestampSigner('secret-key')\n string = s.sign('foo')\n\n.. code-block:: python\n\n s.unsign(string, max_age=5)\n Traceback (most recent call last):\n ...\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\n\n.. autoclass:: TimestampSigner\n :members:\n\n.. autoclass:: TimedSerializer\n :members:\n\n[end of docs/timed.rst]","filename":"docs/timed.rst","id":"26"},{"content":"BSD-3-Clause License\n====================\n\n.. literalinclude:: ../LICENSE.txt\n :language: text\n\n[end of docs/license.rst]","filename":"docs/license.rst","id":"27"},{"content":"Changes\n=======\n\n.. include:: ../CHANGES.rst\n\n[end of docs/changes.rst]","filename":"docs/changes.rst","id":"28"},{"content":".. module:: itsdangerous.exc\n\nExceptions\n==========\n\n.. autoexception:: BadData\n :members:\n\n.. autoexception:: BadSignature\n :members:\n\n.. autoexception:: BadTimeSignature\n :members:\n\n.. autoexception:: SignatureExpired\n :members:\n\n.. autoexception:: BadHeader\n :members:\n\n.. autoexception:: BadPayload\n :members:\n\n[end of docs/exceptions.rst]","filename":"docs/exceptions.rst","id":"29"},{"content":"#!/bin/bash\nset -e\npython3 -m venv --upgrade-deps .venv\n. .venv/bin/activate\npip install -r requirements/dev.txt\npip install -e .\npre-commit install --install-hooks\n\n[end of .devcontainer/on-create-command.sh]","filename":".devcontainer/on-create-command.sh","id":"30"},{"content":"{\n \"name\": \"pallets/itsdangerous\",\n \"image\": \"mcr.microsoft.com/devcontainers/python:3\",\n \"customizations\": {\n \"vscode\": {\n \"settings\": {\n \"python.defaultInterpreterPath\": \"${workspaceFolder}/.venv\",\n \"python.terminal.activateEnvInCurrentTerminal\": true,\n \"python.terminal.launchArgs\": [\n \"-X\",\n \"dev\"\n ]\n }\n }\n },\n \"onCreateCommand\": \".devcontainer/on-create-command.sh\"\n}\n\n[end of .devcontainer/devcontainer.json]","filename":".devcontainer/devcontainer.json","id":"31"},{"content":"None\n[end of docs/_static/itsdangerous-logo-sidebar.png]","filename":"docs/_static/itsdangerous-logo-sidebar.png","id":"32"},{"content":"None\n[end of docs/_static/itsdangerous-logo.png]","filename":"docs/_static/itsdangerous-logo.png","id":"33"},{"content":"from __future__ import annotations\n\nimport json as _json\nimport typing as t\n\n\nclass _CompactJSON:\n \"\"\"Wrapper around json module that strips whitespace.\"\"\"\n\n @staticmethod\n def loads(payload: str | bytes) -> t.Any:\n return _json.loads(payload)\n\n @staticmethod\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\n kwargs.setdefault(\"ensure_ascii\", False)\n kwargs.setdefault(\"separators\", (\",\", \":\"))\n return _json.dumps(obj, **kwargs)\n\n[end of src/itsdangerous/_json.py]","filename":"src/itsdangerous/_json.py","id":"34"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport time\nimport typing as t\nfrom datetime import datetime\nfrom datetime import timezone\n\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import bytes_to_int\nfrom .encoding import int_to_bytes\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\nfrom .exc import BadTimeSignature\nfrom .exc import SignatureExpired\nfrom .serializer import _TSerialized\nfrom .serializer import Serializer\nfrom .signer import Signer\n\n\nclass TimestampSigner(Signer):\n \"\"\"Works like the regular :class:`.Signer` but also records the time\n of the signing and can be used to expire signatures. The\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\n unsigning failed because the signature is expired.\n \"\"\"\n\n def get_timestamp(self) -> int:\n \"\"\"Returns the current timestamp. The function must return an\n integer.\n \"\"\"\n return int(time.time())\n\n def timestamp_to_datetime(self, ts: int) -> datetime:\n \"\"\"Convert the timestamp from :meth:`get_timestamp` into an\n aware :class`datetime.datetime` in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n return datetime.fromtimestamp(ts, tz=timezone.utc)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string and also attaches time information.\"\"\"\n value = want_bytes(value)\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\n sep = want_bytes(self.sep)\n value = value + sep + timestamp\n return value + sep + self.get_signature(value)\n\n # Ignore overlapping signatures check, return_timestamp is the only\n # parameter that affects the return type.\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[False] = False,\n ) -> bytes: ...\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[True] = True,\n ) -> tuple[bytes, datetime]: ...\n\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n ) -> tuple[bytes, datetime] | bytes:\n \"\"\"Works like the regular :meth:`.Signer.unsign` but can also\n validate the time. See the base docstring of the class for\n the general behavior. If ``return_timestamp`` is ``True`` the\n timestamp of the signature will be returned as an aware\n :class:`datetime.datetime` object in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n try:\n result = super().unsign(signed_value)\n sig_error = None\n except BadSignature as e:\n sig_error = e\n result = e.payload or b\"\"\n\n sep = want_bytes(self.sep)\n\n # If there is no timestamp in the result there is something\n # seriously wrong. In case there was a signature error, we raise\n # that one directly, otherwise we have a weird situation in\n # which we shouldn't have come except someone uses a time-based\n # serializer on non-timestamp data, so catch that.\n if sep not in result:\n if sig_error:\n raise sig_error\n\n raise BadTimeSignature(\"timestamp missing\", payload=result)\n\n value, ts_bytes = result.rsplit(sep, 1)\n ts_int: int | None = None\n ts_dt: datetime | None = None\n\n try:\n ts_int = bytes_to_int(base64_decode(ts_bytes))\n except Exception:\n pass\n\n # Signature is *not* okay. Raise a proper error now that we have\n # split the value and the timestamp.\n if sig_error is not None:\n if ts_int is not None:\n try:\n ts_dt = self.timestamp_to_datetime(ts_int)\n except (ValueError, OSError, OverflowError) as exc:\n # Windows raises OSError\n # 32-bit raises OverflowError\n raise BadTimeSignature(\n \"Malformed timestamp\", payload=value\n ) from exc\n\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\n\n # Signature was okay but the timestamp is actually not there or\n # malformed. Should not happen, but we handle it anyway.\n if ts_int is None:\n raise BadTimeSignature(\"Malformed timestamp\", payload=value)\n\n # Check timestamp is not older than max_age\n if max_age is not None:\n age = self.get_timestamp() - ts_int\n\n if age > max_age:\n raise SignatureExpired(\n f\"Signature age {age} > {max_age} seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if age < 0:\n raise SignatureExpired(\n f\"Signature age {age} < 0 seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if return_timestamp:\n return value, self.timestamp_to_datetime(ts_int)\n\n return value\n\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\"\"\"\n try:\n self.unsign(signed_value, max_age=max_age)\n return True\n except BadSignature:\n return False\n\n\nclass TimedSerializer(Serializer[_TSerialized]):\n \"\"\"Uses :class:`TimestampSigner` instead of the default\n :class:`.Signer`.\n \"\"\"\n\n default_signer: type[TimestampSigner] = TimestampSigner\n\n def iter_unsigners(\n self, salt: str | bytes | None = None\n ) -> cabc.Iterator[TimestampSigner]:\n return t.cast(\"cabc.Iterator[TimestampSigner]\", super().iter_unsigners(salt))\n\n # TODO: Signature is incompatible because parameters were added\n # before salt.\n\n def loads( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n salt: str | bytes | None = None,\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\n signature validation fails. If a ``max_age`` is provided it will\n ensure the signature is not older than that time in seconds. In\n case the signature is outdated, :exc:`.SignatureExpired` is\n raised. All arguments are forwarded to the signer's\n :meth:`~TimestampSigner.unsign` method.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n base64d, timestamp = signer.unsign(\n s, max_age=max_age, return_timestamp=True\n )\n payload = self.load_payload(base64d)\n\n if return_timestamp:\n return payload, timestamp\n\n return payload\n except SignatureExpired:\n # The signature was unsigned successfully but was\n # expired. Do not try the next signer.\n raise\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def loads_unsafe( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n salt: str | bytes | None = None,\n ) -> tuple[bool, t.Any]:\n return self._loads_unsafe_impl(s, salt, load_kwargs={\"max_age\": max_age})\n\n[end of src/itsdangerous/timed.py]","filename":"src/itsdangerous/timed.py","id":"35"},{"content":"from __future__ import annotations\n\nimport base64\nimport string\nimport struct\nimport typing as t\n\nfrom .exc import BadData\n\n\ndef want_bytes(\n s: str | bytes, encoding: str = \"utf-8\", errors: str = \"strict\"\n) -> bytes:\n if isinstance(s, str):\n s = s.encode(encoding, errors)\n\n return s\n\n\ndef base64_encode(string: str | bytes) -> bytes:\n \"\"\"Base64 encode a string of bytes or text. The resulting bytes are\n safe to use in URLs.\n \"\"\"\n string = want_bytes(string)\n return base64.urlsafe_b64encode(string).rstrip(b\"=\")\n\n\ndef base64_decode(string: str | bytes) -> bytes:\n \"\"\"Base64 decode a URL-safe string of bytes or text. The result is\n bytes.\n \"\"\"\n string = want_bytes(string, encoding=\"ascii\", errors=\"ignore\")\n string += b\"=\" * (-len(string) % 4)\n\n try:\n return base64.urlsafe_b64decode(string)\n except (TypeError, ValueError) as e:\n raise BadData(\"Invalid base64-encoded data\") from e\n\n\n# The alphabet used by base64.urlsafe_*\n_base64_alphabet = f\"{string.ascii_letters}{string.digits}-_=\".encode(\"ascii\")\n\n_int64_struct = struct.Struct(\">Q\")\n_int_to_bytes = _int64_struct.pack\n_bytes_to_int = t.cast(\"t.Callable[[bytes], tuple[int]]\", _int64_struct.unpack)\n\n\ndef int_to_bytes(num: int) -> bytes:\n return _int_to_bytes(num).lstrip(b\"\\x00\")\n\n\ndef bytes_to_int(bytestr: bytes) -> int:\n return _bytes_to_int(bytestr.rjust(8, b\"\\x00\"))[0]\n\n[end of src/itsdangerous/encoding.py]","filename":"src/itsdangerous/encoding.py","id":"36"},{"content":"from __future__ import annotations\n\nimport typing as t\n\nfrom .encoding import base64_decode as base64_decode\nfrom .encoding import base64_encode as base64_encode\nfrom .encoding import want_bytes as want_bytes\nfrom .exc import BadData as BadData\nfrom .exc import BadHeader as BadHeader\nfrom .exc import BadPayload as BadPayload\nfrom .exc import BadSignature as BadSignature\nfrom .exc import BadTimeSignature as BadTimeSignature\nfrom .exc import SignatureExpired as SignatureExpired\nfrom .serializer import Serializer as Serializer\nfrom .signer import HMACAlgorithm as HMACAlgorithm\nfrom .signer import NoneAlgorithm as NoneAlgorithm\nfrom .signer import Signer as Signer\nfrom .timed import TimedSerializer as TimedSerializer\nfrom .timed import TimestampSigner as TimestampSigner\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\n\n\ndef __getattr__(name: str) -> t.Any:\n if name == \"__version__\":\n import importlib.metadata\n import warnings\n\n warnings.warn(\n \"The '__version__' attribute is deprecated and will be removed in\"\n \" ItsDangerous 2.3. Use feature detection or\"\n \" 'importlib.metadata.version(\\\"itsdangerous\\\")' instead.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return importlib.metadata.version(\"itsdangerous\")\n\n raise AttributeError(name)\n\n[end of src/itsdangerous/__init__.py]","filename":"src/itsdangerous/__init__.py","id":"37"},{"content":"from __future__ import annotations\n\nimport typing as t\nimport zlib\n\nfrom ._json import _CompactJSON\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .exc import BadPayload\nfrom .serializer import _PDataSerializer\nfrom .serializer import Serializer\nfrom .timed import TimedSerializer\n\n\nclass URLSafeSerializerMixin(Serializer[str]):\n \"\"\"Mixed in with a regular serializer it will attempt to zlib\n compress the string to make it shorter if necessary. It will also\n base64 encode the string so that it can safely be placed in a URL.\n \"\"\"\n\n default_serializer: _PDataSerializer[str] = _CompactJSON\n\n def load_payload(\n self,\n payload: bytes,\n *args: t.Any,\n serializer: t.Any | None = None,\n **kwargs: t.Any,\n ) -> t.Any:\n decompress = False\n\n if payload.startswith(b\".\"):\n payload = payload[1:]\n decompress = True\n\n try:\n json = base64_decode(payload)\n except Exception as e:\n raise BadPayload(\n \"Could not base64 decode the payload because of an exception\",\n original_error=e,\n ) from e\n\n if decompress:\n try:\n json = zlib.decompress(json)\n except Exception as e:\n raise BadPayload(\n \"Could not zlib decompress the payload before decoding the payload\",\n original_error=e,\n ) from e\n\n return super().load_payload(json, *args, **kwargs)\n\n def dump_payload(self, obj: t.Any) -> bytes:\n json = super().dump_payload(obj)\n is_compressed = False\n compressed = zlib.compress(json)\n\n if len(compressed) < (len(json) - 1):\n json = compressed\n is_compressed = True\n\n base64d = base64_encode(json)\n\n if is_compressed:\n base64d = b\".\" + base64d\n\n return base64d\n\n\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\n \"\"\"Works like :class:`.Serializer` but dumps and loads into a URL\n safe string consisting of the upper and lowercase character of the\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\n \"\"\"Works like :class:`.TimedSerializer` but dumps and loads into a\n URL safe string consisting of the upper and lowercase character of\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n[end of src/itsdangerous/url_safe.py]","filename":"src/itsdangerous/url_safe.py","id":"38"},{"content":"from __future__ import annotations\n\nimport typing as t\nfrom datetime import datetime\n\n\nclass BadData(Exception):\n \"\"\"Raised if bad data of any sort was encountered. This is the base\n for all exceptions that ItsDangerous defines.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str):\n super().__init__(message)\n self.message = message\n\n def __str__(self) -> str:\n return self.message\n\n\nclass BadSignature(BadData):\n \"\"\"Raised if a signature does not match.\"\"\"\n\n def __init__(self, message: str, payload: t.Any | None = None):\n super().__init__(message)\n\n #: The payload that failed the signature test. In some\n #: situations you might still want to inspect this, even if\n #: you know it was tampered with.\n #:\n #: .. versionadded:: 0.14\n self.payload: t.Any | None = payload\n\n\nclass BadTimeSignature(BadSignature):\n \"\"\"Raised if a time-based signature is invalid. This is a subclass\n of :class:`BadSignature`.\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n date_signed: datetime | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the signature expired this exposes the date of when the\n #: signature was created. This can be helpful in order to\n #: tell the user how long a link has been gone stale.\n #:\n #: .. versionchanged:: 2.0\n #: The datetime value is timezone-aware rather than naive.\n #:\n #: .. versionadded:: 0.14\n self.date_signed = date_signed\n\n\nclass SignatureExpired(BadTimeSignature):\n \"\"\"Raised if a signature timestamp is older than ``max_age``. This\n is a subclass of :exc:`BadTimeSignature`.\n \"\"\"\n\n\nclass BadHeader(BadSignature):\n \"\"\"Raised if a signed header is invalid in some form. This only\n happens for serializers that have a header that goes with the\n signature.\n\n .. versionadded:: 0.24\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n header: t.Any | None = None,\n original_error: Exception | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the header is actually available but just malformed it\n #: might be stored here.\n self.header: t.Any | None = header\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n\nclass BadPayload(BadData):\n \"\"\"Raised if a payload is invalid. This could happen if the payload\n is loaded despite an invalid signature, or if there is a mismatch\n between the serializer and deserializer. The original exception\n that occurred during loading is stored on as :attr:`original_error`.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str, original_error: Exception | None = None):\n super().__init__(message)\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n[end of src/itsdangerous/exc.py]","filename":"src/itsdangerous/exc.py","id":"39"},{"content":"[end of src/itsdangerous/py.typed]","filename":"src/itsdangerous/py.typed","id":"40"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport json\nimport typing as t\n\nfrom .encoding import want_bytes\nfrom .exc import BadPayload\nfrom .exc import BadSignature\nfrom .signer import _make_keys_list\nfrom .signer import Signer\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n # This should be either be str or bytes. To avoid having to specify the\n # bound type, it falls back to a union if structural matching fails.\n _TSerialized = te.TypeVar(\n \"_TSerialized\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\n )\nelse:\n # Still available at runtime on Python < 3.13, but without the default.\n _TSerialized = t.TypeVar(\"_TSerialized\", bound=t.Union[str, bytes])\n\n\nclass _PDataSerializer(t.Protocol[_TSerialized]):\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\n # A signature with additional arguments is not handled correctly by type\n # checkers right now, so an overload is used below for serializers that\n # don't match this strict protocol.\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\n\n\n# Use TypeIs once it's available in typing_extensions or 3.13.\ndef is_text_serializer(\n serializer: _PDataSerializer[t.Any],\n) -> te.TypeGuard[_PDataSerializer[str]]:\n \"\"\"Checks whether a serializer generates text or binary.\"\"\"\n return isinstance(serializer.dumps({}), str)\n\n\nclass Serializer(t.Generic[_TSerialized]):\n \"\"\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\n enable serializing and securely signing data other than bytes. It\n can unsign to verify that the data hasn't been changed.\n\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\n :mod:`json`, and by default uses :mod:`json` internally to serialize\n the data to bytes.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param serializer: An object that provides ``dumps`` and ``loads``\n methods for serializing data to a string. Defaults to\n :attr:`default_serializer`, which defaults to :mod:`json`.\n :param serializer_kwargs: Keyword arguments to pass when calling\n ``serializer.dumps``.\n :param signer: A ``Signer`` class to instantiate when signing data.\n Defaults to :attr:`default_signer`, which defaults to\n :class:`~itsdangerous.signer.Signer`.\n :param signer_kwargs: Keyword arguments to pass when instantiating\n the ``Signer`` class.\n :param fallback_signers: List of signer parameters to try when\n unsigning with the default signer fails. Each item can be a dict\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\n ``(signer, signer_kwargs)``. Defaults to\n :attr:`default_fallback_signers`.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 2.0\n Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``.\n\n .. versionchanged:: 1.1\n Added support for ``fallback_signers`` and configured a default\n SHA-512 fallback. This fallback is for users who used the yanked\n 1.0.0 release which defaulted to SHA-512.\n\n .. versionchanged:: 0.14\n The ``signer`` and ``signer_kwargs`` parameters were added to\n the constructor.\n \"\"\"\n\n #: The default serialization module to use to serialize data to a\n #: string internally. The default is :mod:`json`, but can be changed\n #: to any object that provides ``dumps`` and ``loads`` methods.\n default_serializer: _PDataSerializer[t.Any] = json\n\n #: The default ``Signer`` class to instantiate when signing data.\n #: The default is :class:`itsdangerous.signer.Signer`.\n default_signer: type[Signer] = Signer\n\n #: The default fallback signers to try when unsigning fails.\n default_fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = []\n\n # Serializer[str] if no data serializer is provided, or if it returns str.\n @t.overload\n def __init__(\n self: Serializer[str],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: None | _PDataSerializer[str] = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer positional argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer keyword argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a positional argument. If the strict signature of\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\n # to specify the type.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a keyword argument.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: t.Any | None = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n\n if salt is not None:\n salt = want_bytes(salt)\n # if salt is None then the signer's default is used\n\n self.salt = salt\n\n if serializer is None:\n serializer = self.default_serializer\n\n self.serializer: _PDataSerializer[_TSerialized] = serializer\n self.is_text_serializer: bool = is_text_serializer(serializer)\n\n if signer is None:\n signer = self.default_signer\n\n self.signer: type[Signer] = signer\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\n\n if fallback_signers is None:\n fallback_signers = list(self.default_fallback_signers)\n\n self.fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = fallback_signers\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def load_payload(\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\n ) -> t.Any:\n \"\"\"Loads the encoded object. This function raises\n :class:`.BadPayload` if the payload is not valid. The\n ``serializer`` parameter can be used to override the serializer\n stored on the class. The encoded ``payload`` should always be\n bytes.\n \"\"\"\n if serializer is None:\n use_serializer = self.serializer\n is_text = self.is_text_serializer\n else:\n use_serializer = serializer\n is_text = is_text_serializer(serializer)\n\n try:\n if is_text:\n return use_serializer.loads(payload.decode(\"utf-8\")) # type: ignore[arg-type]\n\n return use_serializer.loads(payload) # type: ignore[arg-type]\n except Exception as e:\n raise BadPayload(\n \"Could not load the payload because an exception\"\n \" occurred on unserializing the data.\",\n original_error=e,\n ) from e\n\n def dump_payload(self, obj: t.Any) -> bytes:\n \"\"\"Dumps the encoded object. The return value is always bytes.\n If the internal serializer returns text, the value will be\n encoded as UTF-8.\n \"\"\"\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\n\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\n \"\"\"Creates a new instance of the signer to be used. The default\n implementation uses the :class:`.Signer` base class.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\n\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\n \"\"\"Iterates over all signers to be tried for unsigning. Starts\n with the configured signer, then constructs each signer\n specified in ``fallback_signers``.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n yield self.make_signer(salt)\n\n for fallback in self.fallback_signers:\n if isinstance(fallback, dict):\n kwargs = fallback\n fallback = self.signer\n elif isinstance(fallback, tuple):\n fallback, kwargs = fallback\n else:\n kwargs = self.signer_kwargs\n\n for secret_key in self.secret_keys:\n yield fallback(secret_key, salt=salt, **kwargs)\n\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\n \"\"\"Returns a signed string serialized with the internal\n serializer. The return value can be either a byte or unicode\n string depending on the format of the internal serializer.\n \"\"\"\n payload = want_bytes(self.dump_payload(obj))\n rv = self.make_signer(salt).sign(payload)\n\n if self.is_text_serializer:\n return rv.decode(\"utf-8\") # type: ignore[return-value]\n\n return rv # type: ignore[return-value]\n\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\n \"\"\"Like :meth:`dumps` but dumps into a file. The file handle has\n to be compatible with what the internal serializer expects.\n \"\"\"\n f.write(self.dumps(obj, salt))\n\n def loads(\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\n signature validation fails.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n return self.load_payload(signer.unsign(s))\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\n \"\"\"Like :meth:`loads` but loads from a file.\"\"\"\n return self.loads(f.read(), salt)\n\n def loads_unsafe(\n self, s: str | bytes, salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads` but without verifying the signature. This\n is potentially very dangerous to use depending on how your\n serializer works. The return value is ``(signature_valid,\n payload)`` instead of just the payload. The first item will be a\n boolean that indicates if the signature is valid. This function\n never fails.\n\n Use it for debugging only and if you know that your serializer\n module is not exploitable (for example, do not use it with a\n pickle serializer).\n\n .. versionadded:: 0.15\n \"\"\"\n return self._loads_unsafe_impl(s, salt)\n\n def _loads_unsafe_impl(\n self,\n s: str | bytes,\n salt: str | bytes | None,\n load_kwargs: dict[str, t.Any] | None = None,\n load_payload_kwargs: dict[str, t.Any] | None = None,\n ) -> tuple[bool, t.Any]:\n \"\"\"Low level helper function to implement :meth:`loads_unsafe`\n in serializer subclasses.\n \"\"\"\n if load_kwargs is None:\n load_kwargs = {}\n\n try:\n return True, self.loads(s, salt=salt, **load_kwargs)\n except BadSignature as e:\n if e.payload is None:\n return False, None\n\n if load_payload_kwargs is None:\n load_payload_kwargs = {}\n\n try:\n return (\n False,\n self.load_payload(e.payload, **load_payload_kwargs),\n )\n except BadPayload:\n return False, None\n\n def load_unsafe(\n self, f: t.IO[t.Any], salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads_unsafe` but loads from a file.\n\n .. versionadded:: 0.15\n \"\"\"\n return self.loads_unsafe(f.read(), salt=salt)\n\n[end of src/itsdangerous/serializer.py]","filename":"src/itsdangerous/serializer.py","id":"41"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport hashlib\nimport hmac\nimport typing as t\n\nfrom .encoding import _base64_alphabet\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\n\n\nclass SigningAlgorithm:\n \"\"\"Subclasses must implement :meth:`get_signature` to provide\n signature generation functionality.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n \"\"\"Returns the signature for the given key and value.\"\"\"\n raise NotImplementedError()\n\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\n \"\"\"Verifies the given signature matches the expected\n signature.\n \"\"\"\n return hmac.compare_digest(sig, self.get_signature(key, value))\n\n\nclass NoneAlgorithm(SigningAlgorithm):\n \"\"\"Provides an algorithm that does not perform any signing and\n returns an empty signature.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n return b\"\"\n\n\ndef _lazy_sha1(string: bytes = b\"\") -> t.Any:\n \"\"\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\n SHA-1, in which case the import and use as a default would fail before the\n developer can configure something else.\n \"\"\"\n return hashlib.sha1(string)\n\n\nclass HMACAlgorithm(SigningAlgorithm):\n \"\"\"Provides signature generation using HMACs.\"\"\"\n\n #: The digest method to use with the MAC algorithm. This defaults to\n #: SHA1, but can be changed to any other function in the hashlib\n #: module.\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n def __init__(self, digest_method: t.Any = None):\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\n return mac.digest()\n\n\ndef _make_keys_list(\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n) -> list[bytes]:\n if isinstance(secret_key, (str, bytes)):\n return [want_bytes(secret_key)]\n\n return [want_bytes(s) for s in secret_key] # pyright: ignore\n\n\nclass Signer:\n \"\"\"A signer securely signs bytes, then unsigns them to verify that\n the value hasn't been changed.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param sep: Separator between the signature and value.\n :param key_derivation: How to derive the signing key from the secret\n key and salt. Possible values are ``concat``, ``django-concat``,\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\n defaults to ``django-concat``.\n :param digest_method: Hash function to use when generating the HMAC\n signature. Defaults to :attr:`default_digest_method`, which\n defaults to :func:`hashlib.sha1`. Note that the security of the\n hash alone doesn't apply when used intermediately in HMAC.\n :param algorithm: A :class:`SigningAlgorithm` instance to use\n instead of building a default :class:`HMACAlgorithm` with the\n ``digest_method``.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 0.18\n ``algorithm`` was added as an argument to the class constructor.\n\n .. versionchanged:: 0.14\n ``key_derivation`` and ``digest_method`` were added as arguments\n to the class constructor.\n \"\"\"\n\n #: The default digest method to use for the signer. The default is\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\n #: compatible object. Note that the security of the hash alone\n #: doesn't apply when used intermediately in HMAC.\n #:\n #: .. versionadded:: 0.14\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n #: The default scheme to use to derive the signing key from the\n #: secret key and salt. The default is ``django-concat``. Possible\n #: values are ``concat``, ``django-concat``, and ``hmac``.\n #:\n #: .. versionadded:: 0.14\n default_key_derivation: str = \"django-concat\"\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous.Signer\",\n sep: str | bytes = b\".\",\n key_derivation: str | None = None,\n digest_method: t.Any | None = None,\n algorithm: SigningAlgorithm | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n self.sep: bytes = want_bytes(sep)\n\n if self.sep in _base64_alphabet:\n raise ValueError(\n \"The given separator cannot be used because it may be\"\n \" contained in the signature itself. ASCII letters,\"\n \" digits, and '-_=' must not be used.\"\n )\n\n if salt is not None:\n salt = want_bytes(salt)\n else:\n salt = b\"itsdangerous.Signer\"\n\n self.salt = salt\n\n if key_derivation is None:\n key_derivation = self.default_key_derivation\n\n self.key_derivation: str = key_derivation\n\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n if algorithm is None:\n algorithm = HMACAlgorithm(self.digest_method)\n\n self.algorithm: SigningAlgorithm = algorithm\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\n \"\"\"This method is called to derive the key. The default key\n derivation choices can be overridden here. Key derivation is not\n intended to be used as a security method to make a complex key\n out of a short password. Instead you should use large random\n secret keys.\n\n :param secret_key: A specific secret key to derive from.\n Defaults to the last item in :attr:`secret_keys`.\n\n .. versionchanged:: 2.0\n Added the ``secret_key`` parameter.\n \"\"\"\n if secret_key is None:\n secret_key = self.secret_keys[-1]\n else:\n secret_key = want_bytes(secret_key)\n\n if self.key_derivation == \"concat\":\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\n elif self.key_derivation == \"django-concat\":\n return t.cast(\n bytes, self.digest_method(self.salt + b\"signer\" + secret_key).digest()\n )\n elif self.key_derivation == \"hmac\":\n mac = hmac.new(secret_key, digestmod=self.digest_method)\n mac.update(self.salt)\n return mac.digest()\n elif self.key_derivation == \"none\":\n return secret_key\n else:\n raise TypeError(\"Unknown key derivation method\")\n\n def get_signature(self, value: str | bytes) -> bytes:\n \"\"\"Returns the signature for the given value.\"\"\"\n value = want_bytes(value)\n key = self.derive_key()\n sig = self.algorithm.get_signature(key, value)\n return base64_encode(sig)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string.\"\"\"\n value = want_bytes(value)\n return value + self.sep + self.get_signature(value)\n\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\n \"\"\"Verifies the signature for the given value.\"\"\"\n try:\n sig = base64_decode(sig)\n except Exception:\n return False\n\n value = want_bytes(value)\n\n for secret_key in reversed(self.secret_keys):\n key = self.derive_key(secret_key)\n\n if self.algorithm.verify_signature(key, value, sig):\n return True\n\n return False\n\n def unsign(self, signed_value: str | bytes) -> bytes:\n \"\"\"Unsigns the given string.\"\"\"\n signed_value = want_bytes(signed_value)\n\n if self.sep not in signed_value:\n raise BadSignature(f\"No {self.sep!r} found in value\")\n\n value, sig = signed_value.rsplit(self.sep, 1)\n\n if self.verify_signature(value, sig):\n return value\n\n raise BadSignature(f\"Signature {sig!r} does not match\", payload=value)\n\n def validate(self, signed_value: str | bytes) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\n \"\"\"\n try:\n self.unsign(signed_value)\n return True\n except BadSignature:\n return False\n\n[end of src/itsdangerous/signer.py]","filename":"src/itsdangerous/signer.py","id":"42"}],"string":"[\n {\n \"content\": \"How to contribute to ItsDangerous\\n=================================\\n\\nThank you for considering contributing to ItsDangerous!\\n\\n\\nSupport questions\\n-----------------\\n\\nPlease don't use the issue tracker for this. The issue tracker is a\\ntool to address bugs and feature requests in ItsDangerous itself. Use\\none of the following resources for questions about using ItsDangerous or\\nissues with your own code:\\n\\n- The ``#get-help`` channel on our Discord chat:\\n https://discord.gg/pallets\\n- The mailing list flask@python.org for long term discussion or larger\\n issues.\\n- Ask on `Stack Overflow`_. Search with Google first using:\\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\\n\\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\\n\\n\\nReporting issues\\n----------------\\n\\nInclude the following information in your post:\\n\\n- Describe what you expected to happen.\\n- If possible, include a `minimal reproducible example`_ to help us\\n identify the issue. This also helps check that the issue is not with\\n your own code.\\n- Describe what actually happened. Include the full traceback if there\\n was an exception.\\n- List your Python and ItsDangerous versions. If possible, check if\\n this issue is already fixed in the latest releases or the latest\\n code in the repository.\\n\\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\\n\\n\\nSubmitting patches\\n------------------\\n\\nIf there is not an open issue for what you want to submit, prefer\\nopening one for discussion before working on a PR. You can work on any\\nissue that doesn't have an open PR linked to it or a maintainer assigned\\nto it. These show up in the sidebar. No need to ask if you can work on\\nan issue that interests you.\\n\\nInclude the following in your patch:\\n\\n- Use `Black`_ to format your code. This and other tools will run\\n automatically if you install `pre-commit`_ using the instructions\\n below.\\n- Include tests if your patch adds or changes code. Make sure the test\\n fails without your patch.\\n- Update any relevant docs pages and docstrings. Docs pages and\\n docstrings should be wrapped at 72 characters.\\n- Add an entry in ``CHANGES.rst``. Use the same style as other\\n entries. Also include ``.. versionchanged::`` inline changelogs in\\n relevant docstrings.\\n\\n.. _Black: https://black.readthedocs.io\\n.. _pre-commit: https://pre-commit.com\\n\\n\\nFirst time setup\\n~~~~~~~~~~~~~~~~\\n\\n- Download and install the `latest version of git`_.\\n- Configure git with your `username`_ and `email`_.\\n\\n .. code-block:: text\\n\\n $ git config --global user.name 'your name'\\n $ git config --global user.email 'your email'\\n\\n- Make sure you have a `GitHub account`_.\\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\\n button.\\n- `Clone`_ the main repository locally.\\n\\n .. code-block:: text\\n\\n $ git clone https://github.com/pallets/itsdangerous\\n $ cd itsdangerous\\n\\n- Add your fork as a remote to push your work to. Replace\\n ``{username}`` with your username. This names the remote \\\"fork\\\", the\\n default Pallets remote is \\\"origin\\\".\\n\\n .. code-block:: text\\n\\n $ git remote add fork https://github.com/{username}/itsdangerous\\n\\n- Create a virtualenv.\\n\\n .. code-block:: text\\n\\n $ python3 -m venv env\\n $ . env/bin/activate\\n\\n On Windows, activating is different.\\n\\n .. code-block:: text\\n\\n > env\\\\Scripts\\\\activate\\n\\n- Install the development dependencies, then install ItsDangerous in\\n editable mode.\\n\\n .. code-block:: text\\n\\n $ pip install -r requirements/dev.txt && pip install -e .\\n\\n- Install the pre-commit hooks.\\n\\n .. code-block:: text\\n\\n $ pre-commit install\\n\\n.. _latest version of git: https://git-scm.com/downloads\\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\\n.. _GitHub account: https://github.com/join\\n.. _Fork: https://github.com/pallets/itsdangerous/fork\\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\\n\\n\\nStart coding\\n~~~~~~~~~~~~\\n\\n- Create a branch to identify the issue you would like to work on. If\\n you're submitting a bug or documentation fix, branch off of the\\n latest \\\".x\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/2.0.x\\n\\n If you're submitting a feature addition or change, branch off of the\\n \\\"main\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/main\\n\\n- Using your favorite editor, make your changes,\\n `committing as you go`_.\\n- Include tests that cover any code changes you make. Make sure the\\n test fails without your patch. Run the tests as described below.\\n- Push your commits to your fork on GitHub and\\n `create a pull request`_. Link to the issue being addressed with\\n ``fixes #123`` in the pull request.\\n\\n .. code-block:: text\\n\\n $ git push --set-upstream fork your-branch-name\\n\\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\\n\\n\\nRunning the tests\\n~~~~~~~~~~~~~~~~~\\n\\nRun the basic test suite with pytest.\\n\\n.. code-block:: text\\n\\n $ pytest\\n\\nThis runs the tests for the current environment, which is usually\\nsufficient. CI will run the full suite when you submit your pull\\nrequest. You can run the full test suite with tox if you don't want to\\nwait.\\n\\n.. code-block:: text\\n\\n $ tox\\n\\n\\nRunning test coverage\\n~~~~~~~~~~~~~~~~~~~~~\\n\\nGenerating a report of lines that do not have test coverage can indicate\\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\\ngenerate a report.\\n\\n.. code-block:: text\\n\\n $ pip install coverage\\n $ coverage run -m pytest\\n $ coverage html\\n\\nOpen ``htmlcov/index.html`` in your browser to explore the report.\\n\\nRead more about `coverage <https://coverage.readthedocs.io>`__.\\n\\n\\nBuilding the docs\\n~~~~~~~~~~~~~~~~~\\n\\nBuild the docs in the ``docs`` directory using Sphinx.\\n\\n.. code-block:: text\\n\\n $ cd docs\\n $ make html\\n\\nOpen ``_build/html/index.html`` in your browser to view the docs.\\n\\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\\n\\n[end of CONTRIBUTING.rst]\",\n \"filename\": \"CONTRIBUTING.rst\",\n \"id\": \"0\"\n },\n {\n \"content\": \"repos:\\n - repo: https://github.com/astral-sh/ruff-pre-commit\\n rev: v0.7.1\\n hooks:\\n - id: ruff\\n - id: ruff-format\\n - repo: https://github.com/pre-commit/pre-commit-hooks\\n rev: v5.0.0\\n hooks:\\n - id: check-merge-conflict\\n - id: debug-statements\\n - id: fix-byte-order-marker\\n - id: trailing-whitespace\\n - id: end-of-file-fixer\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[project]\\nname = \\\"itsdangerous\\\"\\nversion = \\\"2.2.0\\\"\\ndescription = \\\"Safely pass data to untrusted environments and back.\\\"\\nreadme = \\\"README.md\\\"\\nlicense = { file = \\\"LICENSE.txt\\\" }\\nmaintainers = [{ name = \\\"Pallets\\\", email = \\\"contact@palletsprojects.com\\\" }]\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Typing :: Typed\\\",\\n]\\nrequires-python = \\\">=3.8\\\"\\n\\n[project.urls]\\nDonate = \\\"https://palletsprojects.com/donate\\\"\\nDocumentation = \\\"https://itsdangerous.palletsprojects.com/\\\"\\nChanges = \\\"https://itsdangerous.palletsprojects.com/changes/\\\"\\nSource = \\\"https://github.com/pallets/itsdangerous/\\\"\\nChat = \\\"https://discord.gg/pallets\\\"\\n\\n[build-system]\\nrequires = [\\\"flit_core<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.module]\\nname = \\\"itsdangerous\\\"\\n\\n[tool.flit.sdist]\\ninclude = [\\n \\\"docs/\\\",\\n \\\"requirements/\\\",\\n \\\"tests/\\\",\\n \\\"CHANGES.rst\\\",\\n \\\"tox.ini\\\",\\n]\\nexclude = [\\n \\\"docs/_build/\\\",\\n]\\n\\n[tool.pytest.ini_options]\\ntestpaths = [\\\"tests\\\"]\\nfilterwarnings = [\\n \\\"error\\\",\\n]\\n\\n[tool.coverage.run]\\nbranch = true\\nsource = [\\\"itsdangerous\\\", \\\"tests\\\"]\\n\\n[tool.coverage.paths]\\nsource = [\\\"src\\\", \\\"*/site-packages\\\"]\\n\\n[tool.mypy]\\npython_version = \\\"3.8\\\"\\nfiles = [\\\"src/itsdangerous\\\"]\\nshow_error_codes = true\\npretty = true\\nstrict = true\\n\\n[tool.pyright]\\npythonVersion = \\\"3.8\\\"\\ninclude = [\\\"src/itsdangerous\\\"]\\ntypeCheckingMode = \\\"basic\\\"\\n\\n[tool.ruff]\\nsrc = [\\\"src\\\"]\\nfix = true\\nshow-fixes = true\\noutput-format = \\\"full\\\"\\n\\n[tool.ruff.lint]\\nselect = [\\n \\\"B\\\", # flake8-bugbear\\n \\\"E\\\", # pycodestyle error\\n \\\"F\\\", # pyflakes\\n \\\"I\\\", # isort\\n \\\"UP\\\", # pyupgrade\\n \\\"W\\\", # pycodestyle warning\\n]\\n\\n[tool.ruff.lint.isort]\\nforce-single-line = true\\norder-by-type = false\\n\\n[tool.gha-update]\\ntag-only = [\\n \\\"slsa-framework/slsa-github-generator\\\",\\n]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\nindent_style = space\\nindent_size = 4\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\nend_of_line = lf\\ncharset = utf-8\\nmax_line_length = 88\\n\\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"3\"\n },\n {\n \"content\": \"# ItsDangerous\\n\\n... so better sign this\\n\\nVarious helpers to pass data to untrusted environments and to get it\\nback safe and sound. Data is cryptographically signed to ensure that a\\ntoken has not been tampered with.\\n\\nIt's possible to customize how data is serialized. Data is compressed as\\nneeded. A timestamp can be added and verified automatically while\\nloading a token.\\n\\n\\n## A Simple Example\\n\\nHere's how you could generate a token for transmitting a user's id and\\nname between web requests.\\n\\n```python\\nfrom itsdangerous import URLSafeSerializer\\nauth_s = URLSafeSerializer(\\\"secret key\\\", \\\"auth\\\")\\ntoken = auth_s.dumps({\\\"id\\\": 5, \\\"name\\\": \\\"itsdangerous\\\"})\\n\\nprint(token)\\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\\n\\ndata = auth_s.loads(token)\\nprint(data[\\\"name\\\"])\\n# itsdangerous\\n```\\n\\n\\n## Donate\\n\\nThe Pallets organization develops and supports ItsDangerous and other\\npopular packages. In order to grow the community of contributors and\\nusers, and allow the maintainers to devote more time to the projects,\\n[please donate today][].\\n\\n[please donate today]: https://palletsprojects.com/donate\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"[tox]\\nenvlist =\\n py3{13,12,11,10,9,8}\\n pypy310\\n style\\n typing\\n docs\\nskip_missing_interpreters = true\\n\\n[testenv]\\npackage = wheel\\nwheel_build_env = .pkg\\nconstrain_package_deps = true\\nuse_frozen_constraints = true\\ndeps = -r requirements/tests.txt\\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\\n\\n[testenv:style]\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit run --all-files\\n\\n[testenv:typing]\\ndeps = -r requirements/typing.txt\\ncommands =\\n mypy\\n pyright\\n pyright --verifytypes itsdangerous --ignoreexternal\\n\\n[testenv:docs]\\ndeps = -r requirements/docs.txt\\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\\n\\n[testenv:update-actions]\\nlabels = update\\ndeps = gha-update\\ncommands = gha-update\\n\\n[testenv:update-pre_commit]\\nlabels = update\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit autoupdate -j4\\n\\n[testenv:update-requirements]\\nlabels = update\\ndeps = pip-tools\\nskip_install = true\\nchange_dir = requirements\\ncommands =\\n pip-compile build.in -q {posargs:-U}\\n pip-compile docs.in -q {posargs:-U}\\n pip-compile tests.in -q {posargs:-U}\\n pip-compile typing.in -q {posargs:-U}\\n pip-compile dev.in -q {posargs:-U}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"5\"\n },\n {\n \"content\": \"Copyright 2011 Pallets\\n\\nRedistribution and use in source and binary forms, with or without\\nmodification, are permitted provided that the following conditions are\\nmet:\\n\\n1. Redistributions of source code must retain the above copyright\\n notice, this list of conditions and the following disclaimer.\\n\\n2. 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\\n3. Neither the name of the copyright holder nor the names of its\\n contributors may be used to endorse or promote products derived from\\n this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE.txt]\",\n \"filename\": \"LICENSE.txt\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Version 2.2.0\\n-------------\\n\\nReleased 2024-04-16\\n\\n- Drop support for Python 3.7. :pr:`372`\\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\\n :pr:`326`\\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\\n- Deprecate the ``__version__`` attribute. Use feature detection, or\\n ``importlib.metadata.version(\\\"itsdangerous\\\")``, instead. :issue:`371`\\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\\n different ``serializer`` argument is given, it will try to infer the return\\n type of its ``dumps`` method. :issue:`347`\\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\\n access it at import time so the developer has time to change the default.\\n :issue:`375`\\n\\n\\nVersion 2.1.2\\n-------------\\n\\nReleased 2022-03-24\\n\\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\\n\\n\\nVersion 2.1.1\\n-------------\\n\\nReleased 2022-03-09\\n\\n- Handle date overflow in timed unsign. :pr:`296`\\n\\n\\nVersion 2.1.0\\n-------------\\n\\nReleased 2022-02-17\\n\\n- Drop support for Python 3.6. :pr:`272`\\n- Remove previously deprecated code. :pr:`273`\\n\\n - JWS functionality: Use a dedicated library such as Authlib\\n instead.\\n - ``import itsdangerous.json``: Import ``json`` from the standard\\n library instead.\\n\\n\\nVersion 2.0.1\\n-------------\\n\\nReleased 2021-05-18\\n\\n- Mark top-level names as exported so type checking understands\\n imports in user projects. :pr:`240`\\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\\n ``None`` again. :issue:`237`\\n\\n\\nVersion 2.0.0\\n-------------\\n\\nReleased 2021-05-11\\n\\n- Drop support for Python 2 and 3.5.\\n- JWS support (``JSONWebSignatureSerializer``,\\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\\n JWS/JWT library such as authlib instead. :issue:`129`\\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\\n ``json`` module instead. :pr:`152`\\n- Simplejson is no longer used if it is installed. To use a different\\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\\n- If a signature has an age less than 0, it will raise\\n ``SignatureExpired`` rather than appearing valid. This can happen if\\n the timestamp offset is changed. :issue:`126`\\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\\n rather than an ``int`` in some cases. :issue:`124`\\n- Added support for key rotation. A list of keys can be passed as\\n ``secret_key``, oldest to newest. The newest key is used for\\n signing, all keys are tried for unsigning. :pr:`141`\\n- Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``. :issue:`155`\\n- Add type information for static typing tools. :pr:`186`\\n\\n\\nVersion 1.1.0\\n-------------\\n\\nReleased 2018-10-26\\n\\n- Change default signing algorithm back to SHA-1. :pr:`113`\\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\\n release which defaulted to SHA-512. :pr:`114`\\n- Add support for fallback algorithms during deserialization to\\n support changing the default in the future without breaking existing\\n signatures. :pr:`113`\\n- Changed capitalization of packages back to lowercase as the change\\n in capitalization broke some tooling. :pr:`113`\\n\\n\\nVersion 1.0.0\\n-------------\\n\\nReleased 2018-10-18\\n\\nYANKED\\n\\n*Note*: This release was yanked from PyPI because it changed the default\\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\\nat SHA1.\\n\\n- Drop support for Python 2.6 and 3.3.\\n- Refactor code from a single module to a package. Any object in the\\n API docs is still importable from the top-level ``itsdangerous``\\n name, but other imports will need to be changed. A future release\\n will remove many of these compatibility imports. :pr:`107`\\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\\n :pr:`27`\\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\\n Python 3. :issue:`29`\\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\\n- More compact JSON dumps for unicode strings. :issue:`38`\\n- Use the full timestamp rather than an offset, allowing dates before\\n 2011. :issue:`46`\\n\\n To retain compatibility with signers from previous versions,\\n consider using `this shim <https://github.com/pallets/itsdangerous\\n /issues/120#issuecomment-456913331>`_ when unsigning.\\n- Detect a ``sep`` character that may show up in the signature itself\\n and raise a ``ValueError``. :issue:`62`\\n- Use a consistent signature for keyword arguments for\\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\\n- Convert JWS exp header to an int when loading. :pr:`99`\\n\\n\\nVersion 0.24\\n------------\\n\\nReleased 2014-03-28\\n\\n- Added a ``BadHeader`` exception that is used for bad headers that\\n replaces the old ``BadPayload`` exception that was reused in those\\n cases.\\n\\n\\nVersion 0.23\\n------------\\n\\nReleased 2013-08-08\\n\\n- Fixed a packaging mistake that caused the tests and license files to\\n not be included.\\n\\n\\nVersion 0.22\\n------------\\n\\nReleased 2013-07-03\\n\\n- Added support for ``TimedJSONWebSignatureSerializer``.\\n- Made it possible to override the signature verification function to\\n allow implementing asymmetrical algorithms.\\n\\n\\nVersion 0.21\\n------------\\n\\nReleased 2013-05-26\\n\\n- Fixed an issue on Python 3 which caused invalid errors to be\\n generated.\\n\\n\\nVersion 0.20\\n------------\\n\\nReleased 2013-05-23\\n\\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\\n ItsDangerous on Python 2.6.\\n\\n\\nVersion 0.19\\n------------\\n\\nReleased 2013-05-21\\n\\n- Dropped support for 2.5 and added support for 3.3.\\n\\n\\nVersion 0.18\\n------------\\n\\nReleased 2013-05-03\\n\\n- Added support for JSON Web Signatures (JWS).\\n\\n\\nVersion 0.17\\n------------\\n\\nReleased 2012-08-10\\n\\n- Fixed a name error when overriding the digest method.\\n\\n\\nVersion 0.16\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made it possible to pass unicode values to ``load_payload`` to make\\n it easier to debug certain things.\\n\\n\\nVersion 0.15\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made standalone ``load_payload`` more robust by raising one specific\\n error if something goes wrong.\\n- Refactored exceptions to catch more cases individually, added more\\n attributes.\\n- Fixed an issue that caused ``load_payload`` not work in some\\n situations with timestamp based serializers\\n- Added an ``loads_unsafe`` method.\\n\\n\\nVersion 0.14\\n------------\\n\\nReleased 2012-06-29\\n\\n- API refactoring to support different key derivations.\\n- Added attributes to exceptions so that you can inspect the data even\\n if the signature check failed.\\n\\n\\nVersion 0.13\\n------------\\n\\nReleased 2012-06-10\\n\\n- Small API change that enables customization of the digest module.\\n\\n\\nVersion 0.12\\n------------\\n\\nReleased 2012-02-22\\n\\n- Fixed a problem with the local timezone being used for the epoch\\n calculation. This might invalidate some of your signatures if you\\n were not running in UTC timezone. You can revert to the old behavior\\n by monkey patching ``itsdangerous.EPOCH``.\\n\\n\\nVersion 0.11\\n------------\\n\\nReleased 2011-07-07\\n\\n- Fixed an uncaught value error.\\n\\n\\nVersion 0.10\\n------------\\n\\nReleased 2011-06-25\\n\\n- Refactored interface that the underlying serializers can be swapped\\n by passing in a module instead of having to override the payload\\n loaders and dumpers. This makes the interface more compatible with\\n Django's recent changes.\\n\\n[end of CHANGES.rst]\",\n \"filename\": \"CHANGES.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"version: 2\\nbuild:\\n os: ubuntu-22.04\\n tools:\\n python: '3.12'\\npython:\\n install:\\n - requirements: requirements/docs.txt\\n - method: pip\\n path: .\\nsphinx:\\n builder: dirhtml\\n fail_on_warning: true\\n\\n[end of .readthedocs.yaml]\",\n \"filename\": \".readthedocs.yaml\",\n \"id\": \"8\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile dev.in\\n#\\nalabaster==1.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nbabel==2.16.0\\n # via\\n # -r docs.txt\\n # sphinx\\ncachetools==5.5.0\\n # via tox\\ncertifi==2024.8.30\\n # via\\n # -r docs.txt\\n # requests\\ncfgv==3.4.0\\n # via pre-commit\\nchardet==5.2.0\\n # via tox\\ncharset-normalizer==3.4.0\\n # via\\n # -r docs.txt\\n # requests\\ncolorama==0.4.6\\n # via tox\\ndistlib==0.3.9\\n # via virtualenv\\ndocutils==0.21.2\\n # via\\n # -r docs.txt\\n # sphinx\\nfilelock==3.16.1\\n # via\\n # tox\\n # virtualenv\\nfreezegun==1.5.1\\n # via -r tests.txt\\nidentify==2.6.1\\n # via pre-commit\\nidna==3.10\\n # via\\n # -r docs.txt\\n # requests\\nimagesize==1.4.1\\n # via\\n # -r docs.txt\\n # sphinx\\niniconfig==2.0.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\njinja2==3.1.4\\n # via\\n # -r docs.txt\\n # sphinx\\nmarkupsafe==3.0.2\\n # via\\n # -r docs.txt\\n # jinja2\\nmypy==1.13.0\\n # via -r typing.txt\\nmypy-extensions==1.0.0\\n # via\\n # -r typing.txt\\n # mypy\\nnodeenv==1.9.1\\n # via\\n # -r typing.txt\\n # pre-commit\\n # pyright\\npackaging==24.1\\n # via\\n # -r docs.txt\\n # -r tests.txt\\n # -r typing.txt\\n # pallets-sphinx-themes\\n # pyproject-api\\n # pytest\\n # sphinx\\n # tox\\npallets-sphinx-themes==2.3.0\\n # via -r docs.txt\\nplatformdirs==4.3.6\\n # via\\n # tox\\n # virtualenv\\npluggy==1.5.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\n # tox\\npre-commit==4.0.1\\n # via -r dev.in\\npygments==2.18.0\\n # via\\n # -r docs.txt\\n # sphinx\\npyproject-api==1.8.0\\n # via tox\\npyright==1.1.386\\n # via -r typing.txt\\npytest==8.3.3\\n # via\\n # -r tests.txt\\n # -r typing.txt\\npython-dateutil==2.9.0.post0\\n # via\\n # -r tests.txt\\n # freezegun\\npyyaml==6.0.2\\n # via pre-commit\\nrequests==2.32.3\\n # via\\n # -r docs.txt\\n # sphinx\\nsix==1.16.0\\n # via\\n # -r tests.txt\\n # python-dateutil\\nsnowballstemmer==2.2.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.txt\\nsphinxcontrib-qthelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\ntox==4.23.2\\n # via -r dev.in\\ntyping-extensions==4.12.2\\n # via\\n # -r typing.txt\\n # mypy\\n # pyright\\nurllib3==2.2.3\\n # via\\n # -r docs.txt\\n # requests\\nvirtualenv==20.27.0\\n # via\\n # pre-commit\\n # tox\\n\\n[end of requirements/dev.txt]\",\n \"filename\": \"requirements/dev.txt\",\n \"id\": \"9\"\n },\n {\n \"content\": \"pallets-sphinx-themes\\nsphinx\\nsphinxcontrib-log-cabinet\\n\\n[end of requirements/docs.in]\",\n \"filename\": \"requirements/docs.in\",\n \"id\": \"10\"\n },\n {\n \"content\": \"build\\n\\n[end of requirements/build.in]\",\n \"filename\": \"requirements/build.in\",\n \"id\": \"11\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile typing.in\\n#\\niniconfig==2.0.0\\n # via pytest\\nmypy==1.13.0\\n # via -r typing.in\\nmypy-extensions==1.0.0\\n # via mypy\\nnodeenv==1.9.1\\n # via pyright\\npackaging==24.1\\n # via pytest\\npluggy==1.5.0\\n # via pytest\\npyright==1.1.386\\n # via -r typing.in\\npytest==8.3.3\\n # via -r typing.in\\ntyping-extensions==4.12.2\\n # via\\n # mypy\\n # pyright\\n\\n[end of requirements/typing.txt]\",\n \"filename\": \"requirements/typing.txt\",\n \"id\": \"12\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile build.in\\n#\\nbuild==1.2.2.post1\\n # via -r build.in\\npackaging==24.1\\n # via build\\npyproject-hooks==1.2.0\\n # via build\\n\\n[end of requirements/build.txt]\",\n \"filename\": \"requirements/build.txt\",\n \"id\": \"13\"\n },\n {\n \"content\": \"mypy\\npyright\\npytest\\n\\n[end of requirements/typing.in]\",\n \"filename\": \"requirements/typing.in\",\n \"id\": \"14\"\n },\n {\n \"content\": \"-r docs.txt\\n-r tests.txt\\n-r typing.txt\\npre-commit\\ntox\\n\\n[end of requirements/dev.in]\",\n \"filename\": \"requirements/dev.in\",\n \"id\": \"15\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile docs.in\\n#\\nalabaster==1.0.0\\n # via sphinx\\nbabel==2.16.0\\n # via sphinx\\ncertifi==2024.8.30\\n # via requests\\ncharset-normalizer==3.4.0\\n # via requests\\ndocutils==0.21.2\\n # via sphinx\\nidna==3.10\\n # via requests\\nimagesize==1.4.1\\n # via sphinx\\njinja2==3.1.4\\n # via sphinx\\nmarkupsafe==3.0.2\\n # via jinja2\\npackaging==24.1\\n # via\\n # pallets-sphinx-themes\\n # sphinx\\npallets-sphinx-themes==2.3.0\\n # via -r docs.in\\npygments==2.18.0\\n # via sphinx\\nrequests==2.32.3\\n # via sphinx\\nsnowballstemmer==2.2.0\\n # via sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.in\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.in\\nsphinxcontrib-qthelp==2.0.0\\n # via sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via sphinx\\nurllib3==2.2.3\\n # via requests\\n\\n[end of requirements/docs.txt]\",\n \"filename\": \"requirements/docs.txt\",\n \"id\": \"16\"\n },\n {\n \"content\": \".. rst-class:: hide-header\\n\\nItsDangerous\\n============\\n\\n.. image:: _static/itsdangerous-logo.png\\n :align: center\\n :target: https://palletsprojects.com/p/itsdangerous/\\n\\nSometimes you want to send some data to untrusted environments, then get\\nit back later. To do this safely, the data must be signed to detect\\nchanges.\\n\\nGiven a key only you know, you can cryptographically sign your data and\\nhand it over to someone else. When you get the data back you can ensure\\nthat nobody tampered with it.\\n\\nThe receiver can see the data, but they can not modify it unless they\\nalso have your key. So if you keep the key secret and complex, you will\\nbe fine.\\n\\n\\nInstalling\\n----------\\n\\nInstall and update using `pip`_:\\n\\n.. code-block:: text\\n\\n pip install -U itsdangerous\\n\\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\\n\\n\\nExample Use Cases\\n-----------------\\n\\n- Sign a user ID in a URL and email it to them to unsubscribe from a\\n newsletter. This way you don't need to generate one-time tokens and\\n store them in the database. Same thing with any kind of activation\\n link for accounts and similar things.\\n- Signed objects can be stored in cookies or other untrusted sources\\n which means you don't need to have sessions stored on the server,\\n which reduces the number of necessary database queries.\\n- Signed information can safely do a round trip between server and\\n client in general which makes them useful for passing server-side\\n state to a client and then back.\\n\\n\\nTable of Contents\\n-----------------\\n\\n.. toctree::\\n\\n concepts\\n serializer\\n signer\\n exceptions\\n timed\\n url_safe\\n encoding\\n license\\n changes\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"17\"\n },\n {\n \"content\": \".. module:: itsdangerous.serializer\\n\\nSerialization Interface\\n=======================\\n\\nThe :doc:`/signer` only signs bytes. To sign other types, the\\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\\nsimilar to Python's :mod:`json` module, which serializes the object to a\\nstring then signs that.\\n\\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n s = Serializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\\n\\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\\nthe data.\\n\\n.. code-block:: python\\n\\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\\n [1, 2, 3, 4]\\n\\nBy default, data is serialized to JSON with the built-in :mod:`json`\\nmodule. This internal serializer can be changed by subclassing.\\n\\nTo record and validate the age of the signature, see :doc:`/timed`.\\nTo serialize to a format that is safe to use in URLs, see\\n:doc:`/url_safe`.\\n\\n\\nResponding to Failure\\n---------------------\\n\\nExceptions have helpful attributes which allow you to inspect the\\npayload if the signature check failed. This has to be done with extra\\ncare because at that point you know that someone tampered with your data\\nbut it might be useful for debugging purposes.\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n from itsdangerous.exc import BadSignature, BadData\\n\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n decoded_payload = None\\n\\n try:\\n decoded_payload = s.loads(data)\\n # This payload is decoded and safe\\n except BadSignature as e:\\n if e.payload is not None:\\n try:\\n decoded_payload = s.load_payload(e.payload)\\n except BadData:\\n pass\\n # This payload is decoded but unsafe because someone\\n # tampered with the signature. The decode (load_payload)\\n # step is explicit because it might be unsafe to unserialize\\n # the payload (think pickle instead of json!)\\n\\nIf you don't want to inspect attributes to figure out what exactly went\\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\\n\\n.. code-block:: python\\n\\n sig_okay, payload = s.loads_unsafe(data)\\n\\nThe first item in the returned tuple is a boolean that indicates if the\\nsignature was correct.\\n\\n\\nFallback Signers\\n----------------\\n\\nYou may want to upgrade the signing parameters without invalidating\\nexisting signatures immediately. For example, you may decide that you\\nwant to use a different digest method. New signatures should use the new\\nmethod, but old signatures should still validate.\\n\\nA list of ``fallback_signers`` can be given that will be tried if\\nunsigning with the current signer fails. Each item in the list can be:\\n\\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\\n passed to the serializer.\\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\\n serializer.\\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\\n given class with the given args.\\n\\nFor example, this is a serializer that signs using SHA-512, but will\\nunsign using either SHA-512 or SHA-1:\\n\\n.. code-block:: python\\n\\n s = Serializer(\\n signer_kwargs={\\\"digest_method\\\": hashlib.sha512},\\n fallback_signers=[{\\\"digest_method\\\": hashlib.sha1}]\\n )\\n\\n\\n\\nAPI\\n---\\n\\n.. autoclass:: Serializer\\n :members:\\n\\n[end of docs/serializer.rst]\",\n \"filename\": \"docs/serializer.rst\",\n \"id\": \"18\"\n },\n {\n \"content\": \".. module:: itsdangerous.signer\\n\\nSigning Interface\\n=================\\n\\nThe most basic interface is the signing interface. The :class:`Signer`\\nclass can be used to attach a signature to a specific string:\\n\\n.. code-block:: python\\n\\n from itsdangerous import Signer\\n s = Signer(\\\"secret-key\\\")\\n s.sign(\\\"my string\\\")\\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\\n\\nThe signature is appended to the string, separated by a dot. To validate\\nthe string, use the :meth:`~Signer.unsign` method:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n b'my string'\\n\\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\\nHowever after unsigning you won't be able to tell if it was unicode or\\na bytestring.\\n\\nIf the value is changed, the signature will no longer match, and\\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nTo record and validate the age of a signature, see :doc:`/timed`.\\n\\n.. autoclass:: Signer\\n :members:\\n\\n\\nSigning Algorithms\\n------------------\\n\\n.. autoclass:: NoneAlgorithm\\n\\n.. autoclass:: HMACAlgorithm\\n\\n[end of docs/signer.rst]\",\n \"filename\": \"docs/signer.rst\",\n \"id\": \"19\"\n },\n {\n \"content\": \"General Concepts\\n================\\n\\n\\nSerializer vs Signer\\n--------------------\\n\\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\\nthe basic system that signs a given ``bytes`` value based on the given\\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\\nserializing and signing other data besides ``bytes``.\\n\\nTypically, you'll want to use a serializer, not a signer. You can\\nconfigure the signing parameters through the serializer, and even\\nprovide fallback signers to upgrade old tokens to new parameters.\\n\\n\\nThe Secret Key\\n--------------\\n\\nSignatures are secured by the ``secret_key``. Typically one secret key\\nis used with all signers, and the salt is used to distinguish different\\ncontexts. Changing the secret key will invalidate existing tokens.\\n\\nIt should be a long random string of bytes. This value must be kept\\nsecret and should not be saved in source code or committed to version\\ncontrol. If an attacker learns the secret key, they can change and\\nresign data to look valid. If you suspect this happened, change the\\nsecret key to invalidate existing tokens.\\n\\nOne way to keep the secret key separate is to read it from an\\nenvironment variable. When deploying for the first time, generate a key\\nand set the environment variable when running the application. All\\nprocess managers (like systemd) and hosting services have a way to\\nspecify environment variables.\\n\\n.. code-block:: python\\n\\n import os\\n from itsdangerous.serializer import Serializer\\n SECRET_KEY = os.environ.get(\\\"SECRET_KEY\\\")\\n s = Serializer(SECRET_KEY)\\n\\n.. code-block:: text\\n\\n $ export SECRET_KEY=\\\"base64 encoded random bytes\\\"\\n $ python application.py\\n\\nOne way to generate a key is to use :func:`os.urandom`.\\n\\n.. code-block:: text\\n\\n $ python3 -c 'import os; print(os.urandom(16).hex())'\\n\\n\\nThe Salt\\n--------\\n\\nThe salt is combined with the secret key to derive a unique key for\\ndistinguishing different contexts. Unlike the secret key, the salt\\ndoesn't have to be random, and can be saved in code. It only has to be\\nunique between contexts, not private.\\n\\nFor example, you want to email activation links to activate user\\naccounts, and upgrade links to upgrade users to a paid accounts. If all\\nyou sign is the user id, and you don't use different salts, a user could\\nreuse the token from the activation link to upgrade the account. If you\\nuse different salts, the signatures will be different and will not be\\nvalid in the other context.\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n\\n s1 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"activate\\\")\\n s1.dumps(42)\\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\\n\\n s2 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"upgrade\\\")\\n s2.dumps(42)\\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\\n\\nThe second serializer can't load data dumped with the first because the\\nsalts differ.\\n\\n.. code-block:: python\\n\\n s2.loads(s1.dumps(42))\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nOnly the serializer with the same salt can load the data.\\n\\n.. code-block:: python\\n\\n s2.loads(s2.dumps(42))\\n 42\\n\\n\\nKey Rotation\\n------------\\n\\nKey rotation can provide an extra layer of mitigation against an\\nattacker discovering a secret key. A rotation system will keep a list of\\nvalid keys, generating a new key and removing the oldest key\\nperiodically. If it takes four weeks for an attacker to crack a key, but\\nthe key is rotated out after three weeks, they will not be able to use\\nany keys they crack. However, if a user doesn't refresh their token\\nwithin three weeks it will be invalid too.\\n\\nThe system that generates and maintains this list is outside the scope\\nof ItsDangerous, but ItsDangerous does support validating against a list\\nof keys.\\n\\nInstead of passing a single key, you can pass a list of keys, oldest to\\nnewest. When signing the last (newest) key will be used, and when\\nvalidating each key will be tried from newest to oldest before raising\\na validation error.\\n\\n.. code-block:: python\\n\\n SECRET_KEYS = [\\\"2b9cd98e\\\", \\\"169d7886\\\", \\\"b6af09f5\\\"]\\n\\n # sign some data with the latest key\\n s = Serializer(SECRET_KEYS)\\n t = s.dumps({\\\"id\\\": 42})\\n\\n # rotate a new key in and the oldest key out\\n SECRET_KEYS.append(\\\"cf9b3588\\\")\\n del SECRET_KEYS[0]\\n\\n s = Serializer(SECRET_KEYS)\\n s.loads(t) # valid even though it was signed with a previous key\\n\\n\\nDigest Method Security\\n----------------------\\n\\nA signer is configured with a ``digest_method``, a hash function that\\nis used as an intermediate step when generating the HMAC signature. The\\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\\nconcerned about this default because they have heard about hash\\ncollisions with SHA-1.\\n\\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\\nhash alone doesn't apply when used in HMAC.\\n\\nIf a project considers SHA-1 a risk anyway, they can configure the\\nsigner with a different digest method such as :func:`hashlib.sha512`.\\nA fallback signer for SHA-1 can be configured so that old tokens will be\\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\\nspace, which is relevant in cookies and URLs.\\n\\n[end of docs/concepts.rst]\",\n \"filename\": \"docs/concepts.rst\",\n \"id\": \"20\"\n },\n {\n \"content\": \".. module:: itsdangerous.url_safe\\n\\nURL Safe Serialization\\n======================\\n\\nOften it is helpful if you can pass these trusted strings in places\\nwhere you only have a limited set of characters available. Because of\\nthis, ItsDangerous also provides URL safe serializers:\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\\n s.loads(\\\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\\\")\\n [1, 2, 3, 4]\\n\\n.. autoclass:: URLSafeSerializer\\n\\n.. autoclass:: URLSafeTimedSerializer\\n\\n[end of docs/url_safe.rst]\",\n \"filename\": \"docs/url_safe.rst\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. module:: itsdangerous.encoding\\n\\nEncoding Utilities\\n==================\\n\\n.. autofunction:: base64_encode\\n\\n.. autofunction:: base64_decode\\n\\n[end of docs/encoding.rst]\",\n \"filename\": \"docs/encoding.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"# Minimal makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nSOURCEDIR = .\\nBUILDDIR = _build\\n\\n# Put it first so that \\\"make\\\" without argument is like \\\"make help\\\".\\nhelp:\\n\\t@$(SPHINXBUILD) -M help \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n.PHONY: help Makefile\\n\\n# Catch-all target: route all unknown targets to Sphinx using the new\\n# \\\"make mode\\\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\\n%: Makefile\\n\\t@$(SPHINXBUILD) -M $@ \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"23\"\n },\n {\n \"content\": \"from pallets_sphinx_themes import get_version\\nfrom pallets_sphinx_themes import ProjectLink\\n\\n# Project --------------------------------------------------------------\\n\\nproject = \\\"ItsDangerous\\\"\\ncopyright = \\\"2011 Pallets\\\"\\nauthor = \\\"Pallets\\\"\\nrelease, version = get_version(\\\"itsdangerous\\\")\\n\\n# General --------------------------------------------------------------\\n\\ndefault_role = \\\"code\\\"\\nextensions = [\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"sphinx.ext.extlinks\\\",\\n \\\"sphinx.ext.intersphinx\\\",\\n \\\"sphinxcontrib.log_cabinet\\\",\\n \\\"pallets_sphinx_themes\\\",\\n]\\nautoclass_content = \\\"both\\\"\\nautodoc_member_order = \\\"bysource\\\"\\nautodoc_typehints = \\\"description\\\"\\nautodoc_preserve_defaults = True\\nextlinks = {\\n \\\"issue\\\": (\\\"https://github.com/pallets/itsdangerous/issues/%s\\\", \\\"#%s\\\"),\\n \\\"pr\\\": (\\\"https://github.com/pallets/itsdangerous/pull/%s\\\", \\\"#%s\\\"),\\n}\\nintersphinx_mapping = {\\n \\\"python\\\": (\\\"https://docs.python.org/3/\\\", None),\\n}\\n\\n# HTML -----------------------------------------------------------------\\n\\nhtml_theme = \\\"flask\\\"\\nhtml_theme_options = {\\\"index_sidebar_logo\\\": False}\\nhtml_context = {\\n \\\"project_links\\\": [\\n ProjectLink(\\\"Donate\\\", \\\"https://palletsprojects.com/donate\\\"),\\n ProjectLink(\\\"PyPI Releases\\\", \\\"https://pypi.org/project/itsdangerous/\\\"),\\n ProjectLink(\\\"Source Code\\\", \\\"https://github.com/pallets/itsdangerous/\\\"),\\n ProjectLink(\\\"Issue Tracker\\\", \\\"https://github.com/pallets/itsdangerous/issues/\\\"),\\n ProjectLink(\\\"Chat\\\", \\\"https://discord.gg/pallets\\\"),\\n ]\\n}\\nhtml_sidebars = {\\n \\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n \\\"**\\\": [\\\"localtoc.html\\\", \\\"relations.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n}\\nsinglehtml_sidebars = {\\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"ethicalads.html\\\"]}\\nhtml_static_path = [\\\"_static\\\"]\\nhtml_favicon = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_logo = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_title = f\\\"{project} Documentation ({version})\\\"\\nhtml_show_sourcelink = False\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\npushd %~dp0\\n\\nREM Command file for Sphinx documentation\\n\\nif \\\"%SPHINXBUILD%\\\" == \\\"\\\" (\\n\\tset SPHINXBUILD=sphinx-build\\n)\\nset SOURCEDIR=.\\nset BUILDDIR=_build\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\n%SPHINXBUILD% >NUL 2>NUL\\nif errorlevel 9009 (\\n\\techo.\\n\\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\\n\\techo.installed, then set the SPHINXBUILD environment variable to point\\n\\techo.to the full path of the 'sphinx-build' executable. Alternatively you\\n\\techo.may add the Sphinx directory to PATH.\\n\\techo.\\n\\techo.If you don't have Sphinx installed, grab it from\\n\\techo.http://sphinx-doc.org/\\n\\texit /b 1\\n)\\n\\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\ngoto end\\n\\n:help\\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\n\\n:end\\npopd\\n\\n[end of docs/make.bat]\",\n \"filename\": \"docs/make.bat\",\n \"id\": \"25\"\n },\n {\n \"content\": \".. module:: itsdangerous.timed\\n\\nSigning With Timestamps\\n=======================\\n\\nIf you want to expire signatures you can use the\\n:class:`TimestampSigner` class which adds timestamp information and\\nsigns it. On unsigning you can validate that the timestamp is not older\\nthan a given age.\\n\\n.. code-block:: python\\n\\n from itsdangerous import TimestampSigner\\n s = TimestampSigner('secret-key')\\n string = s.sign('foo')\\n\\n.. code-block:: python\\n\\n s.unsign(string, max_age=5)\\n Traceback (most recent call last):\\n ...\\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\\n\\n.. autoclass:: TimestampSigner\\n :members:\\n\\n.. autoclass:: TimedSerializer\\n :members:\\n\\n[end of docs/timed.rst]\",\n \"filename\": \"docs/timed.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"BSD-3-Clause License\\n====================\\n\\n.. literalinclude:: ../LICENSE.txt\\n :language: text\\n\\n[end of docs/license.rst]\",\n \"filename\": \"docs/license.rst\",\n \"id\": \"27\"\n },\n {\n \"content\": \"Changes\\n=======\\n\\n.. include:: ../CHANGES.rst\\n\\n[end of docs/changes.rst]\",\n \"filename\": \"docs/changes.rst\",\n \"id\": \"28\"\n },\n {\n \"content\": \".. module:: itsdangerous.exc\\n\\nExceptions\\n==========\\n\\n.. autoexception:: BadData\\n :members:\\n\\n.. autoexception:: BadSignature\\n :members:\\n\\n.. autoexception:: BadTimeSignature\\n :members:\\n\\n.. autoexception:: SignatureExpired\\n :members:\\n\\n.. autoexception:: BadHeader\\n :members:\\n\\n.. autoexception:: BadPayload\\n :members:\\n\\n[end of docs/exceptions.rst]\",\n \"filename\": \"docs/exceptions.rst\",\n \"id\": \"29\"\n },\n {\n \"content\": \"#!/bin/bash\\nset -e\\npython3 -m venv --upgrade-deps .venv\\n. .venv/bin/activate\\npip install -r requirements/dev.txt\\npip install -e .\\npre-commit install --install-hooks\\n\\n[end of .devcontainer/on-create-command.sh]\",\n \"filename\": \".devcontainer/on-create-command.sh\",\n \"id\": \"30\"\n },\n {\n \"content\": \"{\\n \\\"name\\\": \\\"pallets/itsdangerous\\\",\\n \\\"image\\\": \\\"mcr.microsoft.com/devcontainers/python:3\\\",\\n \\\"customizations\\\": {\\n \\\"vscode\\\": {\\n \\\"settings\\\": {\\n \\\"python.defaultInterpreterPath\\\": \\\"${workspaceFolder}/.venv\\\",\\n \\\"python.terminal.activateEnvInCurrentTerminal\\\": true,\\n \\\"python.terminal.launchArgs\\\": [\\n \\\"-X\\\",\\n \\\"dev\\\"\\n ]\\n }\\n }\\n },\\n \\\"onCreateCommand\\\": \\\".devcontainer/on-create-command.sh\\\"\\n}\\n\\n[end of .devcontainer/devcontainer.json]\",\n \"filename\": \".devcontainer/devcontainer.json\",\n \"id\": \"31\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo-sidebar.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo-sidebar.png\",\n \"id\": \"32\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo.png\",\n \"id\": \"33\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport json as _json\\nimport typing as t\\n\\n\\nclass _CompactJSON:\\n \\\"\\\"\\\"Wrapper around json module that strips whitespace.\\\"\\\"\\\"\\n\\n @staticmethod\\n def loads(payload: str | bytes) -> t.Any:\\n return _json.loads(payload)\\n\\n @staticmethod\\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\\n kwargs.setdefault(\\\"ensure_ascii\\\", False)\\n kwargs.setdefault(\\\"separators\\\", (\\\",\\\", \\\":\\\"))\\n return _json.dumps(obj, **kwargs)\\n\\n[end of src/itsdangerous/_json.py]\",\n \"filename\": \"src/itsdangerous/_json.py\",\n \"id\": \"34\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport time\\nimport typing as t\\nfrom datetime import datetime\\nfrom datetime import timezone\\n\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import bytes_to_int\\nfrom .encoding import int_to_bytes\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\nfrom .exc import BadTimeSignature\\nfrom .exc import SignatureExpired\\nfrom .serializer import _TSerialized\\nfrom .serializer import Serializer\\nfrom .signer import Signer\\n\\n\\nclass TimestampSigner(Signer):\\n \\\"\\\"\\\"Works like the regular :class:`.Signer` but also records the time\\n of the signing and can be used to expire signatures. The\\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\\n unsigning failed because the signature is expired.\\n \\\"\\\"\\\"\\n\\n def get_timestamp(self) -> int:\\n \\\"\\\"\\\"Returns the current timestamp. The function must return an\\n integer.\\n \\\"\\\"\\\"\\n return int(time.time())\\n\\n def timestamp_to_datetime(self, ts: int) -> datetime:\\n \\\"\\\"\\\"Convert the timestamp from :meth:`get_timestamp` into an\\n aware :class`datetime.datetime` in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n return datetime.fromtimestamp(ts, tz=timezone.utc)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string and also attaches time information.\\\"\\\"\\\"\\n value = want_bytes(value)\\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\\n sep = want_bytes(self.sep)\\n value = value + sep + timestamp\\n return value + sep + self.get_signature(value)\\n\\n # Ignore overlapping signatures check, return_timestamp is the only\\n # parameter that affects the return type.\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[False] = False,\\n ) -> bytes: ...\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[True] = True,\\n ) -> tuple[bytes, datetime]: ...\\n\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n ) -> tuple[bytes, datetime] | bytes:\\n \\\"\\\"\\\"Works like the regular :meth:`.Signer.unsign` but can also\\n validate the time. See the base docstring of the class for\\n the general behavior. If ``return_timestamp`` is ``True`` the\\n timestamp of the signature will be returned as an aware\\n :class:`datetime.datetime` object in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n try:\\n result = super().unsign(signed_value)\\n sig_error = None\\n except BadSignature as e:\\n sig_error = e\\n result = e.payload or b\\\"\\\"\\n\\n sep = want_bytes(self.sep)\\n\\n # If there is no timestamp in the result there is something\\n # seriously wrong. In case there was a signature error, we raise\\n # that one directly, otherwise we have a weird situation in\\n # which we shouldn't have come except someone uses a time-based\\n # serializer on non-timestamp data, so catch that.\\n if sep not in result:\\n if sig_error:\\n raise sig_error\\n\\n raise BadTimeSignature(\\\"timestamp missing\\\", payload=result)\\n\\n value, ts_bytes = result.rsplit(sep, 1)\\n ts_int: int | None = None\\n ts_dt: datetime | None = None\\n\\n try:\\n ts_int = bytes_to_int(base64_decode(ts_bytes))\\n except Exception:\\n pass\\n\\n # Signature is *not* okay. Raise a proper error now that we have\\n # split the value and the timestamp.\\n if sig_error is not None:\\n if ts_int is not None:\\n try:\\n ts_dt = self.timestamp_to_datetime(ts_int)\\n except (ValueError, OSError, OverflowError) as exc:\\n # Windows raises OSError\\n # 32-bit raises OverflowError\\n raise BadTimeSignature(\\n \\\"Malformed timestamp\\\", payload=value\\n ) from exc\\n\\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\\n\\n # Signature was okay but the timestamp is actually not there or\\n # malformed. Should not happen, but we handle it anyway.\\n if ts_int is None:\\n raise BadTimeSignature(\\\"Malformed timestamp\\\", payload=value)\\n\\n # Check timestamp is not older than max_age\\n if max_age is not None:\\n age = self.get_timestamp() - ts_int\\n\\n if age > max_age:\\n raise SignatureExpired(\\n f\\\"Signature age {age} > {max_age} seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if age < 0:\\n raise SignatureExpired(\\n f\\\"Signature age {age} < 0 seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if return_timestamp:\\n return value, self.timestamp_to_datetime(ts_int)\\n\\n return value\\n\\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\\"\\\"\\\"\\n try:\\n self.unsign(signed_value, max_age=max_age)\\n return True\\n except BadSignature:\\n return False\\n\\n\\nclass TimedSerializer(Serializer[_TSerialized]):\\n \\\"\\\"\\\"Uses :class:`TimestampSigner` instead of the default\\n :class:`.Signer`.\\n \\\"\\\"\\\"\\n\\n default_signer: type[TimestampSigner] = TimestampSigner\\n\\n def iter_unsigners(\\n self, salt: str | bytes | None = None\\n ) -> cabc.Iterator[TimestampSigner]:\\n return t.cast(\\\"cabc.Iterator[TimestampSigner]\\\", super().iter_unsigners(salt))\\n\\n # TODO: Signature is incompatible because parameters were added\\n # before salt.\\n\\n def loads( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n salt: str | bytes | None = None,\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\\n signature validation fails. If a ``max_age`` is provided it will\\n ensure the signature is not older than that time in seconds. In\\n case the signature is outdated, :exc:`.SignatureExpired` is\\n raised. All arguments are forwarded to the signer's\\n :meth:`~TimestampSigner.unsign` method.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n base64d, timestamp = signer.unsign(\\n s, max_age=max_age, return_timestamp=True\\n )\\n payload = self.load_payload(base64d)\\n\\n if return_timestamp:\\n return payload, timestamp\\n\\n return payload\\n except SignatureExpired:\\n # The signature was unsigned successfully but was\\n # expired. Do not try the next signer.\\n raise\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def loads_unsafe( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n salt: str | bytes | None = None,\\n ) -> tuple[bool, t.Any]:\\n return self._loads_unsafe_impl(s, salt, load_kwargs={\\\"max_age\\\": max_age})\\n\\n[end of src/itsdangerous/timed.py]\",\n \"filename\": \"src/itsdangerous/timed.py\",\n \"id\": \"35\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport base64\\nimport string\\nimport struct\\nimport typing as t\\n\\nfrom .exc import BadData\\n\\n\\ndef want_bytes(\\n s: str | bytes, encoding: str = \\\"utf-8\\\", errors: str = \\\"strict\\\"\\n) -> bytes:\\n if isinstance(s, str):\\n s = s.encode(encoding, errors)\\n\\n return s\\n\\n\\ndef base64_encode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 encode a string of bytes or text. The resulting bytes are\\n safe to use in URLs.\\n \\\"\\\"\\\"\\n string = want_bytes(string)\\n return base64.urlsafe_b64encode(string).rstrip(b\\\"=\\\")\\n\\n\\ndef base64_decode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 decode a URL-safe string of bytes or text. The result is\\n bytes.\\n \\\"\\\"\\\"\\n string = want_bytes(string, encoding=\\\"ascii\\\", errors=\\\"ignore\\\")\\n string += b\\\"=\\\" * (-len(string) % 4)\\n\\n try:\\n return base64.urlsafe_b64decode(string)\\n except (TypeError, ValueError) as e:\\n raise BadData(\\\"Invalid base64-encoded data\\\") from e\\n\\n\\n# The alphabet used by base64.urlsafe_*\\n_base64_alphabet = f\\\"{string.ascii_letters}{string.digits}-_=\\\".encode(\\\"ascii\\\")\\n\\n_int64_struct = struct.Struct(\\\">Q\\\")\\n_int_to_bytes = _int64_struct.pack\\n_bytes_to_int = t.cast(\\\"t.Callable[[bytes], tuple[int]]\\\", _int64_struct.unpack)\\n\\n\\ndef int_to_bytes(num: int) -> bytes:\\n return _int_to_bytes(num).lstrip(b\\\"\\\\x00\\\")\\n\\n\\ndef bytes_to_int(bytestr: bytes) -> int:\\n return _bytes_to_int(bytestr.rjust(8, b\\\"\\\\x00\\\"))[0]\\n\\n[end of src/itsdangerous/encoding.py]\",\n \"filename\": \"src/itsdangerous/encoding.py\",\n \"id\": \"36\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\n\\nfrom .encoding import base64_decode as base64_decode\\nfrom .encoding import base64_encode as base64_encode\\nfrom .encoding import want_bytes as want_bytes\\nfrom .exc import BadData as BadData\\nfrom .exc import BadHeader as BadHeader\\nfrom .exc import BadPayload as BadPayload\\nfrom .exc import BadSignature as BadSignature\\nfrom .exc import BadTimeSignature as BadTimeSignature\\nfrom .exc import SignatureExpired as SignatureExpired\\nfrom .serializer import Serializer as Serializer\\nfrom .signer import HMACAlgorithm as HMACAlgorithm\\nfrom .signer import NoneAlgorithm as NoneAlgorithm\\nfrom .signer import Signer as Signer\\nfrom .timed import TimedSerializer as TimedSerializer\\nfrom .timed import TimestampSigner as TimestampSigner\\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\\n\\n\\ndef __getattr__(name: str) -> t.Any:\\n if name == \\\"__version__\\\":\\n import importlib.metadata\\n import warnings\\n\\n warnings.warn(\\n \\\"The '__version__' attribute is deprecated and will be removed in\\\"\\n \\\" ItsDangerous 2.3. Use feature detection or\\\"\\n \\\" 'importlib.metadata.version(\\\\\\\"itsdangerous\\\\\\\")' instead.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return importlib.metadata.version(\\\"itsdangerous\\\")\\n\\n raise AttributeError(name)\\n\\n[end of src/itsdangerous/__init__.py]\",\n \"filename\": \"src/itsdangerous/__init__.py\",\n \"id\": \"37\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nimport zlib\\n\\nfrom ._json import _CompactJSON\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .exc import BadPayload\\nfrom .serializer import _PDataSerializer\\nfrom .serializer import Serializer\\nfrom .timed import TimedSerializer\\n\\n\\nclass URLSafeSerializerMixin(Serializer[str]):\\n \\\"\\\"\\\"Mixed in with a regular serializer it will attempt to zlib\\n compress the string to make it shorter if necessary. It will also\\n base64 encode the string so that it can safely be placed in a URL.\\n \\\"\\\"\\\"\\n\\n default_serializer: _PDataSerializer[str] = _CompactJSON\\n\\n def load_payload(\\n self,\\n payload: bytes,\\n *args: t.Any,\\n serializer: t.Any | None = None,\\n **kwargs: t.Any,\\n ) -> t.Any:\\n decompress = False\\n\\n if payload.startswith(b\\\".\\\"):\\n payload = payload[1:]\\n decompress = True\\n\\n try:\\n json = base64_decode(payload)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not base64 decode the payload because of an exception\\\",\\n original_error=e,\\n ) from e\\n\\n if decompress:\\n try:\\n json = zlib.decompress(json)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not zlib decompress the payload before decoding the payload\\\",\\n original_error=e,\\n ) from e\\n\\n return super().load_payload(json, *args, **kwargs)\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n json = super().dump_payload(obj)\\n is_compressed = False\\n compressed = zlib.compress(json)\\n\\n if len(compressed) < (len(json) - 1):\\n json = compressed\\n is_compressed = True\\n\\n base64d = base64_encode(json)\\n\\n if is_compressed:\\n base64d = b\\\".\\\" + base64d\\n\\n return base64d\\n\\n\\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\\n \\\"\\\"\\\"Works like :class:`.Serializer` but dumps and loads into a URL\\n safe string consisting of the upper and lowercase character of the\\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n\\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\\n \\\"\\\"\\\"Works like :class:`.TimedSerializer` but dumps and loads into a\\n URL safe string consisting of the upper and lowercase character of\\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n[end of src/itsdangerous/url_safe.py]\",\n \"filename\": \"src/itsdangerous/url_safe.py\",\n \"id\": \"38\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nfrom datetime import datetime\\n\\n\\nclass BadData(Exception):\\n \\\"\\\"\\\"Raised if bad data of any sort was encountered. This is the base\\n for all exceptions that ItsDangerous defines.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str):\\n super().__init__(message)\\n self.message = message\\n\\n def __str__(self) -> str:\\n return self.message\\n\\n\\nclass BadSignature(BadData):\\n \\\"\\\"\\\"Raised if a signature does not match.\\\"\\\"\\\"\\n\\n def __init__(self, message: str, payload: t.Any | None = None):\\n super().__init__(message)\\n\\n #: The payload that failed the signature test. In some\\n #: situations you might still want to inspect this, even if\\n #: you know it was tampered with.\\n #:\\n #: .. versionadded:: 0.14\\n self.payload: t.Any | None = payload\\n\\n\\nclass BadTimeSignature(BadSignature):\\n \\\"\\\"\\\"Raised if a time-based signature is invalid. This is a subclass\\n of :class:`BadSignature`.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n date_signed: datetime | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the signature expired this exposes the date of when the\\n #: signature was created. This can be helpful in order to\\n #: tell the user how long a link has been gone stale.\\n #:\\n #: .. versionchanged:: 2.0\\n #: The datetime value is timezone-aware rather than naive.\\n #:\\n #: .. versionadded:: 0.14\\n self.date_signed = date_signed\\n\\n\\nclass SignatureExpired(BadTimeSignature):\\n \\\"\\\"\\\"Raised if a signature timestamp is older than ``max_age``. This\\n is a subclass of :exc:`BadTimeSignature`.\\n \\\"\\\"\\\"\\n\\n\\nclass BadHeader(BadSignature):\\n \\\"\\\"\\\"Raised if a signed header is invalid in some form. This only\\n happens for serializers that have a header that goes with the\\n signature.\\n\\n .. versionadded:: 0.24\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n header: t.Any | None = None,\\n original_error: Exception | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the header is actually available but just malformed it\\n #: might be stored here.\\n self.header: t.Any | None = header\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n\\nclass BadPayload(BadData):\\n \\\"\\\"\\\"Raised if a payload is invalid. This could happen if the payload\\n is loaded despite an invalid signature, or if there is a mismatch\\n between the serializer and deserializer. The original exception\\n that occurred during loading is stored on as :attr:`original_error`.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str, original_error: Exception | None = None):\\n super().__init__(message)\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n[end of src/itsdangerous/exc.py]\",\n \"filename\": \"src/itsdangerous/exc.py\",\n \"id\": \"39\"\n },\n {\n \"content\": \"[end of src/itsdangerous/py.typed]\",\n \"filename\": \"src/itsdangerous/py.typed\",\n \"id\": \"40\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport json\\nimport typing as t\\n\\nfrom .encoding import want_bytes\\nfrom .exc import BadPayload\\nfrom .exc import BadSignature\\nfrom .signer import _make_keys_list\\nfrom .signer import Signer\\n\\nif t.TYPE_CHECKING:\\n import typing_extensions as te\\n\\n # This should be either be str or bytes. To avoid having to specify the\\n # bound type, it falls back to a union if structural matching fails.\\n _TSerialized = te.TypeVar(\\n \\\"_TSerialized\\\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\\n )\\nelse:\\n # Still available at runtime on Python < 3.13, but without the default.\\n _TSerialized = t.TypeVar(\\\"_TSerialized\\\", bound=t.Union[str, bytes])\\n\\n\\nclass _PDataSerializer(t.Protocol[_TSerialized]):\\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\\n # A signature with additional arguments is not handled correctly by type\\n # checkers right now, so an overload is used below for serializers that\\n # don't match this strict protocol.\\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\\n\\n\\n# Use TypeIs once it's available in typing_extensions or 3.13.\\ndef is_text_serializer(\\n serializer: _PDataSerializer[t.Any],\\n) -> te.TypeGuard[_PDataSerializer[str]]:\\n \\\"\\\"\\\"Checks whether a serializer generates text or binary.\\\"\\\"\\\"\\n return isinstance(serializer.dumps({}), str)\\n\\n\\nclass Serializer(t.Generic[_TSerialized]):\\n \\\"\\\"\\\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\\n enable serializing and securely signing data other than bytes. It\\n can unsign to verify that the data hasn't been changed.\\n\\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\\n :mod:`json`, and by default uses :mod:`json` internally to serialize\\n the data to bytes.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param serializer: An object that provides ``dumps`` and ``loads``\\n methods for serializing data to a string. Defaults to\\n :attr:`default_serializer`, which defaults to :mod:`json`.\\n :param serializer_kwargs: Keyword arguments to pass when calling\\n ``serializer.dumps``.\\n :param signer: A ``Signer`` class to instantiate when signing data.\\n Defaults to :attr:`default_signer`, which defaults to\\n :class:`~itsdangerous.signer.Signer`.\\n :param signer_kwargs: Keyword arguments to pass when instantiating\\n the ``Signer`` class.\\n :param fallback_signers: List of signer parameters to try when\\n unsigning with the default signer fails. Each item can be a dict\\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\\n ``(signer, signer_kwargs)``. Defaults to\\n :attr:`default_fallback_signers`.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 2.0\\n Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``.\\n\\n .. versionchanged:: 1.1\\n Added support for ``fallback_signers`` and configured a default\\n SHA-512 fallback. This fallback is for users who used the yanked\\n 1.0.0 release which defaulted to SHA-512.\\n\\n .. versionchanged:: 0.14\\n The ``signer`` and ``signer_kwargs`` parameters were added to\\n the constructor.\\n \\\"\\\"\\\"\\n\\n #: The default serialization module to use to serialize data to a\\n #: string internally. The default is :mod:`json`, but can be changed\\n #: to any object that provides ``dumps`` and ``loads`` methods.\\n default_serializer: _PDataSerializer[t.Any] = json\\n\\n #: The default ``Signer`` class to instantiate when signing data.\\n #: The default is :class:`itsdangerous.signer.Signer`.\\n default_signer: type[Signer] = Signer\\n\\n #: The default fallback signers to try when unsigning fails.\\n default_fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = []\\n\\n # Serializer[str] if no data serializer is provided, or if it returns str.\\n @t.overload\\n def __init__(\\n self: Serializer[str],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: None | _PDataSerializer[str] = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer positional argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer keyword argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a positional argument. If the strict signature of\\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\\n # to specify the type.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a keyword argument.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: t.Any | None = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n # if salt is None then the signer's default is used\\n\\n self.salt = salt\\n\\n if serializer is None:\\n serializer = self.default_serializer\\n\\n self.serializer: _PDataSerializer[_TSerialized] = serializer\\n self.is_text_serializer: bool = is_text_serializer(serializer)\\n\\n if signer is None:\\n signer = self.default_signer\\n\\n self.signer: type[Signer] = signer\\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\\n\\n if fallback_signers is None:\\n fallback_signers = list(self.default_fallback_signers)\\n\\n self.fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = fallback_signers\\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def load_payload(\\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\\n ) -> t.Any:\\n \\\"\\\"\\\"Loads the encoded object. This function raises\\n :class:`.BadPayload` if the payload is not valid. The\\n ``serializer`` parameter can be used to override the serializer\\n stored on the class. The encoded ``payload`` should always be\\n bytes.\\n \\\"\\\"\\\"\\n if serializer is None:\\n use_serializer = self.serializer\\n is_text = self.is_text_serializer\\n else:\\n use_serializer = serializer\\n is_text = is_text_serializer(serializer)\\n\\n try:\\n if is_text:\\n return use_serializer.loads(payload.decode(\\\"utf-8\\\")) # type: ignore[arg-type]\\n\\n return use_serializer.loads(payload) # type: ignore[arg-type]\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not load the payload because an exception\\\"\\n \\\" occurred on unserializing the data.\\\",\\n original_error=e,\\n ) from e\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n \\\"\\\"\\\"Dumps the encoded object. The return value is always bytes.\\n If the internal serializer returns text, the value will be\\n encoded as UTF-8.\\n \\\"\\\"\\\"\\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\\n\\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\\n \\\"\\\"\\\"Creates a new instance of the signer to be used. The default\\n implementation uses the :class:`.Signer` base class.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\\n\\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\\n \\\"\\\"\\\"Iterates over all signers to be tried for unsigning. Starts\\n with the configured signer, then constructs each signer\\n specified in ``fallback_signers``.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n yield self.make_signer(salt)\\n\\n for fallback in self.fallback_signers:\\n if isinstance(fallback, dict):\\n kwargs = fallback\\n fallback = self.signer\\n elif isinstance(fallback, tuple):\\n fallback, kwargs = fallback\\n else:\\n kwargs = self.signer_kwargs\\n\\n for secret_key in self.secret_keys:\\n yield fallback(secret_key, salt=salt, **kwargs)\\n\\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\\n \\\"\\\"\\\"Returns a signed string serialized with the internal\\n serializer. The return value can be either a byte or unicode\\n string depending on the format of the internal serializer.\\n \\\"\\\"\\\"\\n payload = want_bytes(self.dump_payload(obj))\\n rv = self.make_signer(salt).sign(payload)\\n\\n if self.is_text_serializer:\\n return rv.decode(\\\"utf-8\\\") # type: ignore[return-value]\\n\\n return rv # type: ignore[return-value]\\n\\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\\n \\\"\\\"\\\"Like :meth:`dumps` but dumps into a file. The file handle has\\n to be compatible with what the internal serializer expects.\\n \\\"\\\"\\\"\\n f.write(self.dumps(obj, salt))\\n\\n def loads(\\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\\n signature validation fails.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n return self.load_payload(signer.unsign(s))\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\\n \\\"\\\"\\\"Like :meth:`loads` but loads from a file.\\\"\\\"\\\"\\n return self.loads(f.read(), salt)\\n\\n def loads_unsafe(\\n self, s: str | bytes, salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads` but without verifying the signature. This\\n is potentially very dangerous to use depending on how your\\n serializer works. The return value is ``(signature_valid,\\n payload)`` instead of just the payload. The first item will be a\\n boolean that indicates if the signature is valid. This function\\n never fails.\\n\\n Use it for debugging only and if you know that your serializer\\n module is not exploitable (for example, do not use it with a\\n pickle serializer).\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self._loads_unsafe_impl(s, salt)\\n\\n def _loads_unsafe_impl(\\n self,\\n s: str | bytes,\\n salt: str | bytes | None,\\n load_kwargs: dict[str, t.Any] | None = None,\\n load_payload_kwargs: dict[str, t.Any] | None = None,\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Low level helper function to implement :meth:`loads_unsafe`\\n in serializer subclasses.\\n \\\"\\\"\\\"\\n if load_kwargs is None:\\n load_kwargs = {}\\n\\n try:\\n return True, self.loads(s, salt=salt, **load_kwargs)\\n except BadSignature as e:\\n if e.payload is None:\\n return False, None\\n\\n if load_payload_kwargs is None:\\n load_payload_kwargs = {}\\n\\n try:\\n return (\\n False,\\n self.load_payload(e.payload, **load_payload_kwargs),\\n )\\n except BadPayload:\\n return False, None\\n\\n def load_unsafe(\\n self, f: t.IO[t.Any], salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads_unsafe` but loads from a file.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self.loads_unsafe(f.read(), salt=salt)\\n\\n[end of src/itsdangerous/serializer.py]\",\n \"filename\": \"src/itsdangerous/serializer.py\",\n \"id\": \"41\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport hashlib\\nimport hmac\\nimport typing as t\\n\\nfrom .encoding import _base64_alphabet\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\n\\n\\nclass SigningAlgorithm:\\n \\\"\\\"\\\"Subclasses must implement :meth:`get_signature` to provide\\n signature generation functionality.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given key and value.\\\"\\\"\\\"\\n raise NotImplementedError()\\n\\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\\n \\\"\\\"\\\"Verifies the given signature matches the expected\\n signature.\\n \\\"\\\"\\\"\\n return hmac.compare_digest(sig, self.get_signature(key, value))\\n\\n\\nclass NoneAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides an algorithm that does not perform any signing and\\n returns an empty signature.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n return b\\\"\\\"\\n\\n\\ndef _lazy_sha1(string: bytes = b\\\"\\\") -> t.Any:\\n \\\"\\\"\\\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\\n SHA-1, in which case the import and use as a default would fail before the\\n developer can configure something else.\\n \\\"\\\"\\\"\\n return hashlib.sha1(string)\\n\\n\\nclass HMACAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides signature generation using HMACs.\\\"\\\"\\\"\\n\\n #: The digest method to use with the MAC algorithm. This defaults to\\n #: SHA1, but can be changed to any other function in the hashlib\\n #: module.\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n def __init__(self, digest_method: t.Any = None):\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\\n return mac.digest()\\n\\n\\ndef _make_keys_list(\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n) -> list[bytes]:\\n if isinstance(secret_key, (str, bytes)):\\n return [want_bytes(secret_key)]\\n\\n return [want_bytes(s) for s in secret_key] # pyright: ignore\\n\\n\\nclass Signer:\\n \\\"\\\"\\\"A signer securely signs bytes, then unsigns them to verify that\\n the value hasn't been changed.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param sep: Separator between the signature and value.\\n :param key_derivation: How to derive the signing key from the secret\\n key and salt. Possible values are ``concat``, ``django-concat``,\\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\\n defaults to ``django-concat``.\\n :param digest_method: Hash function to use when generating the HMAC\\n signature. Defaults to :attr:`default_digest_method`, which\\n defaults to :func:`hashlib.sha1`. Note that the security of the\\n hash alone doesn't apply when used intermediately in HMAC.\\n :param algorithm: A :class:`SigningAlgorithm` instance to use\\n instead of building a default :class:`HMACAlgorithm` with the\\n ``digest_method``.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 0.18\\n ``algorithm`` was added as an argument to the class constructor.\\n\\n .. versionchanged:: 0.14\\n ``key_derivation`` and ``digest_method`` were added as arguments\\n to the class constructor.\\n \\\"\\\"\\\"\\n\\n #: The default digest method to use for the signer. The default is\\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\\n #: compatible object. Note that the security of the hash alone\\n #: doesn't apply when used intermediately in HMAC.\\n #:\\n #: .. versionadded:: 0.14\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n #: The default scheme to use to derive the signing key from the\\n #: secret key and salt. The default is ``django-concat``. Possible\\n #: values are ``concat``, ``django-concat``, and ``hmac``.\\n #:\\n #: .. versionadded:: 0.14\\n default_key_derivation: str = \\\"django-concat\\\"\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous.Signer\\\",\\n sep: str | bytes = b\\\".\\\",\\n key_derivation: str | None = None,\\n digest_method: t.Any | None = None,\\n algorithm: SigningAlgorithm | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n self.sep: bytes = want_bytes(sep)\\n\\n if self.sep in _base64_alphabet:\\n raise ValueError(\\n \\\"The given separator cannot be used because it may be\\\"\\n \\\" contained in the signature itself. ASCII letters,\\\"\\n \\\" digits, and '-_=' must not be used.\\\"\\n )\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n else:\\n salt = b\\\"itsdangerous.Signer\\\"\\n\\n self.salt = salt\\n\\n if key_derivation is None:\\n key_derivation = self.default_key_derivation\\n\\n self.key_derivation: str = key_derivation\\n\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n if algorithm is None:\\n algorithm = HMACAlgorithm(self.digest_method)\\n\\n self.algorithm: SigningAlgorithm = algorithm\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\\n \\\"\\\"\\\"This method is called to derive the key. The default key\\n derivation choices can be overridden here. Key derivation is not\\n intended to be used as a security method to make a complex key\\n out of a short password. Instead you should use large random\\n secret keys.\\n\\n :param secret_key: A specific secret key to derive from.\\n Defaults to the last item in :attr:`secret_keys`.\\n\\n .. versionchanged:: 2.0\\n Added the ``secret_key`` parameter.\\n \\\"\\\"\\\"\\n if secret_key is None:\\n secret_key = self.secret_keys[-1]\\n else:\\n secret_key = want_bytes(secret_key)\\n\\n if self.key_derivation == \\\"concat\\\":\\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\\n elif self.key_derivation == \\\"django-concat\\\":\\n return t.cast(\\n bytes, self.digest_method(self.salt + b\\\"signer\\\" + secret_key).digest()\\n )\\n elif self.key_derivation == \\\"hmac\\\":\\n mac = hmac.new(secret_key, digestmod=self.digest_method)\\n mac.update(self.salt)\\n return mac.digest()\\n elif self.key_derivation == \\\"none\\\":\\n return secret_key\\n else:\\n raise TypeError(\\\"Unknown key derivation method\\\")\\n\\n def get_signature(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given value.\\\"\\\"\\\"\\n value = want_bytes(value)\\n key = self.derive_key()\\n sig = self.algorithm.get_signature(key, value)\\n return base64_encode(sig)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string.\\\"\\\"\\\"\\n value = want_bytes(value)\\n return value + self.sep + self.get_signature(value)\\n\\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\\n \\\"\\\"\\\"Verifies the signature for the given value.\\\"\\\"\\\"\\n try:\\n sig = base64_decode(sig)\\n except Exception:\\n return False\\n\\n value = want_bytes(value)\\n\\n for secret_key in reversed(self.secret_keys):\\n key = self.derive_key(secret_key)\\n\\n if self.algorithm.verify_signature(key, value, sig):\\n return True\\n\\n return False\\n\\n def unsign(self, signed_value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Unsigns the given string.\\\"\\\"\\\"\\n signed_value = want_bytes(signed_value)\\n\\n if self.sep not in signed_value:\\n raise BadSignature(f\\\"No {self.sep!r} found in value\\\")\\n\\n value, sig = signed_value.rsplit(self.sep, 1)\\n\\n if self.verify_signature(value, sig):\\n return value\\n\\n raise BadSignature(f\\\"Signature {sig!r} does not match\\\", payload=value)\\n\\n def validate(self, signed_value: str | bytes) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\n \\\"\\\"\\\"\\n try:\\n self.unsign(signed_value)\\n return True\\n except BadSignature:\\n return False\\n\\n[end of src/itsdangerous/signer.py]\",\n \"filename\": \"src/itsdangerous/signer.py\",\n \"id\": \"42\"\n }\n]","isConversational":false}}},{"rowIdx":74,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 74,\n \"num_files\": 43,\n \"repo_id\": \"repo_0074\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerous itself. Use\none of the following resources for questions about using ItsDangerous or\nissues with your own code:\n\n- The ``#get-help`` channel on our Discord chat:\n https://discord.gg/pallets\n- The mailing list flask@python.org for long term discussion or larger\n issues.\n- Ask on `Stack Overflow`_. Search with Google first using:\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\n\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\n\n\nReporting issues\n----------------\n\nInclude the following information in your post:\n\n- Describe what you expected to happen.\n- If possible, include a `minimal reproducible example`_ to help us\n identify the issue. This also helps check that the issue is not with\n your own code.\n- Describe what actually happened. Include the full traceback if there\n was an exception.\n- List your Python and ItsDangerous versions. If possible, check if\n this issue is already fixed in the latest releases or the latest\n code in the repository.\n\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\n\n\nSubmitting patches\n------------------\n\nIf there is not an open issue for what you want to submit, prefer\nopening one for discussion before working on a PR. You can work on any\nissue that doesn't have an open PR linked to it or a maintainer assigned\nto it. These show up in the sidebar. No need to ask if you can work on\nan issue that interests you.\n\nInclude the following in your patch:\n\n- Use `Black`_ to format your code. This and other tools will run\n automatically if you install `pre-commit`_ using the instructions\n below.\n- Include tests if your patch adds or changes code. Make sure the test\n fails without your patch.\n- Update any relevant docs pages and docstrings. Docs pages and\n docstrings should be wrapped at 72 characters.\n- Add an entry in ``CHANGES.rst``. Use the same style as other\n entries. Also include ``.. versionchanged::`` inline changelogs in\n relevant docstrings.\n\n.. _Black: https://black.readthedocs.io\n.. _pre-commit: https://pre-commit.com\n\n\nFirst time setup\n~~~~~~~~~~~~~~~~\n\n- Download and install the `latest version of git`_.\n- Configure git with your `username`_ and `email`_.\n\n .. code-block:: text\n\n $ git config --global user.name 'your name'\n $ git config --global user.email 'your email'\n\n- Make sure you have a `GitHub account`_.\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\n button.\n- `Clone`_ the main repository locally.\n\n .. code-block:: text\n\n $ git clone https://github.com/pallets/itsdangerous\n $ cd itsdangerous\n\n- Add your fork as a remote to push your work to. Replace\n ``{username}`` with your username. This names the remote \"fork\", the\n default Pallets remote is \"origin\".\n\n .. code-block:: text\n\n $ git remote add fork https://github.com/{username}/itsdangerous\n\n- Create a virtualenv.\n\n .. code-block:: text\n\n $ python3 -m venv env\n $ . env/bin/activate\n\n On Windows, activating is different.\n\n .. code-block:: text\n\n > env\\Scripts\\activate\n\n- Install the development dependencies, then install ItsDangerous in\n editable mode.\n\n .. code-block:: text\n\n $ pip install -r requirements/dev.txt && pip install -e .\n\n- Install the pre-commit hooks.\n\n .. code-block:: text\n\n $ pre-commit install\n\n.. _latest version of git: https://git-scm.com/downloads\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\n.. _GitHub account: https://github.com/join\n.. _Fork: https://github.com/pallets/itsdangerous/fork\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\n\n\nStart coding\n~~~~~~~~~~~~\n\n- Create a branch to identify the issue you would like to work on. If\n you're submitting a bug or documentation fix, branch off of the\n latest \".x\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/2.0.x\n\n If you're submitting a feature addition or change, branch off of the\n \"main\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/main\n\n- Using your favorite editor, make your changes,\n `committing as you go`_.\n- Include tests that cover any code changes you make. Make sure the\n test fails without your patch. Run the tests as described below.\n- Push your commits to your fork on GitHub and\n `create a pull request`_. Link to the issue being addressed with\n ``fixes #123`` in the pull request.\n\n .. code-block:: text\n\n $ git push --set-upstream fork your-branch-name\n\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\n\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nRun the basic test suite with pytest.\n\n.. code-block:: text\n\n $ pytest\n\nThis runs the tests for the current environment, which is usually\nsufficient. CI will run the full suite when you submit your pull\nrequest. You can run the full test suite with tox if you don't want to\nwait.\n\n.. code-block:: text\n\n $ tox\n\n\nRunning test coverage\n~~~~~~~~~~~~~~~~~~~~~\n\nGenerating a report of lines that do not have test coverage can indicate\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\ngenerate a report.\n\n.. code-block:: text\n\n $ pip install coverage\n $ coverage run -m pytest\n $ coverage html\n\nOpen ``htmlcov/index.html`` in your browser to explore the report.\n\nRead more about `coverage <https://coverage.readthedocs.io>`__.\n\n\nBuilding the docs\n~~~~~~~~~~~~~~~~~\n\nBuild the docs in the ``docs`` directory using Sphinx.\n\n.. code-block:: text\n\n $ cd docs\n $ make html\n\nOpen ``_build/html/index.html`` in your browser to view the docs.\n\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\n\n[end of CONTRIBUTING.rst]","filename":"CONTRIBUTING.rst","id":"0"},{"content":"repos:\n - repo: https://github.com/astral-sh/ruff-pre-commit\n rev: v0.7.1\n hooks:\n - id: ruff\n - id: ruff-format\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: check-merge-conflict\n - id: debug-statements\n - id: fix-byte-order-marker\n - id: trailing-whitespace\n - id: end-of-file-fixer\n\n[end of .pre-commit-config.yaml]","filename":".pre-commit-config.yaml","id":"1"},{"content":"[project]\nname = \"itsdangerous\"\nversion = \"2.2.0\"\ndescription = \"Safely pass data to untrusted environments and back.\"\nreadme = \"README.md\"\nlicense = { file = \"LICENSE.txt\" }\nmaintainers = [{ name = \"Pallets\", email = \"contact@palletsprojects.com\" }]\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python\",\n \"Typing :: Typed\",\n]\nrequires-python = \">=3.8\"\n\n[project.urls]\nDonate = \"https://palletsprojects.com/donate\"\nDocumentation = \"https://itsdangerous.palletsprojects.com/\"\nChanges = \"https://itsdangerous.palletsprojects.com/changes/\"\nSource = \"https://github.com/pallets/itsdangerous/\"\nChat = \"https://discord.gg/pallets\"\n\n[build-system]\nrequires = [\"flit_core<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.module]\nname = \"itsdangerous\"\n\n[tool.flit.sdist]\ninclude = [\n \"docs/\",\n \"requirements/\",\n \"tests/\",\n \"CHANGES.rst\",\n \"tox.ini\",\n]\nexclude = [\n \"docs/_build/\",\n]\n\n[tool.pytest.ini_options]\ntestpaths = [\"tests\"]\nfilterwarnings = [\n \"error\",\n]\n\n[tool.coverage.run]\nbranch = true\nsource = [\"itsdangerous\", \"tests\"]\n\n[tool.coverage.paths]\nsource = [\"src\", \"*/site-packages\"]\n\n[tool.mypy]\npython_version = \"3.8\"\nfiles = [\"src/itsdangerous\"]\nshow_error_codes = true\npretty = true\nstrict = true\n\n[tool.pyright]\npythonVersion = \"3.8\"\ninclude = [\"src/itsdangerous\"]\ntypeCheckingMode = \"basic\"\n\n[tool.ruff]\nsrc = [\"src\"]\nfix = true\nshow-fixes = true\noutput-format = \"full\"\n\n[tool.ruff.lint]\nselect = [\n \"B\", # flake8-bugbear\n \"E\", # pycodestyle error\n \"F\", # pyflakes\n \"I\", # isort\n \"UP\", # pyupgrade\n \"W\", # pycodestyle warning\n]\n\n[tool.ruff.lint.isort]\nforce-single-line = true\norder-by-type = false\n\n[tool.gha-update]\ntag-only = [\n \"slsa-framework/slsa-github-generator\",\n]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"root = true\n\n[*]\nindent_style = space\nindent_size = 4\ninsert_final_newline = true\ntrim_trailing_whitespace = true\nend_of_line = lf\ncharset = utf-8\nmax_line_length = 88\n\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"3"},{"content":"# ItsDangerous\n\n... so better sign this\n\nVarious helpers to pass data to untrusted environments and to get it\nback safe and sound. Data is cryptographically signed to ensure that a\ntoken has not been tampered with.\n\nIt's possible to customize how data is serialized. Data is compressed as\nneeded. A timestamp can be added and verified automatically while\nloading a token.\n\n\n## A Simple Example\n\nHere's how you could generate a token for transmitting a user's id and\nname between web requests.\n\n```python\nfrom itsdangerous import URLSafeSerializer\nauth_s = URLSafeSerializer(\"secret key\", \"auth\")\ntoken = auth_s.dumps({\"id\": 5, \"name\": \"itsdangerous\"})\n\nprint(token)\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\n\ndata = auth_s.loads(token)\nprint(data[\"name\"])\n# itsdangerous\n```\n\n\n## Donate\n\nThe Pallets organization develops and supports ItsDangerous and other\npopular packages. In order to grow the community of contributors and\nusers, and allow the maintainers to devote more time to the projects,\n[please donate today][].\n\n[please donate today]: https://palletsprojects.com/donate\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"[tox]\nenvlist =\n py3{13,12,11,10,9,8}\n pypy310\n style\n typing\n docs\nskip_missing_interpreters = true\n\n[testenv]\npackage = wheel\nwheel_build_env = .pkg\nconstrain_package_deps = true\nuse_frozen_constraints = true\ndeps = -r requirements/tests.txt\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\n\n[testenv:style]\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit run --all-files\n\n[testenv:typing]\ndeps = -r requirements/typing.txt\ncommands =\n mypy\n pyright\n pyright --verifytypes itsdangerous --ignoreexternal\n\n[testenv:docs]\ndeps = -r requirements/docs.txt\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\n\n[testenv:update-actions]\nlabels = update\ndeps = gha-update\ncommands = gha-update\n\n[testenv:update-pre_commit]\nlabels = update\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit autoupdate -j4\n\n[testenv:update-requirements]\nlabels = update\ndeps = pip-tools\nskip_install = true\nchange_dir = requirements\ncommands =\n pip-compile build.in -q {posargs:-U}\n pip-compile docs.in -q {posargs:-U}\n pip-compile tests.in -q {posargs:-U}\n pip-compile typing.in -q {posargs:-U}\n pip-compile dev.in -q {posargs:-U}\n\n[end of tox.ini]","filename":"tox.ini","id":"5"},{"content":"Copyright 2011 Pallets\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n1. Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n2. 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\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE.txt]","filename":"LICENSE.txt","id":"6"},{"content":"Version 2.2.0\n-------------\n\nReleased 2024-04-16\n\n- Drop support for Python 3.7. :pr:`372`\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\n :pr:`326`\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\n- Deprecate the ``__version__`` attribute. Use feature detection, or\n ``importlib.metadata.version(\"itsdangerous\")``, instead. :issue:`371`\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\n different ``serializer`` argument is given, it will try to infer the return\n type of its ``dumps`` method. :issue:`347`\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\n access it at import time so the developer has time to change the default.\n :issue:`375`\n\n\nVersion 2.1.2\n-------------\n\nReleased 2022-03-24\n\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\n\n\nVersion 2.1.1\n-------------\n\nReleased 2022-03-09\n\n- Handle date overflow in timed unsign. :pr:`296`\n\n\nVersion 2.1.0\n-------------\n\nReleased 2022-02-17\n\n- Drop support for Python 3.6. :pr:`272`\n- Remove previously deprecated code. :pr:`273`\n\n - JWS functionality: Use a dedicated library such as Authlib\n instead.\n - ``import itsdangerous.json``: Import ``json`` from the standard\n library instead.\n\n\nVersion 2.0.1\n-------------\n\nReleased 2021-05-18\n\n- Mark top-level names as exported so type checking understands\n imports in user projects. :pr:`240`\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\n ``None`` again. :issue:`237`\n\n\nVersion 2.0.0\n-------------\n\nReleased 2021-05-11\n\n- Drop support for Python 2 and 3.5.\n- JWS support (``JSONWebSignatureSerializer``,\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\n JWS/JWT library such as authlib instead. :issue:`129`\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\n ``json`` module instead. :pr:`152`\n- Simplejson is no longer used if it is installed. To use a different\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\n- If a signature has an age less than 0, it will raise\n ``SignatureExpired`` rather than appearing valid. This can happen if\n the timestamp offset is changed. :issue:`126`\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\n rather than an ``int`` in some cases. :issue:`124`\n- Added support for key rotation. A list of keys can be passed as\n ``secret_key``, oldest to newest. The newest key is used for\n signing, all keys are tried for unsigning. :pr:`141`\n- Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``. :issue:`155`\n- Add type information for static typing tools. :pr:`186`\n\n\nVersion 1.1.0\n-------------\n\nReleased 2018-10-26\n\n- Change default signing algorithm back to SHA-1. :pr:`113`\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\n release which defaulted to SHA-512. :pr:`114`\n- Add support for fallback algorithms during deserialization to\n support changing the default in the future without breaking existing\n signatures. :pr:`113`\n- Changed capitalization of packages back to lowercase as the change\n in capitalization broke some tooling. :pr:`113`\n\n\nVersion 1.0.0\n-------------\n\nReleased 2018-10-18\n\nYANKED\n\n*Note*: This release was yanked from PyPI because it changed the default\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\nat SHA1.\n\n- Drop support for Python 2.6 and 3.3.\n- Refactor code from a single module to a package. Any object in the\n API docs is still importable from the top-level ``itsdangerous``\n name, but other imports will need to be changed. A future release\n will remove many of these compatibility imports. :pr:`107`\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\n :pr:`27`\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\n Python 3. :issue:`29`\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\n- More compact JSON dumps for unicode strings. :issue:`38`\n- Use the full timestamp rather than an offset, allowing dates before\n 2011. :issue:`46`\n\n To retain compatibility with signers from previous versions,\n consider using `this shim <https://github.com/pallets/itsdangerous\n /issues/120#issuecomment-456913331>`_ when unsigning.\n- Detect a ``sep`` character that may show up in the signature itself\n and raise a ``ValueError``. :issue:`62`\n- Use a consistent signature for keyword arguments for\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\n- Convert JWS exp header to an int when loading. :pr:`99`\n\n\nVersion 0.24\n------------\n\nReleased 2014-03-28\n\n- Added a ``BadHeader`` exception that is used for bad headers that\n replaces the old ``BadPayload`` exception that was reused in those\n cases.\n\n\nVersion 0.23\n------------\n\nReleased 2013-08-08\n\n- Fixed a packaging mistake that caused the tests and license files to\n not be included.\n\n\nVersion 0.22\n------------\n\nReleased 2013-07-03\n\n- Added support for ``TimedJSONWebSignatureSerializer``.\n- Made it possible to override the signature verification function to\n allow implementing asymmetrical algorithms.\n\n\nVersion 0.21\n------------\n\nReleased 2013-05-26\n\n- Fixed an issue on Python 3 which caused invalid errors to be\n generated.\n\n\nVersion 0.20\n------------\n\nReleased 2013-05-23\n\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\n ItsDangerous on Python 2.6.\n\n\nVersion 0.19\n------------\n\nReleased 2013-05-21\n\n- Dropped support for 2.5 and added support for 3.3.\n\n\nVersion 0.18\n------------\n\nReleased 2013-05-03\n\n- Added support for JSON Web Signatures (JWS).\n\n\nVersion 0.17\n------------\n\nReleased 2012-08-10\n\n- Fixed a name error when overriding the digest method.\n\n\nVersion 0.16\n------------\n\nReleased 2012-07-11\n\n- Made it possible to pass unicode values to ``load_payload`` to make\n it easier to debug certain things.\n\n\nVersion 0.15\n------------\n\nReleased 2012-07-11\n\n- Made standalone ``load_payload`` more robust by raising one specific\n error if something goes wrong.\n- Refactored exceptions to catch more cases individually, added more\n attributes.\n- Fixed an issue that caused ``load_payload`` not work in some\n situations with timestamp based serializers\n- Added an ``loads_unsafe`` method.\n\n\nVersion 0.14\n------------\n\nReleased 2012-06-29\n\n- API refactoring to support different key derivations.\n- Added attributes to exceptions so that you can inspect the data even\n if the signature check failed.\n\n\nVersion 0.13\n------------\n\nReleased 2012-06-10\n\n- Small API change that enables customization of the digest module.\n\n\nVersion 0.12\n------------\n\nReleased 2012-02-22\n\n- Fixed a problem with the local timezone being used for the epoch\n calculation. This might invalidate some of your signatures if you\n were not running in UTC timezone. You can revert to the old behavior\n by monkey patching ``itsdangerous.EPOCH``.\n\n\nVersion 0.11\n------------\n\nReleased 2011-07-07\n\n- Fixed an uncaught value error.\n\n\nVersion 0.10\n------------\n\nReleased 2011-06-25\n\n- Refactored interface that the underlying serializers can be swapped\n by passing in a module instead of having to override the payload\n loaders and dumpers. This makes the interface more compatible with\n Django's recent changes.\n\n[end of CHANGES.rst]","filename":"CHANGES.rst","id":"7"},{"content":"version: 2\nbuild:\n os: ubuntu-22.04\n tools:\n python: '3.12'\npython:\n install:\n - requirements: requirements/docs.txt\n - method: pip\n path: .\nsphinx:\n builder: dirhtml\n fail_on_warning: true\n\n[end of .readthedocs.yaml]","filename":".readthedocs.yaml","id":"8"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile dev.in\n#\nalabaster==1.0.0\n # via\n # -r docs.txt\n # sphinx\nbabel==2.16.0\n # via\n # -r docs.txt\n # sphinx\ncachetools==5.5.0\n # via tox\ncertifi==2024.8.30\n # via\n # -r docs.txt\n # requests\ncfgv==3.4.0\n # via pre-commit\nchardet==5.2.0\n # via tox\ncharset-normalizer==3.4.0\n # via\n # -r docs.txt\n # requests\ncolorama==0.4.6\n # via tox\ndistlib==0.3.9\n # via virtualenv\ndocutils==0.21.2\n # via\n # -r docs.txt\n # sphinx\nfilelock==3.16.1\n # via\n # tox\n # virtualenv\nfreezegun==1.5.1\n # via -r tests.txt\nidentify==2.6.1\n # via pre-commit\nidna==3.10\n # via\n # -r docs.txt\n # requests\nimagesize==1.4.1\n # via\n # -r docs.txt\n # sphinx\niniconfig==2.0.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\njinja2==3.1.4\n # via\n # -r docs.txt\n # sphinx\nmarkupsafe==3.0.2\n # via\n # -r docs.txt\n # jinja2\nmypy==1.13.0\n # via -r typing.txt\nmypy-extensions==1.0.0\n # via\n # -r typing.txt\n # mypy\nnodeenv==1.9.1\n # via\n # -r typing.txt\n # pre-commit\n # pyright\npackaging==24.1\n # via\n # -r docs.txt\n # -r tests.txt\n # -r typing.txt\n # pallets-sphinx-themes\n # pyproject-api\n # pytest\n # sphinx\n # tox\npallets-sphinx-themes==2.3.0\n # via -r docs.txt\nplatformdirs==4.3.6\n # via\n # tox\n # virtualenv\npluggy==1.5.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\n # tox\npre-commit==4.0.1\n # via -r dev.in\npygments==2.18.0\n # via\n # -r docs.txt\n # sphinx\npyproject-api==1.8.0\n # via tox\npyright==1.1.386\n # via -r typing.txt\npytest==8.3.3\n # via\n # -r tests.txt\n # -r typing.txt\npython-dateutil==2.9.0.post0\n # via\n # -r tests.txt\n # freezegun\npyyaml==6.0.2\n # via pre-commit\nrequests==2.32.3\n # via\n # -r docs.txt\n # sphinx\nsix==1.16.0\n # via\n # -r tests.txt\n # python-dateutil\nsnowballstemmer==2.2.0\n # via\n # -r docs.txt\n # sphinx\nsphinx==8.1.3\n # via\n # -r docs.txt\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via\n # -r docs.txt\n # pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-devhelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-jsmath==1.0.1\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.txt\nsphinxcontrib-qthelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via\n # -r docs.txt\n # sphinx\ntox==4.23.2\n # via -r dev.in\ntyping-extensions==4.12.2\n # via\n # -r typing.txt\n # mypy\n # pyright\nurllib3==2.2.3\n # via\n # -r docs.txt\n # requests\nvirtualenv==20.27.0\n # via\n # pre-commit\n # tox\n\n[end of requirements/dev.txt]","filename":"requirements/dev.txt","id":"9"},{"content":"pallets-sphinx-themes\nsphinx\nsphinxcontrib-log-cabinet\n\n[end of requirements/docs.in]","filename":"requirements/docs.in","id":"10"},{"content":"build\n\n[end of requirements/build.in]","filename":"requirements/build.in","id":"11"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile typing.in\n#\niniconfig==2.0.0\n # via pytest\nmypy==1.13.0\n # via -r typing.in\nmypy-extensions==1.0.0\n # via mypy\nnodeenv==1.9.1\n # via pyright\npackaging==24.1\n # via pytest\npluggy==1.5.0\n # via pytest\npyright==1.1.386\n # via -r typing.in\npytest==8.3.3\n # via -r typing.in\ntyping-extensions==4.12.2\n # via\n # mypy\n # pyright\n\n[end of requirements/typing.txt]","filename":"requirements/typing.txt","id":"12"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile build.in\n#\nbuild==1.2.2.post1\n # via -r build.in\npackaging==24.1\n # via build\npyproject-hooks==1.2.0\n # via build\n\n[end of requirements/build.txt]","filename":"requirements/build.txt","id":"13"},{"content":"mypy\npyright\npytest\n\n[end of requirements/typing.in]","filename":"requirements/typing.in","id":"14"},{"content":"-r docs.txt\n-r tests.txt\n-r typing.txt\npre-commit\ntox\n\n[end of requirements/dev.in]","filename":"requirements/dev.in","id":"15"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile docs.in\n#\nalabaster==1.0.0\n # via sphinx\nbabel==2.16.0\n # via sphinx\ncertifi==2024.8.30\n # via requests\ncharset-normalizer==3.4.0\n # via requests\ndocutils==0.21.2\n # via sphinx\nidna==3.10\n # via requests\nimagesize==1.4.1\n # via sphinx\njinja2==3.1.4\n # via sphinx\nmarkupsafe==3.0.2\n # via jinja2\npackaging==24.1\n # via\n # pallets-sphinx-themes\n # sphinx\npallets-sphinx-themes==2.3.0\n # via -r docs.in\npygments==2.18.0\n # via sphinx\nrequests==2.32.3\n # via sphinx\nsnowballstemmer==2.2.0\n # via sphinx\nsphinx==8.1.3\n # via\n # -r docs.in\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via sphinx\nsphinxcontrib-devhelp==2.0.0\n # via sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via sphinx\nsphinxcontrib-jsmath==1.0.1\n # via sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.in\nsphinxcontrib-qthelp==2.0.0\n # via sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via sphinx\nurllib3==2.2.3\n # via requests\n\n[end of requirements/docs.txt]","filename":"requirements/docs.txt","id":"16"},{"content":".. rst-class:: hide-header\n\nItsDangerous\n============\n\n.. image:: _static/itsdangerous-logo.png\n :align: center\n :target: https://palletsprojects.com/p/itsdangerous/\n\nSometimes you want to send some data to untrusted environments, then get\nit back later. To do this safely, the data must be signed to detect\nchanges.\n\nGiven a key only you know, you can cryptographically sign your data and\nhand it over to someone else. When you get the data back you can ensure\nthat nobody tampered with it.\n\nThe receiver can see the data, but they can not modify it unless they\nalso have your key. So if you keep the key secret and complex, you will\nbe fine.\n\n\nInstalling\n----------\n\nInstall and update using `pip`_:\n\n.. code-block:: text\n\n pip install -U itsdangerous\n\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\n\n\nExample Use Cases\n-----------------\n\n- Sign a user ID in a URL and email it to them to unsubscribe from a\n newsletter. This way you don't need to generate one-time tokens and\n store them in the database. Same thing with any kind of activation\n link for accounts and similar things.\n- Signed objects can be stored in cookies or other untrusted sources\n which means you don't need to have sessions stored on the server,\n which reduces the number of necessary database queries.\n- Signed information can safely do a round trip between server and\n client in general which makes them useful for passing server-side\n state to a client and then back.\n\n\nTable of Contents\n-----------------\n\n.. toctree::\n\n concepts\n serializer\n signer\n exceptions\n timed\n url_safe\n encoding\n license\n changes\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"17"},{"content":".. module:: itsdangerous.serializer\n\nSerialization Interface\n=======================\n\nThe :doc:`/signer` only signs bytes. To sign other types, the\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\nsimilar to Python's :mod:`json` module, which serializes the object to a\nstring then signs that.\n\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n s = Serializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\n\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\nthe data.\n\n.. code-block:: python\n\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\n [1, 2, 3, 4]\n\nBy default, data is serialized to JSON with the built-in :mod:`json`\nmodule. This internal serializer can be changed by subclassing.\n\nTo record and validate the age of the signature, see :doc:`/timed`.\nTo serialize to a format that is safe to use in URLs, see\n:doc:`/url_safe`.\n\n\nResponding to Failure\n---------------------\n\nExceptions have helpful attributes which allow you to inspect the\npayload if the signature check failed. This has to be done with extra\ncare because at that point you know that someone tampered with your data\nbut it might be useful for debugging purposes.\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n from itsdangerous.exc import BadSignature, BadData\n\n s = URLSafeSerializer(\"secret-key\")\n decoded_payload = None\n\n try:\n decoded_payload = s.loads(data)\n # This payload is decoded and safe\n except BadSignature as e:\n if e.payload is not None:\n try:\n decoded_payload = s.load_payload(e.payload)\n except BadData:\n pass\n # This payload is decoded but unsafe because someone\n # tampered with the signature. The decode (load_payload)\n # step is explicit because it might be unsafe to unserialize\n # the payload (think pickle instead of json!)\n\nIf you don't want to inspect attributes to figure out what exactly went\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\n\n.. code-block:: python\n\n sig_okay, payload = s.loads_unsafe(data)\n\nThe first item in the returned tuple is a boolean that indicates if the\nsignature was correct.\n\n\nFallback Signers\n----------------\n\nYou may want to upgrade the signing parameters without invalidating\nexisting signatures immediately. For example, you may decide that you\nwant to use a different digest method. New signatures should use the new\nmethod, but old signatures should still validate.\n\nA list of ``fallback_signers`` can be given that will be tried if\nunsigning with the current signer fails. Each item in the list can be:\n\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\n passed to the serializer.\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\n serializer.\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\n given class with the given args.\n\nFor example, this is a serializer that signs using SHA-512, but will\nunsign using either SHA-512 or SHA-1:\n\n.. code-block:: python\n\n s = Serializer(\n signer_kwargs={\"digest_method\": hashlib.sha512},\n fallback_signers=[{\"digest_method\": hashlib.sha1}]\n )\n\n\n\nAPI\n---\n\n.. autoclass:: Serializer\n :members:\n\n[end of docs/serializer.rst]","filename":"docs/serializer.rst","id":"18"},{"content":".. module:: itsdangerous.signer\n\nSigning Interface\n=================\n\nThe most basic interface is the signing interface. The :class:`Signer`\nclass can be used to attach a signature to a specific string:\n\n.. code-block:: python\n\n from itsdangerous import Signer\n s = Signer(\"secret-key\")\n s.sign(\"my string\")\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\n\nThe signature is appended to the string, separated by a dot. To validate\nthe string, use the :meth:`~Signer.unsign` method:\n\n.. code-block:: python\n\n s.unsign(b\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n b'my string'\n\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\nHowever after unsigning you won't be able to tell if it was unicode or\na bytestring.\n\nIf the value is changed, the signature will no longer match, and\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\n\n.. code-block:: python\n\n s.unsign(b\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nTo record and validate the age of a signature, see :doc:`/timed`.\n\n.. autoclass:: Signer\n :members:\n\n\nSigning Algorithms\n------------------\n\n.. autoclass:: NoneAlgorithm\n\n.. autoclass:: HMACAlgorithm\n\n[end of docs/signer.rst]","filename":"docs/signer.rst","id":"19"},{"content":"General Concepts\n================\n\n\nSerializer vs Signer\n--------------------\n\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\nthe basic system that signs a given ``bytes`` value based on the given\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\nserializing and signing other data besides ``bytes``.\n\nTypically, you'll want to use a serializer, not a signer. You can\nconfigure the signing parameters through the serializer, and even\nprovide fallback signers to upgrade old tokens to new parameters.\n\n\nThe Secret Key\n--------------\n\nSignatures are secured by the ``secret_key``. Typically one secret key\nis used with all signers, and the salt is used to distinguish different\ncontexts. Changing the secret key will invalidate existing tokens.\n\nIt should be a long random string of bytes. This value must be kept\nsecret and should not be saved in source code or committed to version\ncontrol. If an attacker learns the secret key, they can change and\nresign data to look valid. If you suspect this happened, change the\nsecret key to invalidate existing tokens.\n\nOne way to keep the secret key separate is to read it from an\nenvironment variable. When deploying for the first time, generate a key\nand set the environment variable when running the application. All\nprocess managers (like systemd) and hosting services have a way to\nspecify environment variables.\n\n.. code-block:: python\n\n import os\n from itsdangerous.serializer import Serializer\n SECRET_KEY = os.environ.get(\"SECRET_KEY\")\n s = Serializer(SECRET_KEY)\n\n.. code-block:: text\n\n $ export SECRET_KEY=\"base64 encoded random bytes\"\n $ python application.py\n\nOne way to generate a key is to use :func:`os.urandom`.\n\n.. code-block:: text\n\n $ python3 -c 'import os; print(os.urandom(16).hex())'\n\n\nThe Salt\n--------\n\nThe salt is combined with the secret key to derive a unique key for\ndistinguishing different contexts. Unlike the secret key, the salt\ndoesn't have to be random, and can be saved in code. It only has to be\nunique between contexts, not private.\n\nFor example, you want to email activation links to activate user\naccounts, and upgrade links to upgrade users to a paid accounts. If all\nyou sign is the user id, and you don't use different salts, a user could\nreuse the token from the activation link to upgrade the account. If you\nuse different salts, the signatures will be different and will not be\nvalid in the other context.\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n\n s1 = URLSafeSerializer(\"secret-key\", salt=\"activate\")\n s1.dumps(42)\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\n\n s2 = URLSafeSerializer(\"secret-key\", salt=\"upgrade\")\n s2.dumps(42)\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\n\nThe second serializer can't load data dumped with the first because the\nsalts differ.\n\n.. code-block:: python\n\n s2.loads(s1.dumps(42))\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nOnly the serializer with the same salt can load the data.\n\n.. code-block:: python\n\n s2.loads(s2.dumps(42))\n 42\n\n\nKey Rotation\n------------\n\nKey rotation can provide an extra layer of mitigation against an\nattacker discovering a secret key. A rotation system will keep a list of\nvalid keys, generating a new key and removing the oldest key\nperiodically. If it takes four weeks for an attacker to crack a key, but\nthe key is rotated out after three weeks, they will not be able to use\nany keys they crack. However, if a user doesn't refresh their token\nwithin three weeks it will be invalid too.\n\nThe system that generates and maintains this list is outside the scope\nof ItsDangerous, but ItsDangerous does support validating against a list\nof keys.\n\nInstead of passing a single key, you can pass a list of keys, oldest to\nnewest. When signing the last (newest) key will be used, and when\nvalidating each key will be tried from newest to oldest before raising\na validation error.\n\n.. code-block:: python\n\n SECRET_KEYS = [\"2b9cd98e\", \"169d7886\", \"b6af09f5\"]\n\n # sign some data with the latest key\n s = Serializer(SECRET_KEYS)\n t = s.dumps({\"id\": 42})\n\n # rotate a new key in and the oldest key out\n SECRET_KEYS.append(\"cf9b3588\")\n del SECRET_KEYS[0]\n\n s = Serializer(SECRET_KEYS)\n s.loads(t) # valid even though it was signed with a previous key\n\n\nDigest Method Security\n----------------------\n\nA signer is configured with a ``digest_method``, a hash function that\nis used as an intermediate step when generating the HMAC signature. The\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\nconcerned about this default because they have heard about hash\ncollisions with SHA-1.\n\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\nhash alone doesn't apply when used in HMAC.\n\nIf a project considers SHA-1 a risk anyway, they can configure the\nsigner with a different digest method such as :func:`hashlib.sha512`.\nA fallback signer for SHA-1 can be configured so that old tokens will be\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\nspace, which is relevant in cookies and URLs.\n\n[end of docs/concepts.rst]","filename":"docs/concepts.rst","id":"20"},{"content":".. module:: itsdangerous.url_safe\n\nURL Safe Serialization\n======================\n\nOften it is helpful if you can pass these trusted strings in places\nwhere you only have a limited set of characters available. Because of\nthis, ItsDangerous also provides URL safe serializers:\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n s = URLSafeSerializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\n s.loads(\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\")\n [1, 2, 3, 4]\n\n.. autoclass:: URLSafeSerializer\n\n.. autoclass:: URLSafeTimedSerializer\n\n[end of docs/url_safe.rst]","filename":"docs/url_safe.rst","id":"21"},{"content":".. module:: itsdangerous.encoding\n\nEncoding Utilities\n==================\n\n.. autofunction:: base64_encode\n\n.. autofunction:: base64_decode\n\n[end of docs/encoding.rst]","filename":"docs/encoding.rst","id":"22"},{"content":"# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSOURCEDIR = .\nBUILDDIR = _build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"23"},{"content":"from pallets_sphinx_themes import get_version\nfrom pallets_sphinx_themes import ProjectLink\n\n# Project --------------------------------------------------------------\n\nproject = \"ItsDangerous\"\ncopyright = \"2011 Pallets\"\nauthor = \"Pallets\"\nrelease, version = get_version(\"itsdangerous\")\n\n# General --------------------------------------------------------------\n\ndefault_role = \"code\"\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.extlinks\",\n \"sphinx.ext.intersphinx\",\n \"sphinxcontrib.log_cabinet\",\n \"pallets_sphinx_themes\",\n]\nautoclass_content = \"both\"\nautodoc_member_order = \"bysource\"\nautodoc_typehints = \"description\"\nautodoc_preserve_defaults = True\nextlinks = {\n \"issue\": (\"https://github.com/pallets/itsdangerous/issues/%s\", \"#%s\"),\n \"pr\": (\"https://github.com/pallets/itsdangerous/pull/%s\", \"#%s\"),\n}\nintersphinx_mapping = {\n \"python\": (\"https://docs.python.org/3/\", None),\n}\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = \"flask\"\nhtml_theme_options = {\"index_sidebar_logo\": False}\nhtml_context = {\n \"project_links\": [\n ProjectLink(\"Donate\", \"https://palletsprojects.com/donate\"),\n ProjectLink(\"PyPI Releases\", \"https://pypi.org/project/itsdangerous/\"),\n ProjectLink(\"Source Code\", \"https://github.com/pallets/itsdangerous/\"),\n ProjectLink(\"Issue Tracker\", \"https://github.com/pallets/itsdangerous/issues/\"),\n ProjectLink(\"Chat\", \"https://discord.gg/pallets\"),\n ]\n}\nhtml_sidebars = {\n \"index\": [\"project.html\", \"localtoc.html\", \"searchbox.html\", \"ethicalads.html\"],\n \"**\": [\"localtoc.html\", \"relations.html\", \"searchbox.html\", \"ethicalads.html\"],\n}\nsinglehtml_sidebars = {\"index\": [\"project.html\", \"localtoc.html\", \"ethicalads.html\"]}\nhtml_static_path = [\"_static\"]\nhtml_favicon = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_logo = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_title = f\"{project} Documentation ({version})\"\nhtml_show_sourcelink = False\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"24"},{"content":"@ECHO OFF\n\npushd %~dp0\n\nREM Command file for Sphinx documentation\n\nif \"%SPHINXBUILD%\" == \"\" (\n\tset SPHINXBUILD=sphinx-build\n)\nset SOURCEDIR=.\nset BUILDDIR=_build\n\nif \"%1\" == \"\" goto help\n\n%SPHINXBUILD% >NUL 2>NUL\nif errorlevel 9009 (\n\techo.\n\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\n\techo.installed, then set the SPHINXBUILD environment variable to point\n\techo.to the full path of the 'sphinx-build' executable. Alternatively you\n\techo.may add the Sphinx directory to PATH.\n\techo.\n\techo.If you don't have Sphinx installed, grab it from\n\techo.http://sphinx-doc.org/\n\texit /b 1\n)\n\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\ngoto end\n\n:help\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\n\n:end\npopd\n\n[end of docs/make.bat]","filename":"docs/make.bat","id":"25"},{"content":".. module:: itsdangerous.timed\n\nSigning With Timestamps\n=======================\n\nIf you want to expire signatures you can use the\n:class:`TimestampSigner` class which adds timestamp information and\nsigns it. On unsigning you can validate that the timestamp is not older\nthan a given age.\n\n.. code-block:: python\n\n from itsdangerous import TimestampSigner\n s = TimestampSigner('secret-key')\n string = s.sign('foo')\n\n.. code-block:: python\n\n s.unsign(string, max_age=5)\n Traceback (most recent call last):\n ...\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\n\n.. autoclass:: TimestampSigner\n :members:\n\n.. autoclass:: TimedSerializer\n :members:\n\n[end of docs/timed.rst]","filename":"docs/timed.rst","id":"26"},{"content":"BSD-3-Clause License\n====================\n\n.. literalinclude:: ../LICENSE.txt\n :language: text\n\n[end of docs/license.rst]","filename":"docs/license.rst","id":"27"},{"content":"Changes\n=======\n\n.. include:: ../CHANGES.rst\n\n[end of docs/changes.rst]","filename":"docs/changes.rst","id":"28"},{"content":".. module:: itsdangerous.exc\n\nExceptions\n==========\n\n.. autoexception:: BadData\n :members:\n\n.. autoexception:: BadSignature\n :members:\n\n.. autoexception:: BadTimeSignature\n :members:\n\n.. autoexception:: SignatureExpired\n :members:\n\n.. autoexception:: BadHeader\n :members:\n\n.. autoexception:: BadPayload\n :members:\n\n[end of docs/exceptions.rst]","filename":"docs/exceptions.rst","id":"29"},{"content":"#!/bin/bash\nset -e\npython3 -m venv --upgrade-deps .venv\n. .venv/bin/activate\npip install -r requirements/dev.txt\npip install -e .\npre-commit install --install-hooks\n\n[end of .devcontainer/on-create-command.sh]","filename":".devcontainer/on-create-command.sh","id":"30"},{"content":"{\n \"name\": \"pallets/itsdangerous\",\n \"image\": \"mcr.microsoft.com/devcontainers/python:3\",\n \"customizations\": {\n \"vscode\": {\n \"settings\": {\n \"python.defaultInterpreterPath\": \"${workspaceFolder}/.venv\",\n \"python.terminal.activateEnvInCurrentTerminal\": true,\n \"python.terminal.launchArgs\": [\n \"-X\",\n \"dev\"\n ]\n }\n }\n },\n \"onCreateCommand\": \".devcontainer/on-create-command.sh\"\n}\n\n[end of .devcontainer/devcontainer.json]","filename":".devcontainer/devcontainer.json","id":"31"},{"content":"None\n[end of docs/_static/itsdangerous-logo-sidebar.png]","filename":"docs/_static/itsdangerous-logo-sidebar.png","id":"32"},{"content":"None\n[end of docs/_static/itsdangerous-logo.png]","filename":"docs/_static/itsdangerous-logo.png","id":"33"},{"content":"from __future__ import annotations\n\nimport json as _json\nimport typing as t\n\n\nclass _CompactJSON:\n \"\"\"Wrapper around json module that strips whitespace.\"\"\"\n\n @staticmethod\n def loads(payload: str | bytes) -> t.Any:\n return _json.loads(payload)\n\n @staticmethod\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\n kwargs.setdefault(\"ensure_ascii\", False)\n kwargs.setdefault(\"separators\", (\",\", \":\"))\n return _json.dumps(obj, **kwargs)\n\n[end of src/itsdangerous/_json.py]","filename":"src/itsdangerous/_json.py","id":"34"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport time\nimport typing as t\nfrom datetime import datetime\nfrom datetime import timezone\n\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import bytes_to_int\nfrom .encoding import int_to_bytes\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\nfrom .exc import BadTimeSignature\nfrom .exc import SignatureExpired\nfrom .serializer import _TSerialized\nfrom .serializer import Serializer\nfrom .signer import Signer\n\n\nclass TimestampSigner(Signer):\n \"\"\"Works like the regular :class:`.Signer` but also records the time\n of the signing and can be used to expire signatures. The\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\n unsigning failed because the signature is expired.\n \"\"\"\n\n def get_timestamp(self) -> int:\n \"\"\"Returns the current timestamp. The function must return an\n integer.\n \"\"\"\n return int(time.time())\n\n def timestamp_to_datetime(self, ts: int) -> datetime:\n \"\"\"Convert the timestamp from :meth:`get_timestamp` into an\n aware :class`datetime.datetime` in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n return datetime.fromtimestamp(ts, tz=timezone.utc)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string and also attaches time information.\"\"\"\n value = want_bytes(value)\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\n sep = want_bytes(self.sep)\n value = value + sep + timestamp\n return value + sep + self.get_signature(value)\n\n # Ignore overlapping signatures check, return_timestamp is the only\n # parameter that affects the return type.\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[False] = False,\n ) -> bytes: ...\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[True] = True,\n ) -> tuple[bytes, datetime]: ...\n\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n ) -> tuple[bytes, datetime] | bytes:\n \"\"\"Works like the regular :meth:`.Signer.unsign` but can also\n validate the time. See the base docstring of the class for\n the general behavior. If ``return_timestamp`` is ``True`` the\n timestamp of the signature will be returned as an aware\n :class:`datetime.datetime` object in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n try:\n result = super().unsign(signed_value)\n sig_error = None\n except BadSignature as e:\n sig_error = e\n result = e.payload or b\"\"\n\n sep = want_bytes(self.sep)\n\n # If there is no timestamp in the result there is something\n # seriously wrong. In case there was a signature error, we raise\n # that one directly, otherwise we have a weird situation in\n # which we shouldn't have come except someone uses a time-based\n # serializer on non-timestamp data, so catch that.\n if sep not in result:\n if sig_error:\n raise sig_error\n\n raise BadTimeSignature(\"timestamp missing\", payload=result)\n\n value, ts_bytes = result.rsplit(sep, 1)\n ts_int: int | None = None\n ts_dt: datetime | None = None\n\n try:\n ts_int = bytes_to_int(base64_decode(ts_bytes))\n except Exception:\n pass\n\n # Signature is *not* okay. Raise a proper error now that we have\n # split the value and the timestamp.\n if sig_error is not None:\n if ts_int is not None:\n try:\n ts_dt = self.timestamp_to_datetime(ts_int)\n except (ValueError, OSError, OverflowError) as exc:\n # Windows raises OSError\n # 32-bit raises OverflowError\n raise BadTimeSignature(\n \"Malformed timestamp\", payload=value\n ) from exc\n\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\n\n # Signature was okay but the timestamp is actually not there or\n # malformed. Should not happen, but we handle it anyway.\n if ts_int is None:\n raise BadTimeSignature(\"Malformed timestamp\", payload=value)\n\n # Check timestamp is not older than max_age\n if max_age is not None:\n age = self.get_timestamp() - ts_int\n\n if age > max_age:\n raise SignatureExpired(\n f\"Signature age {age} > {max_age} seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if age < 0:\n raise SignatureExpired(\n f\"Signature age {age} < 0 seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if return_timestamp:\n return value, self.timestamp_to_datetime(ts_int)\n\n return value\n\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\"\"\"\n try:\n self.unsign(signed_value, max_age=max_age)\n return True\n except BadSignature:\n return False\n\n\nclass TimedSerializer(Serializer[_TSerialized]):\n \"\"\"Uses :class:`TimestampSigner` instead of the default\n :class:`.Signer`.\n \"\"\"\n\n default_signer: type[TimestampSigner] = TimestampSigner\n\n def iter_unsigners(\n self, salt: str | bytes | None = None\n ) -> cabc.Iterator[TimestampSigner]:\n return t.cast(\"cabc.Iterator[TimestampSigner]\", super().iter_unsigners(salt))\n\n # TODO: Signature is incompatible because parameters were added\n # before salt.\n\n def loads( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n salt: str | bytes | None = None,\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\n signature validation fails. If a ``max_age`` is provided it will\n ensure the signature is not older than that time in seconds. In\n case the signature is outdated, :exc:`.SignatureExpired` is\n raised. All arguments are forwarded to the signer's\n :meth:`~TimestampSigner.unsign` method.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n base64d, timestamp = signer.unsign(\n s, max_age=max_age, return_timestamp=True\n )\n payload = self.load_payload(base64d)\n\n if return_timestamp:\n return payload, timestamp\n\n return payload\n except SignatureExpired:\n # The signature was unsigned successfully but was\n # expired. Do not try the next signer.\n raise\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def loads_unsafe( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n salt: str | bytes | None = None,\n ) -> tuple[bool, t.Any]:\n return self._loads_unsafe_impl(s, salt, load_kwargs={\"max_age\": max_age})\n\n[end of src/itsdangerous/timed.py]","filename":"src/itsdangerous/timed.py","id":"35"},{"content":"from __future__ import annotations\n\nimport base64\nimport string\nimport struct\nimport typing as t\n\nfrom .exc import BadData\n\n\ndef want_bytes(\n s: str | bytes, encoding: str = \"utf-8\", errors: str = \"strict\"\n) -> bytes:\n if isinstance(s, str):\n s = s.encode(encoding, errors)\n\n return s\n\n\ndef base64_encode(string: str | bytes) -> bytes:\n \"\"\"Base64 encode a string of bytes or text. The resulting bytes are\n safe to use in URLs.\n \"\"\"\n string = want_bytes(string)\n return base64.urlsafe_b64encode(string).rstrip(b\"=\")\n\n\ndef base64_decode(string: str | bytes) -> bytes:\n \"\"\"Base64 decode a URL-safe string of bytes or text. The result is\n bytes.\n \"\"\"\n string = want_bytes(string, encoding=\"ascii\", errors=\"ignore\")\n string += b\"=\" * (-len(string) % 4)\n\n try:\n return base64.urlsafe_b64decode(string)\n except (TypeError, ValueError) as e:\n raise BadData(\"Invalid base64-encoded data\") from e\n\n\n# The alphabet used by base64.urlsafe_*\n_base64_alphabet = f\"{string.ascii_letters}{string.digits}-_=\".encode(\"ascii\")\n\n_int64_struct = struct.Struct(\">Q\")\n_int_to_bytes = _int64_struct.pack\n_bytes_to_int = t.cast(\"t.Callable[[bytes], tuple[int]]\", _int64_struct.unpack)\n\n\ndef int_to_bytes(num: int) -> bytes:\n return _int_to_bytes(num).lstrip(b\"\\x00\")\n\n\ndef bytes_to_int(bytestr: bytes) -> int:\n return _bytes_to_int(bytestr.rjust(8, b\"\\x00\"))[0]\n\n[end of src/itsdangerous/encoding.py]","filename":"src/itsdangerous/encoding.py","id":"36"},{"content":"from __future__ import annotations\n\nimport typing as t\n\nfrom .encoding import base64_decode as base64_decode\nfrom .encoding import base64_encode as base64_encode\nfrom .encoding import want_bytes as want_bytes\nfrom .exc import BadData as BadData\nfrom .exc import BadHeader as BadHeader\nfrom .exc import BadPayload as BadPayload\nfrom .exc import BadSignature as BadSignature\nfrom .exc import BadTimeSignature as BadTimeSignature\nfrom .exc import SignatureExpired as SignatureExpired\nfrom .serializer import Serializer as Serializer\nfrom .signer import HMACAlgorithm as HMACAlgorithm\nfrom .signer import NoneAlgorithm as NoneAlgorithm\nfrom .signer import Signer as Signer\nfrom .timed import TimedSerializer as TimedSerializer\nfrom .timed import TimestampSigner as TimestampSigner\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\n\n\ndef __getattr__(name: str) -> t.Any:\n if name == \"__version__\":\n import importlib.metadata\n import warnings\n\n warnings.warn(\n \"The '__version__' attribute is deprecated and will be removed in\"\n \" ItsDangerous 2.3. Use feature detection or\"\n \" 'importlib.metadata.version(\\\"itsdangerous\\\")' instead.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return importlib.metadata.version(\"itsdangerous\")\n\n raise AttributeError(name)\n\n[end of src/itsdangerous/__init__.py]","filename":"src/itsdangerous/__init__.py","id":"37"},{"content":"from __future__ import annotations\n\nimport typing as t\nimport zlib\n\nfrom ._json import _CompactJSON\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .exc import BadPayload\nfrom .serializer import _PDataSerializer\nfrom .serializer import Serializer\nfrom .timed import TimedSerializer\n\n\nclass URLSafeSerializerMixin(Serializer[str]):\n \"\"\"Mixed in with a regular serializer it will attempt to zlib\n compress the string to make it shorter if necessary. It will also\n base64 encode the string so that it can safely be placed in a URL.\n \"\"\"\n\n default_serializer: _PDataSerializer[str] = _CompactJSON\n\n def load_payload(\n self,\n payload: bytes,\n *args: t.Any,\n serializer: t.Any | None = None,\n **kwargs: t.Any,\n ) -> t.Any:\n decompress = False\n\n if payload.startswith(b\".\"):\n payload = payload[1:]\n decompress = True\n\n try:\n json = base64_decode(payload)\n except Exception as e:\n raise BadPayload(\n \"Could not base64 decode the payload because of an exception\",\n original_error=e,\n ) from e\n\n if decompress:\n try:\n json = zlib.decompress(json)\n except Exception as e:\n raise BadPayload(\n \"Could not zlib decompress the payload before decoding the payload\",\n original_error=e,\n ) from e\n\n return super().load_payload(json, *args, **kwargs)\n\n def dump_payload(self, obj: t.Any) -> bytes:\n json = super().dump_payload(obj)\n is_compressed = False\n compressed = zlib.compress(json)\n\n if len(compressed) < (len(json) - 1):\n json = compressed\n is_compressed = True\n\n base64d = base64_encode(json)\n\n if is_compressed:\n base64d = b\".\" + base64d\n\n return base64d\n\n\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\n \"\"\"Works like :class:`.Serializer` but dumps and loads into a URL\n safe string consisting of the upper and lowercase character of the\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\n \"\"\"Works like :class:`.TimedSerializer` but dumps and loads into a\n URL safe string consisting of the upper and lowercase character of\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n[end of src/itsdangerous/url_safe.py]","filename":"src/itsdangerous/url_safe.py","id":"38"},{"content":"from __future__ import annotations\n\nimport typing as t\nfrom datetime import datetime\n\n\nclass BadData(Exception):\n \"\"\"Raised if bad data of any sort was encountered. This is the base\n for all exceptions that ItsDangerous defines.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str):\n super().__init__(message)\n self.message = message\n\n def __str__(self) -> str:\n return self.message\n\n\nclass BadSignature(BadData):\n \"\"\"Raised if a signature does not match.\"\"\"\n\n def __init__(self, message: str, payload: t.Any | None = None):\n super().__init__(message)\n\n #: The payload that failed the signature test. In some\n #: situations you might still want to inspect this, even if\n #: you know it was tampered with.\n #:\n #: .. versionadded:: 0.14\n self.payload: t.Any | None = payload\n\n\nclass BadTimeSignature(BadSignature):\n \"\"\"Raised if a time-based signature is invalid. This is a subclass\n of :class:`BadSignature`.\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n date_signed: datetime | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the signature expired this exposes the date of when the\n #: signature was created. This can be helpful in order to\n #: tell the user how long a link has been gone stale.\n #:\n #: .. versionchanged:: 2.0\n #: The datetime value is timezone-aware rather than naive.\n #:\n #: .. versionadded:: 0.14\n self.date_signed = date_signed\n\n\nclass SignatureExpired(BadTimeSignature):\n \"\"\"Raised if a signature timestamp is older than ``max_age``. This\n is a subclass of :exc:`BadTimeSignature`.\n \"\"\"\n\n\nclass BadHeader(BadSignature):\n \"\"\"Raised if a signed header is invalid in some form. This only\n happens for serializers that have a header that goes with the\n signature.\n\n .. versionadded:: 0.24\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n header: t.Any | None = None,\n original_error: Exception | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the header is actually available but just malformed it\n #: might be stored here.\n self.header: t.Any | None = header\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n\nclass BadPayload(BadData):\n \"\"\"Raised if a payload is invalid. This could happen if the payload\n is loaded despite an invalid signature, or if there is a mismatch\n between the serializer and deserializer. The original exception\n that occurred during loading is stored on as :attr:`original_error`.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str, original_error: Exception | None = None):\n super().__init__(message)\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n[end of src/itsdangerous/exc.py]","filename":"src/itsdangerous/exc.py","id":"39"},{"content":"[end of src/itsdangerous/py.typed]","filename":"src/itsdangerous/py.typed","id":"40"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport json\nimport typing as t\n\nfrom .encoding import want_bytes\nfrom .exc import BadPayload\nfrom .exc import BadSignature\nfrom .signer import _make_keys_list\nfrom .signer import Signer\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n # This should be either be str or bytes. To avoid having to specify the\n # bound type, it falls back to a union if structural matching fails.\n _TSerialized = te.TypeVar(\n \"_TSerialized\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\n )\nelse:\n # Still available at runtime on Python < 3.13, but without the default.\n _TSerialized = t.TypeVar(\"_TSerialized\", bound=t.Union[str, bytes])\n\n\nclass _PDataSerializer(t.Protocol[_TSerialized]):\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\n # A signature with additional arguments is not handled correctly by type\n # checkers right now, so an overload is used below for serializers that\n # don't match this strict protocol.\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\n\n\n# Use TypeIs once it's available in typing_extensions or 3.13.\ndef is_text_serializer(\n serializer: _PDataSerializer[t.Any],\n) -> te.TypeGuard[_PDataSerializer[str]]:\n \"\"\"Checks whether a serializer generates text or binary.\"\"\"\n return isinstance(serializer.dumps({}), str)\n\n\nclass Serializer(t.Generic[_TSerialized]):\n \"\"\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\n enable serializing and securely signing data other than bytes. It\n can unsign to verify that the data hasn't been changed.\n\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\n :mod:`json`, and by default uses :mod:`json` internally to serialize\n the data to bytes.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param serializer: An object that provides ``dumps`` and ``loads``\n methods for serializing data to a string. Defaults to\n :attr:`default_serializer`, which defaults to :mod:`json`.\n :param serializer_kwargs: Keyword arguments to pass when calling\n ``serializer.dumps``.\n :param signer: A ``Signer`` class to instantiate when signing data.\n Defaults to :attr:`default_signer`, which defaults to\n :class:`~itsdangerous.signer.Signer`.\n :param signer_kwargs: Keyword arguments to pass when instantiating\n the ``Signer`` class.\n :param fallback_signers: List of signer parameters to try when\n unsigning with the default signer fails. Each item can be a dict\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\n ``(signer, signer_kwargs)``. Defaults to\n :attr:`default_fallback_signers`.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 2.0\n Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``.\n\n .. versionchanged:: 1.1\n Added support for ``fallback_signers`` and configured a default\n SHA-512 fallback. This fallback is for users who used the yanked\n 1.0.0 release which defaulted to SHA-512.\n\n .. versionchanged:: 0.14\n The ``signer`` and ``signer_kwargs`` parameters were added to\n the constructor.\n \"\"\"\n\n #: The default serialization module to use to serialize data to a\n #: string internally. The default is :mod:`json`, but can be changed\n #: to any object that provides ``dumps`` and ``loads`` methods.\n default_serializer: _PDataSerializer[t.Any] = json\n\n #: The default ``Signer`` class to instantiate when signing data.\n #: The default is :class:`itsdangerous.signer.Signer`.\n default_signer: type[Signer] = Signer\n\n #: The default fallback signers to try when unsigning fails.\n default_fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = []\n\n # Serializer[str] if no data serializer is provided, or if it returns str.\n @t.overload\n def __init__(\n self: Serializer[str],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: None | _PDataSerializer[str] = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer positional argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer keyword argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a positional argument. If the strict signature of\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\n # to specify the type.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a keyword argument.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: t.Any | None = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n\n if salt is not None:\n salt = want_bytes(salt)\n # if salt is None then the signer's default is used\n\n self.salt = salt\n\n if serializer is None:\n serializer = self.default_serializer\n\n self.serializer: _PDataSerializer[_TSerialized] = serializer\n self.is_text_serializer: bool = is_text_serializer(serializer)\n\n if signer is None:\n signer = self.default_signer\n\n self.signer: type[Signer] = signer\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\n\n if fallback_signers is None:\n fallback_signers = list(self.default_fallback_signers)\n\n self.fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = fallback_signers\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def load_payload(\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\n ) -> t.Any:\n \"\"\"Loads the encoded object. This function raises\n :class:`.BadPayload` if the payload is not valid. The\n ``serializer`` parameter can be used to override the serializer\n stored on the class. The encoded ``payload`` should always be\n bytes.\n \"\"\"\n if serializer is None:\n use_serializer = self.serializer\n is_text = self.is_text_serializer\n else:\n use_serializer = serializer\n is_text = is_text_serializer(serializer)\n\n try:\n if is_text:\n return use_serializer.loads(payload.decode(\"utf-8\")) # type: ignore[arg-type]\n\n return use_serializer.loads(payload) # type: ignore[arg-type]\n except Exception as e:\n raise BadPayload(\n \"Could not load the payload because an exception\"\n \" occurred on unserializing the data.\",\n original_error=e,\n ) from e\n\n def dump_payload(self, obj: t.Any) -> bytes:\n \"\"\"Dumps the encoded object. The return value is always bytes.\n If the internal serializer returns text, the value will be\n encoded as UTF-8.\n \"\"\"\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\n\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\n \"\"\"Creates a new instance of the signer to be used. The default\n implementation uses the :class:`.Signer` base class.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\n\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\n \"\"\"Iterates over all signers to be tried for unsigning. Starts\n with the configured signer, then constructs each signer\n specified in ``fallback_signers``.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n yield self.make_signer(salt)\n\n for fallback in self.fallback_signers:\n if isinstance(fallback, dict):\n kwargs = fallback\n fallback = self.signer\n elif isinstance(fallback, tuple):\n fallback, kwargs = fallback\n else:\n kwargs = self.signer_kwargs\n\n for secret_key in self.secret_keys:\n yield fallback(secret_key, salt=salt, **kwargs)\n\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\n \"\"\"Returns a signed string serialized with the internal\n serializer. The return value can be either a byte or unicode\n string depending on the format of the internal serializer.\n \"\"\"\n payload = want_bytes(self.dump_payload(obj))\n rv = self.make_signer(salt).sign(payload)\n\n if self.is_text_serializer:\n return rv.decode(\"utf-8\") # type: ignore[return-value]\n\n return rv # type: ignore[return-value]\n\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\n \"\"\"Like :meth:`dumps` but dumps into a file. The file handle has\n to be compatible with what the internal serializer expects.\n \"\"\"\n f.write(self.dumps(obj, salt))\n\n def loads(\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\n signature validation fails.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n return self.load_payload(signer.unsign(s))\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\n \"\"\"Like :meth:`loads` but loads from a file.\"\"\"\n return self.loads(f.read(), salt)\n\n def loads_unsafe(\n self, s: str | bytes, salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads` but without verifying the signature. This\n is potentially very dangerous to use depending on how your\n serializer works. The return value is ``(signature_valid,\n payload)`` instead of just the payload. The first item will be a\n boolean that indicates if the signature is valid. This function\n never fails.\n\n Use it for debugging only and if you know that your serializer\n module is not exploitable (for example, do not use it with a\n pickle serializer).\n\n .. versionadded:: 0.15\n \"\"\"\n return self._loads_unsafe_impl(s, salt)\n\n def _loads_unsafe_impl(\n self,\n s: str | bytes,\n salt: str | bytes | None,\n load_kwargs: dict[str, t.Any] | None = None,\n load_payload_kwargs: dict[str, t.Any] | None = None,\n ) -> tuple[bool, t.Any]:\n \"\"\"Low level helper function to implement :meth:`loads_unsafe`\n in serializer subclasses.\n \"\"\"\n if load_kwargs is None:\n load_kwargs = {}\n\n try:\n return True, self.loads(s, salt=salt, **load_kwargs)\n except BadSignature as e:\n if e.payload is None:\n return False, None\n\n if load_payload_kwargs is None:\n load_payload_kwargs = {}\n\n try:\n return (\n False,\n self.load_payload(e.payload, **load_payload_kwargs),\n )\n except BadPayload:\n return False, None\n\n def load_unsafe(\n self, f: t.IO[t.Any], salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads_unsafe` but loads from a file.\n\n .. versionadded:: 0.15\n \"\"\"\n return self.loads_unsafe(f.read(), salt=salt)\n\n[end of src/itsdangerous/serializer.py]","filename":"src/itsdangerous/serializer.py","id":"41"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport hashlib\nimport hmac\nimport typing as t\n\nfrom .encoding import _base64_alphabet\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\n\n\nclass SigningAlgorithm:\n \"\"\"Subclasses must implement :meth:`get_signature` to provide\n signature generation functionality.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n \"\"\"Returns the signature for the given key and value.\"\"\"\n raise NotImplementedError()\n\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\n \"\"\"Verifies the given signature matches the expected\n signature.\n \"\"\"\n return hmac.compare_digest(sig, self.get_signature(key, value))\n\n\nclass NoneAlgorithm(SigningAlgorithm):\n \"\"\"Provides an algorithm that does not perform any signing and\n returns an empty signature.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n return b\"\"\n\n\ndef _lazy_sha1(string: bytes = b\"\") -> t.Any:\n \"\"\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\n SHA-1, in which case the import and use as a default would fail before the\n developer can configure something else.\n \"\"\"\n return hashlib.sha1(string)\n\n\nclass HMACAlgorithm(SigningAlgorithm):\n \"\"\"Provides signature generation using HMACs.\"\"\"\n\n #: The digest method to use with the MAC algorithm. This defaults to\n #: SHA1, but can be changed to any other function in the hashlib\n #: module.\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n def __init__(self, digest_method: t.Any = None):\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\n return mac.digest()\n\n\ndef _make_keys_list(\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n) -> list[bytes]:\n if isinstance(secret_key, (str, bytes)):\n return [want_bytes(secret_key)]\n\n return [want_bytes(s) for s in secret_key] # pyright: ignore\n\n\nclass Signer:\n \"\"\"A signer securely signs bytes, then unsigns them to verify that\n the value hasn't been changed.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param sep: Separator between the signature and value.\n :param key_derivation: How to derive the signing key from the secret\n key and salt. Possible values are ``concat``, ``django-concat``,\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\n defaults to ``django-concat``.\n :param digest_method: Hash function to use when generating the HMAC\n signature. Defaults to :attr:`default_digest_method`, which\n defaults to :func:`hashlib.sha1`. Note that the security of the\n hash alone doesn't apply when used intermediately in HMAC.\n :param algorithm: A :class:`SigningAlgorithm` instance to use\n instead of building a default :class:`HMACAlgorithm` with the\n ``digest_method``.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 0.18\n ``algorithm`` was added as an argument to the class constructor.\n\n .. versionchanged:: 0.14\n ``key_derivation`` and ``digest_method`` were added as arguments\n to the class constructor.\n \"\"\"\n\n #: The default digest method to use for the signer. The default is\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\n #: compatible object. Note that the security of the hash alone\n #: doesn't apply when used intermediately in HMAC.\n #:\n #: .. versionadded:: 0.14\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n #: The default scheme to use to derive the signing key from the\n #: secret key and salt. The default is ``django-concat``. Possible\n #: values are ``concat``, ``django-concat``, and ``hmac``.\n #:\n #: .. versionadded:: 0.14\n default_key_derivation: str = \"django-concat\"\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous.Signer\",\n sep: str | bytes = b\".\",\n key_derivation: str | None = None,\n digest_method: t.Any | None = None,\n algorithm: SigningAlgorithm | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n self.sep: bytes = want_bytes(sep)\n\n if self.sep in _base64_alphabet:\n raise ValueError(\n \"The given separator cannot be used because it may be\"\n \" contained in the signature itself. ASCII letters,\"\n \" digits, and '-_=' must not be used.\"\n )\n\n if salt is not None:\n salt = want_bytes(salt)\n else:\n salt = b\"itsdangerous.Signer\"\n\n self.salt = salt\n\n if key_derivation is None:\n key_derivation = self.default_key_derivation\n\n self.key_derivation: str = key_derivation\n\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n if algorithm is None:\n algorithm = HMACAlgorithm(self.digest_method)\n\n self.algorithm: SigningAlgorithm = algorithm\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\n \"\"\"This method is called to derive the key. The default key\n derivation choices can be overridden here. Key derivation is not\n intended to be used as a security method to make a complex key\n out of a short password. Instead you should use large random\n secret keys.\n\n :param secret_key: A specific secret key to derive from.\n Defaults to the last item in :attr:`secret_keys`.\n\n .. versionchanged:: 2.0\n Added the ``secret_key`` parameter.\n \"\"\"\n if secret_key is None:\n secret_key = self.secret_keys[-1]\n else:\n secret_key = want_bytes(secret_key)\n\n if self.key_derivation == \"concat\":\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\n elif self.key_derivation == \"django-concat\":\n return t.cast(\n bytes, self.digest_method(self.salt + b\"signer\" + secret_key).digest()\n )\n elif self.key_derivation == \"hmac\":\n mac = hmac.new(secret_key, digestmod=self.digest_method)\n mac.update(self.salt)\n return mac.digest()\n elif self.key_derivation == \"none\":\n return secret_key\n else:\n raise TypeError(\"Unknown key derivation method\")\n\n def get_signature(self, value: str | bytes) -> bytes:\n \"\"\"Returns the signature for the given value.\"\"\"\n value = want_bytes(value)\n key = self.derive_key()\n sig = self.algorithm.get_signature(key, value)\n return base64_encode(sig)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string.\"\"\"\n value = want_bytes(value)\n return value + self.sep + self.get_signature(value)\n\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\n \"\"\"Verifies the signature for the given value.\"\"\"\n try:\n sig = base64_decode(sig)\n except Exception:\n return False\n\n value = want_bytes(value)\n\n for secret_key in reversed(self.secret_keys):\n key = self.derive_key(secret_key)\n\n if self.algorithm.verify_signature(key, value, sig):\n return True\n\n return False\n\n def unsign(self, signed_value: str | bytes) -> bytes:\n \"\"\"Unsigns the given string.\"\"\"\n signed_value = want_bytes(signed_value)\n\n if self.sep not in signed_value:\n raise BadSignature(f\"No {self.sep!r} found in value\")\n\n value, sig = signed_value.rsplit(self.sep, 1)\n\n if self.verify_signature(value, sig):\n return value\n\n raise BadSignature(f\"Signature {sig!r} does not match\", payload=value)\n\n def validate(self, signed_value: str | bytes) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\n \"\"\"\n try:\n self.unsign(signed_value)\n return True\n except BadSignature:\n return False\n\n[end of src/itsdangerous/signer.py]","filename":"src/itsdangerous/signer.py","id":"42"}],"string":"[\n {\n \"content\": \"How to contribute to ItsDangerous\\n=================================\\n\\nThank you for considering contributing to ItsDangerous!\\n\\n\\nSupport questions\\n-----------------\\n\\nPlease don't use the issue tracker for this. The issue tracker is a\\ntool to address bugs and feature requests in ItsDangerous itself. Use\\none of the following resources for questions about using ItsDangerous or\\nissues with your own code:\\n\\n- The ``#get-help`` channel on our Discord chat:\\n https://discord.gg/pallets\\n- The mailing list flask@python.org for long term discussion or larger\\n issues.\\n- Ask on `Stack Overflow`_. Search with Google first using:\\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\\n\\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\\n\\n\\nReporting issues\\n----------------\\n\\nInclude the following information in your post:\\n\\n- Describe what you expected to happen.\\n- If possible, include a `minimal reproducible example`_ to help us\\n identify the issue. This also helps check that the issue is not with\\n your own code.\\n- Describe what actually happened. Include the full traceback if there\\n was an exception.\\n- List your Python and ItsDangerous versions. If possible, check if\\n this issue is already fixed in the latest releases or the latest\\n code in the repository.\\n\\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\\n\\n\\nSubmitting patches\\n------------------\\n\\nIf there is not an open issue for what you want to submit, prefer\\nopening one for discussion before working on a PR. You can work on any\\nissue that doesn't have an open PR linked to it or a maintainer assigned\\nto it. These show up in the sidebar. No need to ask if you can work on\\nan issue that interests you.\\n\\nInclude the following in your patch:\\n\\n- Use `Black`_ to format your code. This and other tools will run\\n automatically if you install `pre-commit`_ using the instructions\\n below.\\n- Include tests if your patch adds or changes code. Make sure the test\\n fails without your patch.\\n- Update any relevant docs pages and docstrings. Docs pages and\\n docstrings should be wrapped at 72 characters.\\n- Add an entry in ``CHANGES.rst``. Use the same style as other\\n entries. Also include ``.. versionchanged::`` inline changelogs in\\n relevant docstrings.\\n\\n.. _Black: https://black.readthedocs.io\\n.. _pre-commit: https://pre-commit.com\\n\\n\\nFirst time setup\\n~~~~~~~~~~~~~~~~\\n\\n- Download and install the `latest version of git`_.\\n- Configure git with your `username`_ and `email`_.\\n\\n .. code-block:: text\\n\\n $ git config --global user.name 'your name'\\n $ git config --global user.email 'your email'\\n\\n- Make sure you have a `GitHub account`_.\\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\\n button.\\n- `Clone`_ the main repository locally.\\n\\n .. code-block:: text\\n\\n $ git clone https://github.com/pallets/itsdangerous\\n $ cd itsdangerous\\n\\n- Add your fork as a remote to push your work to. Replace\\n ``{username}`` with your username. This names the remote \\\"fork\\\", the\\n default Pallets remote is \\\"origin\\\".\\n\\n .. code-block:: text\\n\\n $ git remote add fork https://github.com/{username}/itsdangerous\\n\\n- Create a virtualenv.\\n\\n .. code-block:: text\\n\\n $ python3 -m venv env\\n $ . env/bin/activate\\n\\n On Windows, activating is different.\\n\\n .. code-block:: text\\n\\n > env\\\\Scripts\\\\activate\\n\\n- Install the development dependencies, then install ItsDangerous in\\n editable mode.\\n\\n .. code-block:: text\\n\\n $ pip install -r requirements/dev.txt && pip install -e .\\n\\n- Install the pre-commit hooks.\\n\\n .. code-block:: text\\n\\n $ pre-commit install\\n\\n.. _latest version of git: https://git-scm.com/downloads\\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\\n.. _GitHub account: https://github.com/join\\n.. _Fork: https://github.com/pallets/itsdangerous/fork\\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\\n\\n\\nStart coding\\n~~~~~~~~~~~~\\n\\n- Create a branch to identify the issue you would like to work on. If\\n you're submitting a bug or documentation fix, branch off of the\\n latest \\\".x\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/2.0.x\\n\\n If you're submitting a feature addition or change, branch off of the\\n \\\"main\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/main\\n\\n- Using your favorite editor, make your changes,\\n `committing as you go`_.\\n- Include tests that cover any code changes you make. Make sure the\\n test fails without your patch. Run the tests as described below.\\n- Push your commits to your fork on GitHub and\\n `create a pull request`_. Link to the issue being addressed with\\n ``fixes #123`` in the pull request.\\n\\n .. code-block:: text\\n\\n $ git push --set-upstream fork your-branch-name\\n\\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\\n\\n\\nRunning the tests\\n~~~~~~~~~~~~~~~~~\\n\\nRun the basic test suite with pytest.\\n\\n.. code-block:: text\\n\\n $ pytest\\n\\nThis runs the tests for the current environment, which is usually\\nsufficient. CI will run the full suite when you submit your pull\\nrequest. You can run the full test suite with tox if you don't want to\\nwait.\\n\\n.. code-block:: text\\n\\n $ tox\\n\\n\\nRunning test coverage\\n~~~~~~~~~~~~~~~~~~~~~\\n\\nGenerating a report of lines that do not have test coverage can indicate\\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\\ngenerate a report.\\n\\n.. code-block:: text\\n\\n $ pip install coverage\\n $ coverage run -m pytest\\n $ coverage html\\n\\nOpen ``htmlcov/index.html`` in your browser to explore the report.\\n\\nRead more about `coverage <https://coverage.readthedocs.io>`__.\\n\\n\\nBuilding the docs\\n~~~~~~~~~~~~~~~~~\\n\\nBuild the docs in the ``docs`` directory using Sphinx.\\n\\n.. code-block:: text\\n\\n $ cd docs\\n $ make html\\n\\nOpen ``_build/html/index.html`` in your browser to view the docs.\\n\\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\\n\\n[end of CONTRIBUTING.rst]\",\n \"filename\": \"CONTRIBUTING.rst\",\n \"id\": \"0\"\n },\n {\n \"content\": \"repos:\\n - repo: https://github.com/astral-sh/ruff-pre-commit\\n rev: v0.7.1\\n hooks:\\n - id: ruff\\n - id: ruff-format\\n - repo: https://github.com/pre-commit/pre-commit-hooks\\n rev: v5.0.0\\n hooks:\\n - id: check-merge-conflict\\n - id: debug-statements\\n - id: fix-byte-order-marker\\n - id: trailing-whitespace\\n - id: end-of-file-fixer\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[project]\\nname = \\\"itsdangerous\\\"\\nversion = \\\"2.2.0\\\"\\ndescription = \\\"Safely pass data to untrusted environments and back.\\\"\\nreadme = \\\"README.md\\\"\\nlicense = { file = \\\"LICENSE.txt\\\" }\\nmaintainers = [{ name = \\\"Pallets\\\", email = \\\"contact@palletsprojects.com\\\" }]\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Typing :: Typed\\\",\\n]\\nrequires-python = \\\">=3.8\\\"\\n\\n[project.urls]\\nDonate = \\\"https://palletsprojects.com/donate\\\"\\nDocumentation = \\\"https://itsdangerous.palletsprojects.com/\\\"\\nChanges = \\\"https://itsdangerous.palletsprojects.com/changes/\\\"\\nSource = \\\"https://github.com/pallets/itsdangerous/\\\"\\nChat = \\\"https://discord.gg/pallets\\\"\\n\\n[build-system]\\nrequires = [\\\"flit_core<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.module]\\nname = \\\"itsdangerous\\\"\\n\\n[tool.flit.sdist]\\ninclude = [\\n \\\"docs/\\\",\\n \\\"requirements/\\\",\\n \\\"tests/\\\",\\n \\\"CHANGES.rst\\\",\\n \\\"tox.ini\\\",\\n]\\nexclude = [\\n \\\"docs/_build/\\\",\\n]\\n\\n[tool.pytest.ini_options]\\ntestpaths = [\\\"tests\\\"]\\nfilterwarnings = [\\n \\\"error\\\",\\n]\\n\\n[tool.coverage.run]\\nbranch = true\\nsource = [\\\"itsdangerous\\\", \\\"tests\\\"]\\n\\n[tool.coverage.paths]\\nsource = [\\\"src\\\", \\\"*/site-packages\\\"]\\n\\n[tool.mypy]\\npython_version = \\\"3.8\\\"\\nfiles = [\\\"src/itsdangerous\\\"]\\nshow_error_codes = true\\npretty = true\\nstrict = true\\n\\n[tool.pyright]\\npythonVersion = \\\"3.8\\\"\\ninclude = [\\\"src/itsdangerous\\\"]\\ntypeCheckingMode = \\\"basic\\\"\\n\\n[tool.ruff]\\nsrc = [\\\"src\\\"]\\nfix = true\\nshow-fixes = true\\noutput-format = \\\"full\\\"\\n\\n[tool.ruff.lint]\\nselect = [\\n \\\"B\\\", # flake8-bugbear\\n \\\"E\\\", # pycodestyle error\\n \\\"F\\\", # pyflakes\\n \\\"I\\\", # isort\\n \\\"UP\\\", # pyupgrade\\n \\\"W\\\", # pycodestyle warning\\n]\\n\\n[tool.ruff.lint.isort]\\nforce-single-line = true\\norder-by-type = false\\n\\n[tool.gha-update]\\ntag-only = [\\n \\\"slsa-framework/slsa-github-generator\\\",\\n]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\nindent_style = space\\nindent_size = 4\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\nend_of_line = lf\\ncharset = utf-8\\nmax_line_length = 88\\n\\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"3\"\n },\n {\n \"content\": \"# ItsDangerous\\n\\n... so better sign this\\n\\nVarious helpers to pass data to untrusted environments and to get it\\nback safe and sound. Data is cryptographically signed to ensure that a\\ntoken has not been tampered with.\\n\\nIt's possible to customize how data is serialized. Data is compressed as\\nneeded. A timestamp can be added and verified automatically while\\nloading a token.\\n\\n\\n## A Simple Example\\n\\nHere's how you could generate a token for transmitting a user's id and\\nname between web requests.\\n\\n```python\\nfrom itsdangerous import URLSafeSerializer\\nauth_s = URLSafeSerializer(\\\"secret key\\\", \\\"auth\\\")\\ntoken = auth_s.dumps({\\\"id\\\": 5, \\\"name\\\": \\\"itsdangerous\\\"})\\n\\nprint(token)\\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\\n\\ndata = auth_s.loads(token)\\nprint(data[\\\"name\\\"])\\n# itsdangerous\\n```\\n\\n\\n## Donate\\n\\nThe Pallets organization develops and supports ItsDangerous and other\\npopular packages. In order to grow the community of contributors and\\nusers, and allow the maintainers to devote more time to the projects,\\n[please donate today][].\\n\\n[please donate today]: https://palletsprojects.com/donate\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"[tox]\\nenvlist =\\n py3{13,12,11,10,9,8}\\n pypy310\\n style\\n typing\\n docs\\nskip_missing_interpreters = true\\n\\n[testenv]\\npackage = wheel\\nwheel_build_env = .pkg\\nconstrain_package_deps = true\\nuse_frozen_constraints = true\\ndeps = -r requirements/tests.txt\\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\\n\\n[testenv:style]\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit run --all-files\\n\\n[testenv:typing]\\ndeps = -r requirements/typing.txt\\ncommands =\\n mypy\\n pyright\\n pyright --verifytypes itsdangerous --ignoreexternal\\n\\n[testenv:docs]\\ndeps = -r requirements/docs.txt\\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\\n\\n[testenv:update-actions]\\nlabels = update\\ndeps = gha-update\\ncommands = gha-update\\n\\n[testenv:update-pre_commit]\\nlabels = update\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit autoupdate -j4\\n\\n[testenv:update-requirements]\\nlabels = update\\ndeps = pip-tools\\nskip_install = true\\nchange_dir = requirements\\ncommands =\\n pip-compile build.in -q {posargs:-U}\\n pip-compile docs.in -q {posargs:-U}\\n pip-compile tests.in -q {posargs:-U}\\n pip-compile typing.in -q {posargs:-U}\\n pip-compile dev.in -q {posargs:-U}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"5\"\n },\n {\n \"content\": \"Copyright 2011 Pallets\\n\\nRedistribution and use in source and binary forms, with or without\\nmodification, are permitted provided that the following conditions are\\nmet:\\n\\n1. Redistributions of source code must retain the above copyright\\n notice, this list of conditions and the following disclaimer.\\n\\n2. 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\\n3. Neither the name of the copyright holder nor the names of its\\n contributors may be used to endorse or promote products derived from\\n this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE.txt]\",\n \"filename\": \"LICENSE.txt\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Version 2.2.0\\n-------------\\n\\nReleased 2024-04-16\\n\\n- Drop support for Python 3.7. :pr:`372`\\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\\n :pr:`326`\\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\\n- Deprecate the ``__version__`` attribute. Use feature detection, or\\n ``importlib.metadata.version(\\\"itsdangerous\\\")``, instead. :issue:`371`\\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\\n different ``serializer`` argument is given, it will try to infer the return\\n type of its ``dumps`` method. :issue:`347`\\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\\n access it at import time so the developer has time to change the default.\\n :issue:`375`\\n\\n\\nVersion 2.1.2\\n-------------\\n\\nReleased 2022-03-24\\n\\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\\n\\n\\nVersion 2.1.1\\n-------------\\n\\nReleased 2022-03-09\\n\\n- Handle date overflow in timed unsign. :pr:`296`\\n\\n\\nVersion 2.1.0\\n-------------\\n\\nReleased 2022-02-17\\n\\n- Drop support for Python 3.6. :pr:`272`\\n- Remove previously deprecated code. :pr:`273`\\n\\n - JWS functionality: Use a dedicated library such as Authlib\\n instead.\\n - ``import itsdangerous.json``: Import ``json`` from the standard\\n library instead.\\n\\n\\nVersion 2.0.1\\n-------------\\n\\nReleased 2021-05-18\\n\\n- Mark top-level names as exported so type checking understands\\n imports in user projects. :pr:`240`\\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\\n ``None`` again. :issue:`237`\\n\\n\\nVersion 2.0.0\\n-------------\\n\\nReleased 2021-05-11\\n\\n- Drop support for Python 2 and 3.5.\\n- JWS support (``JSONWebSignatureSerializer``,\\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\\n JWS/JWT library such as authlib instead. :issue:`129`\\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\\n ``json`` module instead. :pr:`152`\\n- Simplejson is no longer used if it is installed. To use a different\\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\\n- If a signature has an age less than 0, it will raise\\n ``SignatureExpired`` rather than appearing valid. This can happen if\\n the timestamp offset is changed. :issue:`126`\\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\\n rather than an ``int`` in some cases. :issue:`124`\\n- Added support for key rotation. A list of keys can be passed as\\n ``secret_key``, oldest to newest. The newest key is used for\\n signing, all keys are tried for unsigning. :pr:`141`\\n- Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``. :issue:`155`\\n- Add type information for static typing tools. :pr:`186`\\n\\n\\nVersion 1.1.0\\n-------------\\n\\nReleased 2018-10-26\\n\\n- Change default signing algorithm back to SHA-1. :pr:`113`\\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\\n release which defaulted to SHA-512. :pr:`114`\\n- Add support for fallback algorithms during deserialization to\\n support changing the default in the future without breaking existing\\n signatures. :pr:`113`\\n- Changed capitalization of packages back to lowercase as the change\\n in capitalization broke some tooling. :pr:`113`\\n\\n\\nVersion 1.0.0\\n-------------\\n\\nReleased 2018-10-18\\n\\nYANKED\\n\\n*Note*: This release was yanked from PyPI because it changed the default\\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\\nat SHA1.\\n\\n- Drop support for Python 2.6 and 3.3.\\n- Refactor code from a single module to a package. Any object in the\\n API docs is still importable from the top-level ``itsdangerous``\\n name, but other imports will need to be changed. A future release\\n will remove many of these compatibility imports. :pr:`107`\\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\\n :pr:`27`\\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\\n Python 3. :issue:`29`\\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\\n- More compact JSON dumps for unicode strings. :issue:`38`\\n- Use the full timestamp rather than an offset, allowing dates before\\n 2011. :issue:`46`\\n\\n To retain compatibility with signers from previous versions,\\n consider using `this shim <https://github.com/pallets/itsdangerous\\n /issues/120#issuecomment-456913331>`_ when unsigning.\\n- Detect a ``sep`` character that may show up in the signature itself\\n and raise a ``ValueError``. :issue:`62`\\n- Use a consistent signature for keyword arguments for\\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\\n- Convert JWS exp header to an int when loading. :pr:`99`\\n\\n\\nVersion 0.24\\n------------\\n\\nReleased 2014-03-28\\n\\n- Added a ``BadHeader`` exception that is used for bad headers that\\n replaces the old ``BadPayload`` exception that was reused in those\\n cases.\\n\\n\\nVersion 0.23\\n------------\\n\\nReleased 2013-08-08\\n\\n- Fixed a packaging mistake that caused the tests and license files to\\n not be included.\\n\\n\\nVersion 0.22\\n------------\\n\\nReleased 2013-07-03\\n\\n- Added support for ``TimedJSONWebSignatureSerializer``.\\n- Made it possible to override the signature verification function to\\n allow implementing asymmetrical algorithms.\\n\\n\\nVersion 0.21\\n------------\\n\\nReleased 2013-05-26\\n\\n- Fixed an issue on Python 3 which caused invalid errors to be\\n generated.\\n\\n\\nVersion 0.20\\n------------\\n\\nReleased 2013-05-23\\n\\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\\n ItsDangerous on Python 2.6.\\n\\n\\nVersion 0.19\\n------------\\n\\nReleased 2013-05-21\\n\\n- Dropped support for 2.5 and added support for 3.3.\\n\\n\\nVersion 0.18\\n------------\\n\\nReleased 2013-05-03\\n\\n- Added support for JSON Web Signatures (JWS).\\n\\n\\nVersion 0.17\\n------------\\n\\nReleased 2012-08-10\\n\\n- Fixed a name error when overriding the digest method.\\n\\n\\nVersion 0.16\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made it possible to pass unicode values to ``load_payload`` to make\\n it easier to debug certain things.\\n\\n\\nVersion 0.15\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made standalone ``load_payload`` more robust by raising one specific\\n error if something goes wrong.\\n- Refactored exceptions to catch more cases individually, added more\\n attributes.\\n- Fixed an issue that caused ``load_payload`` not work in some\\n situations with timestamp based serializers\\n- Added an ``loads_unsafe`` method.\\n\\n\\nVersion 0.14\\n------------\\n\\nReleased 2012-06-29\\n\\n- API refactoring to support different key derivations.\\n- Added attributes to exceptions so that you can inspect the data even\\n if the signature check failed.\\n\\n\\nVersion 0.13\\n------------\\n\\nReleased 2012-06-10\\n\\n- Small API change that enables customization of the digest module.\\n\\n\\nVersion 0.12\\n------------\\n\\nReleased 2012-02-22\\n\\n- Fixed a problem with the local timezone being used for the epoch\\n calculation. This might invalidate some of your signatures if you\\n were not running in UTC timezone. You can revert to the old behavior\\n by monkey patching ``itsdangerous.EPOCH``.\\n\\n\\nVersion 0.11\\n------------\\n\\nReleased 2011-07-07\\n\\n- Fixed an uncaught value error.\\n\\n\\nVersion 0.10\\n------------\\n\\nReleased 2011-06-25\\n\\n- Refactored interface that the underlying serializers can be swapped\\n by passing in a module instead of having to override the payload\\n loaders and dumpers. This makes the interface more compatible with\\n Django's recent changes.\\n\\n[end of CHANGES.rst]\",\n \"filename\": \"CHANGES.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"version: 2\\nbuild:\\n os: ubuntu-22.04\\n tools:\\n python: '3.12'\\npython:\\n install:\\n - requirements: requirements/docs.txt\\n - method: pip\\n path: .\\nsphinx:\\n builder: dirhtml\\n fail_on_warning: true\\n\\n[end of .readthedocs.yaml]\",\n \"filename\": \".readthedocs.yaml\",\n \"id\": \"8\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile dev.in\\n#\\nalabaster==1.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nbabel==2.16.0\\n # via\\n # -r docs.txt\\n # sphinx\\ncachetools==5.5.0\\n # via tox\\ncertifi==2024.8.30\\n # via\\n # -r docs.txt\\n # requests\\ncfgv==3.4.0\\n # via pre-commit\\nchardet==5.2.0\\n # via tox\\ncharset-normalizer==3.4.0\\n # via\\n # -r docs.txt\\n # requests\\ncolorama==0.4.6\\n # via tox\\ndistlib==0.3.9\\n # via virtualenv\\ndocutils==0.21.2\\n # via\\n # -r docs.txt\\n # sphinx\\nfilelock==3.16.1\\n # via\\n # tox\\n # virtualenv\\nfreezegun==1.5.1\\n # via -r tests.txt\\nidentify==2.6.1\\n # via pre-commit\\nidna==3.10\\n # via\\n # -r docs.txt\\n # requests\\nimagesize==1.4.1\\n # via\\n # -r docs.txt\\n # sphinx\\niniconfig==2.0.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\njinja2==3.1.4\\n # via\\n # -r docs.txt\\n # sphinx\\nmarkupsafe==3.0.2\\n # via\\n # -r docs.txt\\n # jinja2\\nmypy==1.13.0\\n # via -r typing.txt\\nmypy-extensions==1.0.0\\n # via\\n # -r typing.txt\\n # mypy\\nnodeenv==1.9.1\\n # via\\n # -r typing.txt\\n # pre-commit\\n # pyright\\npackaging==24.1\\n # via\\n # -r docs.txt\\n # -r tests.txt\\n # -r typing.txt\\n # pallets-sphinx-themes\\n # pyproject-api\\n # pytest\\n # sphinx\\n # tox\\npallets-sphinx-themes==2.3.0\\n # via -r docs.txt\\nplatformdirs==4.3.6\\n # via\\n # tox\\n # virtualenv\\npluggy==1.5.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\n # tox\\npre-commit==4.0.1\\n # via -r dev.in\\npygments==2.18.0\\n # via\\n # -r docs.txt\\n # sphinx\\npyproject-api==1.8.0\\n # via tox\\npyright==1.1.386\\n # via -r typing.txt\\npytest==8.3.3\\n # via\\n # -r tests.txt\\n # -r typing.txt\\npython-dateutil==2.9.0.post0\\n # via\\n # -r tests.txt\\n # freezegun\\npyyaml==6.0.2\\n # via pre-commit\\nrequests==2.32.3\\n # via\\n # -r docs.txt\\n # sphinx\\nsix==1.16.0\\n # via\\n # -r tests.txt\\n # python-dateutil\\nsnowballstemmer==2.2.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.txt\\nsphinxcontrib-qthelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\ntox==4.23.2\\n # via -r dev.in\\ntyping-extensions==4.12.2\\n # via\\n # -r typing.txt\\n # mypy\\n # pyright\\nurllib3==2.2.3\\n # via\\n # -r docs.txt\\n # requests\\nvirtualenv==20.27.0\\n # via\\n # pre-commit\\n # tox\\n\\n[end of requirements/dev.txt]\",\n \"filename\": \"requirements/dev.txt\",\n \"id\": \"9\"\n },\n {\n \"content\": \"pallets-sphinx-themes\\nsphinx\\nsphinxcontrib-log-cabinet\\n\\n[end of requirements/docs.in]\",\n \"filename\": \"requirements/docs.in\",\n \"id\": \"10\"\n },\n {\n \"content\": \"build\\n\\n[end of requirements/build.in]\",\n \"filename\": \"requirements/build.in\",\n \"id\": \"11\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile typing.in\\n#\\niniconfig==2.0.0\\n # via pytest\\nmypy==1.13.0\\n # via -r typing.in\\nmypy-extensions==1.0.0\\n # via mypy\\nnodeenv==1.9.1\\n # via pyright\\npackaging==24.1\\n # via pytest\\npluggy==1.5.0\\n # via pytest\\npyright==1.1.386\\n # via -r typing.in\\npytest==8.3.3\\n # via -r typing.in\\ntyping-extensions==4.12.2\\n # via\\n # mypy\\n # pyright\\n\\n[end of requirements/typing.txt]\",\n \"filename\": \"requirements/typing.txt\",\n \"id\": \"12\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile build.in\\n#\\nbuild==1.2.2.post1\\n # via -r build.in\\npackaging==24.1\\n # via build\\npyproject-hooks==1.2.0\\n # via build\\n\\n[end of requirements/build.txt]\",\n \"filename\": \"requirements/build.txt\",\n \"id\": \"13\"\n },\n {\n \"content\": \"mypy\\npyright\\npytest\\n\\n[end of requirements/typing.in]\",\n \"filename\": \"requirements/typing.in\",\n \"id\": \"14\"\n },\n {\n \"content\": \"-r docs.txt\\n-r tests.txt\\n-r typing.txt\\npre-commit\\ntox\\n\\n[end of requirements/dev.in]\",\n \"filename\": \"requirements/dev.in\",\n \"id\": \"15\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile docs.in\\n#\\nalabaster==1.0.0\\n # via sphinx\\nbabel==2.16.0\\n # via sphinx\\ncertifi==2024.8.30\\n # via requests\\ncharset-normalizer==3.4.0\\n # via requests\\ndocutils==0.21.2\\n # via sphinx\\nidna==3.10\\n # via requests\\nimagesize==1.4.1\\n # via sphinx\\njinja2==3.1.4\\n # via sphinx\\nmarkupsafe==3.0.2\\n # via jinja2\\npackaging==24.1\\n # via\\n # pallets-sphinx-themes\\n # sphinx\\npallets-sphinx-themes==2.3.0\\n # via -r docs.in\\npygments==2.18.0\\n # via sphinx\\nrequests==2.32.3\\n # via sphinx\\nsnowballstemmer==2.2.0\\n # via sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.in\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.in\\nsphinxcontrib-qthelp==2.0.0\\n # via sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via sphinx\\nurllib3==2.2.3\\n # via requests\\n\\n[end of requirements/docs.txt]\",\n \"filename\": \"requirements/docs.txt\",\n \"id\": \"16\"\n },\n {\n \"content\": \".. rst-class:: hide-header\\n\\nItsDangerous\\n============\\n\\n.. image:: _static/itsdangerous-logo.png\\n :align: center\\n :target: https://palletsprojects.com/p/itsdangerous/\\n\\nSometimes you want to send some data to untrusted environments, then get\\nit back later. To do this safely, the data must be signed to detect\\nchanges.\\n\\nGiven a key only you know, you can cryptographically sign your data and\\nhand it over to someone else. When you get the data back you can ensure\\nthat nobody tampered with it.\\n\\nThe receiver can see the data, but they can not modify it unless they\\nalso have your key. So if you keep the key secret and complex, you will\\nbe fine.\\n\\n\\nInstalling\\n----------\\n\\nInstall and update using `pip`_:\\n\\n.. code-block:: text\\n\\n pip install -U itsdangerous\\n\\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\\n\\n\\nExample Use Cases\\n-----------------\\n\\n- Sign a user ID in a URL and email it to them to unsubscribe from a\\n newsletter. This way you don't need to generate one-time tokens and\\n store them in the database. Same thing with any kind of activation\\n link for accounts and similar things.\\n- Signed objects can be stored in cookies or other untrusted sources\\n which means you don't need to have sessions stored on the server,\\n which reduces the number of necessary database queries.\\n- Signed information can safely do a round trip between server and\\n client in general which makes them useful for passing server-side\\n state to a client and then back.\\n\\n\\nTable of Contents\\n-----------------\\n\\n.. toctree::\\n\\n concepts\\n serializer\\n signer\\n exceptions\\n timed\\n url_safe\\n encoding\\n license\\n changes\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"17\"\n },\n {\n \"content\": \".. module:: itsdangerous.serializer\\n\\nSerialization Interface\\n=======================\\n\\nThe :doc:`/signer` only signs bytes. To sign other types, the\\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\\nsimilar to Python's :mod:`json` module, which serializes the object to a\\nstring then signs that.\\n\\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n s = Serializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\\n\\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\\nthe data.\\n\\n.. code-block:: python\\n\\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\\n [1, 2, 3, 4]\\n\\nBy default, data is serialized to JSON with the built-in :mod:`json`\\nmodule. This internal serializer can be changed by subclassing.\\n\\nTo record and validate the age of the signature, see :doc:`/timed`.\\nTo serialize to a format that is safe to use in URLs, see\\n:doc:`/url_safe`.\\n\\n\\nResponding to Failure\\n---------------------\\n\\nExceptions have helpful attributes which allow you to inspect the\\npayload if the signature check failed. This has to be done with extra\\ncare because at that point you know that someone tampered with your data\\nbut it might be useful for debugging purposes.\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n from itsdangerous.exc import BadSignature, BadData\\n\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n decoded_payload = None\\n\\n try:\\n decoded_payload = s.loads(data)\\n # This payload is decoded and safe\\n except BadSignature as e:\\n if e.payload is not None:\\n try:\\n decoded_payload = s.load_payload(e.payload)\\n except BadData:\\n pass\\n # This payload is decoded but unsafe because someone\\n # tampered with the signature. The decode (load_payload)\\n # step is explicit because it might be unsafe to unserialize\\n # the payload (think pickle instead of json!)\\n\\nIf you don't want to inspect attributes to figure out what exactly went\\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\\n\\n.. code-block:: python\\n\\n sig_okay, payload = s.loads_unsafe(data)\\n\\nThe first item in the returned tuple is a boolean that indicates if the\\nsignature was correct.\\n\\n\\nFallback Signers\\n----------------\\n\\nYou may want to upgrade the signing parameters without invalidating\\nexisting signatures immediately. For example, you may decide that you\\nwant to use a different digest method. New signatures should use the new\\nmethod, but old signatures should still validate.\\n\\nA list of ``fallback_signers`` can be given that will be tried if\\nunsigning with the current signer fails. Each item in the list can be:\\n\\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\\n passed to the serializer.\\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\\n serializer.\\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\\n given class with the given args.\\n\\nFor example, this is a serializer that signs using SHA-512, but will\\nunsign using either SHA-512 or SHA-1:\\n\\n.. code-block:: python\\n\\n s = Serializer(\\n signer_kwargs={\\\"digest_method\\\": hashlib.sha512},\\n fallback_signers=[{\\\"digest_method\\\": hashlib.sha1}]\\n )\\n\\n\\n\\nAPI\\n---\\n\\n.. autoclass:: Serializer\\n :members:\\n\\n[end of docs/serializer.rst]\",\n \"filename\": \"docs/serializer.rst\",\n \"id\": \"18\"\n },\n {\n \"content\": \".. module:: itsdangerous.signer\\n\\nSigning Interface\\n=================\\n\\nThe most basic interface is the signing interface. The :class:`Signer`\\nclass can be used to attach a signature to a specific string:\\n\\n.. code-block:: python\\n\\n from itsdangerous import Signer\\n s = Signer(\\\"secret-key\\\")\\n s.sign(\\\"my string\\\")\\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\\n\\nThe signature is appended to the string, separated by a dot. To validate\\nthe string, use the :meth:`~Signer.unsign` method:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n b'my string'\\n\\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\\nHowever after unsigning you won't be able to tell if it was unicode or\\na bytestring.\\n\\nIf the value is changed, the signature will no longer match, and\\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nTo record and validate the age of a signature, see :doc:`/timed`.\\n\\n.. autoclass:: Signer\\n :members:\\n\\n\\nSigning Algorithms\\n------------------\\n\\n.. autoclass:: NoneAlgorithm\\n\\n.. autoclass:: HMACAlgorithm\\n\\n[end of docs/signer.rst]\",\n \"filename\": \"docs/signer.rst\",\n \"id\": \"19\"\n },\n {\n \"content\": \"General Concepts\\n================\\n\\n\\nSerializer vs Signer\\n--------------------\\n\\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\\nthe basic system that signs a given ``bytes`` value based on the given\\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\\nserializing and signing other data besides ``bytes``.\\n\\nTypically, you'll want to use a serializer, not a signer. You can\\nconfigure the signing parameters through the serializer, and even\\nprovide fallback signers to upgrade old tokens to new parameters.\\n\\n\\nThe Secret Key\\n--------------\\n\\nSignatures are secured by the ``secret_key``. Typically one secret key\\nis used with all signers, and the salt is used to distinguish different\\ncontexts. Changing the secret key will invalidate existing tokens.\\n\\nIt should be a long random string of bytes. This value must be kept\\nsecret and should not be saved in source code or committed to version\\ncontrol. If an attacker learns the secret key, they can change and\\nresign data to look valid. If you suspect this happened, change the\\nsecret key to invalidate existing tokens.\\n\\nOne way to keep the secret key separate is to read it from an\\nenvironment variable. When deploying for the first time, generate a key\\nand set the environment variable when running the application. All\\nprocess managers (like systemd) and hosting services have a way to\\nspecify environment variables.\\n\\n.. code-block:: python\\n\\n import os\\n from itsdangerous.serializer import Serializer\\n SECRET_KEY = os.environ.get(\\\"SECRET_KEY\\\")\\n s = Serializer(SECRET_KEY)\\n\\n.. code-block:: text\\n\\n $ export SECRET_KEY=\\\"base64 encoded random bytes\\\"\\n $ python application.py\\n\\nOne way to generate a key is to use :func:`os.urandom`.\\n\\n.. code-block:: text\\n\\n $ python3 -c 'import os; print(os.urandom(16).hex())'\\n\\n\\nThe Salt\\n--------\\n\\nThe salt is combined with the secret key to derive a unique key for\\ndistinguishing different contexts. Unlike the secret key, the salt\\ndoesn't have to be random, and can be saved in code. It only has to be\\nunique between contexts, not private.\\n\\nFor example, you want to email activation links to activate user\\naccounts, and upgrade links to upgrade users to a paid accounts. If all\\nyou sign is the user id, and you don't use different salts, a user could\\nreuse the token from the activation link to upgrade the account. If you\\nuse different salts, the signatures will be different and will not be\\nvalid in the other context.\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n\\n s1 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"activate\\\")\\n s1.dumps(42)\\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\\n\\n s2 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"upgrade\\\")\\n s2.dumps(42)\\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\\n\\nThe second serializer can't load data dumped with the first because the\\nsalts differ.\\n\\n.. code-block:: python\\n\\n s2.loads(s1.dumps(42))\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nOnly the serializer with the same salt can load the data.\\n\\n.. code-block:: python\\n\\n s2.loads(s2.dumps(42))\\n 42\\n\\n\\nKey Rotation\\n------------\\n\\nKey rotation can provide an extra layer of mitigation against an\\nattacker discovering a secret key. A rotation system will keep a list of\\nvalid keys, generating a new key and removing the oldest key\\nperiodically. If it takes four weeks for an attacker to crack a key, but\\nthe key is rotated out after three weeks, they will not be able to use\\nany keys they crack. However, if a user doesn't refresh their token\\nwithin three weeks it will be invalid too.\\n\\nThe system that generates and maintains this list is outside the scope\\nof ItsDangerous, but ItsDangerous does support validating against a list\\nof keys.\\n\\nInstead of passing a single key, you can pass a list of keys, oldest to\\nnewest. When signing the last (newest) key will be used, and when\\nvalidating each key will be tried from newest to oldest before raising\\na validation error.\\n\\n.. code-block:: python\\n\\n SECRET_KEYS = [\\\"2b9cd98e\\\", \\\"169d7886\\\", \\\"b6af09f5\\\"]\\n\\n # sign some data with the latest key\\n s = Serializer(SECRET_KEYS)\\n t = s.dumps({\\\"id\\\": 42})\\n\\n # rotate a new key in and the oldest key out\\n SECRET_KEYS.append(\\\"cf9b3588\\\")\\n del SECRET_KEYS[0]\\n\\n s = Serializer(SECRET_KEYS)\\n s.loads(t) # valid even though it was signed with a previous key\\n\\n\\nDigest Method Security\\n----------------------\\n\\nA signer is configured with a ``digest_method``, a hash function that\\nis used as an intermediate step when generating the HMAC signature. The\\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\\nconcerned about this default because they have heard about hash\\ncollisions with SHA-1.\\n\\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\\nhash alone doesn't apply when used in HMAC.\\n\\nIf a project considers SHA-1 a risk anyway, they can configure the\\nsigner with a different digest method such as :func:`hashlib.sha512`.\\nA fallback signer for SHA-1 can be configured so that old tokens will be\\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\\nspace, which is relevant in cookies and URLs.\\n\\n[end of docs/concepts.rst]\",\n \"filename\": \"docs/concepts.rst\",\n \"id\": \"20\"\n },\n {\n \"content\": \".. module:: itsdangerous.url_safe\\n\\nURL Safe Serialization\\n======================\\n\\nOften it is helpful if you can pass these trusted strings in places\\nwhere you only have a limited set of characters available. Because of\\nthis, ItsDangerous also provides URL safe serializers:\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\\n s.loads(\\\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\\\")\\n [1, 2, 3, 4]\\n\\n.. autoclass:: URLSafeSerializer\\n\\n.. autoclass:: URLSafeTimedSerializer\\n\\n[end of docs/url_safe.rst]\",\n \"filename\": \"docs/url_safe.rst\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. module:: itsdangerous.encoding\\n\\nEncoding Utilities\\n==================\\n\\n.. autofunction:: base64_encode\\n\\n.. autofunction:: base64_decode\\n\\n[end of docs/encoding.rst]\",\n \"filename\": \"docs/encoding.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"# Minimal makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nSOURCEDIR = .\\nBUILDDIR = _build\\n\\n# Put it first so that \\\"make\\\" without argument is like \\\"make help\\\".\\nhelp:\\n\\t@$(SPHINXBUILD) -M help \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n.PHONY: help Makefile\\n\\n# Catch-all target: route all unknown targets to Sphinx using the new\\n# \\\"make mode\\\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\\n%: Makefile\\n\\t@$(SPHINXBUILD) -M $@ \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"23\"\n },\n {\n \"content\": \"from pallets_sphinx_themes import get_version\\nfrom pallets_sphinx_themes import ProjectLink\\n\\n# Project --------------------------------------------------------------\\n\\nproject = \\\"ItsDangerous\\\"\\ncopyright = \\\"2011 Pallets\\\"\\nauthor = \\\"Pallets\\\"\\nrelease, version = get_version(\\\"itsdangerous\\\")\\n\\n# General --------------------------------------------------------------\\n\\ndefault_role = \\\"code\\\"\\nextensions = [\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"sphinx.ext.extlinks\\\",\\n \\\"sphinx.ext.intersphinx\\\",\\n \\\"sphinxcontrib.log_cabinet\\\",\\n \\\"pallets_sphinx_themes\\\",\\n]\\nautoclass_content = \\\"both\\\"\\nautodoc_member_order = \\\"bysource\\\"\\nautodoc_typehints = \\\"description\\\"\\nautodoc_preserve_defaults = True\\nextlinks = {\\n \\\"issue\\\": (\\\"https://github.com/pallets/itsdangerous/issues/%s\\\", \\\"#%s\\\"),\\n \\\"pr\\\": (\\\"https://github.com/pallets/itsdangerous/pull/%s\\\", \\\"#%s\\\"),\\n}\\nintersphinx_mapping = {\\n \\\"python\\\": (\\\"https://docs.python.org/3/\\\", None),\\n}\\n\\n# HTML -----------------------------------------------------------------\\n\\nhtml_theme = \\\"flask\\\"\\nhtml_theme_options = {\\\"index_sidebar_logo\\\": False}\\nhtml_context = {\\n \\\"project_links\\\": [\\n ProjectLink(\\\"Donate\\\", \\\"https://palletsprojects.com/donate\\\"),\\n ProjectLink(\\\"PyPI Releases\\\", \\\"https://pypi.org/project/itsdangerous/\\\"),\\n ProjectLink(\\\"Source Code\\\", \\\"https://github.com/pallets/itsdangerous/\\\"),\\n ProjectLink(\\\"Issue Tracker\\\", \\\"https://github.com/pallets/itsdangerous/issues/\\\"),\\n ProjectLink(\\\"Chat\\\", \\\"https://discord.gg/pallets\\\"),\\n ]\\n}\\nhtml_sidebars = {\\n \\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n \\\"**\\\": [\\\"localtoc.html\\\", \\\"relations.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n}\\nsinglehtml_sidebars = {\\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"ethicalads.html\\\"]}\\nhtml_static_path = [\\\"_static\\\"]\\nhtml_favicon = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_logo = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_title = f\\\"{project} Documentation ({version})\\\"\\nhtml_show_sourcelink = False\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\npushd %~dp0\\n\\nREM Command file for Sphinx documentation\\n\\nif \\\"%SPHINXBUILD%\\\" == \\\"\\\" (\\n\\tset SPHINXBUILD=sphinx-build\\n)\\nset SOURCEDIR=.\\nset BUILDDIR=_build\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\n%SPHINXBUILD% >NUL 2>NUL\\nif errorlevel 9009 (\\n\\techo.\\n\\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\\n\\techo.installed, then set the SPHINXBUILD environment variable to point\\n\\techo.to the full path of the 'sphinx-build' executable. Alternatively you\\n\\techo.may add the Sphinx directory to PATH.\\n\\techo.\\n\\techo.If you don't have Sphinx installed, grab it from\\n\\techo.http://sphinx-doc.org/\\n\\texit /b 1\\n)\\n\\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\ngoto end\\n\\n:help\\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\n\\n:end\\npopd\\n\\n[end of docs/make.bat]\",\n \"filename\": \"docs/make.bat\",\n \"id\": \"25\"\n },\n {\n \"content\": \".. module:: itsdangerous.timed\\n\\nSigning With Timestamps\\n=======================\\n\\nIf you want to expire signatures you can use the\\n:class:`TimestampSigner` class which adds timestamp information and\\nsigns it. On unsigning you can validate that the timestamp is not older\\nthan a given age.\\n\\n.. code-block:: python\\n\\n from itsdangerous import TimestampSigner\\n s = TimestampSigner('secret-key')\\n string = s.sign('foo')\\n\\n.. code-block:: python\\n\\n s.unsign(string, max_age=5)\\n Traceback (most recent call last):\\n ...\\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\\n\\n.. autoclass:: TimestampSigner\\n :members:\\n\\n.. autoclass:: TimedSerializer\\n :members:\\n\\n[end of docs/timed.rst]\",\n \"filename\": \"docs/timed.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"BSD-3-Clause License\\n====================\\n\\n.. literalinclude:: ../LICENSE.txt\\n :language: text\\n\\n[end of docs/license.rst]\",\n \"filename\": \"docs/license.rst\",\n \"id\": \"27\"\n },\n {\n \"content\": \"Changes\\n=======\\n\\n.. include:: ../CHANGES.rst\\n\\n[end of docs/changes.rst]\",\n \"filename\": \"docs/changes.rst\",\n \"id\": \"28\"\n },\n {\n \"content\": \".. module:: itsdangerous.exc\\n\\nExceptions\\n==========\\n\\n.. autoexception:: BadData\\n :members:\\n\\n.. autoexception:: BadSignature\\n :members:\\n\\n.. autoexception:: BadTimeSignature\\n :members:\\n\\n.. autoexception:: SignatureExpired\\n :members:\\n\\n.. autoexception:: BadHeader\\n :members:\\n\\n.. autoexception:: BadPayload\\n :members:\\n\\n[end of docs/exceptions.rst]\",\n \"filename\": \"docs/exceptions.rst\",\n \"id\": \"29\"\n },\n {\n \"content\": \"#!/bin/bash\\nset -e\\npython3 -m venv --upgrade-deps .venv\\n. .venv/bin/activate\\npip install -r requirements/dev.txt\\npip install -e .\\npre-commit install --install-hooks\\n\\n[end of .devcontainer/on-create-command.sh]\",\n \"filename\": \".devcontainer/on-create-command.sh\",\n \"id\": \"30\"\n },\n {\n \"content\": \"{\\n \\\"name\\\": \\\"pallets/itsdangerous\\\",\\n \\\"image\\\": \\\"mcr.microsoft.com/devcontainers/python:3\\\",\\n \\\"customizations\\\": {\\n \\\"vscode\\\": {\\n \\\"settings\\\": {\\n \\\"python.defaultInterpreterPath\\\": \\\"${workspaceFolder}/.venv\\\",\\n \\\"python.terminal.activateEnvInCurrentTerminal\\\": true,\\n \\\"python.terminal.launchArgs\\\": [\\n \\\"-X\\\",\\n \\\"dev\\\"\\n ]\\n }\\n }\\n },\\n \\\"onCreateCommand\\\": \\\".devcontainer/on-create-command.sh\\\"\\n}\\n\\n[end of .devcontainer/devcontainer.json]\",\n \"filename\": \".devcontainer/devcontainer.json\",\n \"id\": \"31\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo-sidebar.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo-sidebar.png\",\n \"id\": \"32\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo.png\",\n \"id\": \"33\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport json as _json\\nimport typing as t\\n\\n\\nclass _CompactJSON:\\n \\\"\\\"\\\"Wrapper around json module that strips whitespace.\\\"\\\"\\\"\\n\\n @staticmethod\\n def loads(payload: str | bytes) -> t.Any:\\n return _json.loads(payload)\\n\\n @staticmethod\\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\\n kwargs.setdefault(\\\"ensure_ascii\\\", False)\\n kwargs.setdefault(\\\"separators\\\", (\\\",\\\", \\\":\\\"))\\n return _json.dumps(obj, **kwargs)\\n\\n[end of src/itsdangerous/_json.py]\",\n \"filename\": \"src/itsdangerous/_json.py\",\n \"id\": \"34\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport time\\nimport typing as t\\nfrom datetime import datetime\\nfrom datetime import timezone\\n\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import bytes_to_int\\nfrom .encoding import int_to_bytes\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\nfrom .exc import BadTimeSignature\\nfrom .exc import SignatureExpired\\nfrom .serializer import _TSerialized\\nfrom .serializer import Serializer\\nfrom .signer import Signer\\n\\n\\nclass TimestampSigner(Signer):\\n \\\"\\\"\\\"Works like the regular :class:`.Signer` but also records the time\\n of the signing and can be used to expire signatures. The\\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\\n unsigning failed because the signature is expired.\\n \\\"\\\"\\\"\\n\\n def get_timestamp(self) -> int:\\n \\\"\\\"\\\"Returns the current timestamp. The function must return an\\n integer.\\n \\\"\\\"\\\"\\n return int(time.time())\\n\\n def timestamp_to_datetime(self, ts: int) -> datetime:\\n \\\"\\\"\\\"Convert the timestamp from :meth:`get_timestamp` into an\\n aware :class`datetime.datetime` in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n return datetime.fromtimestamp(ts, tz=timezone.utc)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string and also attaches time information.\\\"\\\"\\\"\\n value = want_bytes(value)\\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\\n sep = want_bytes(self.sep)\\n value = value + sep + timestamp\\n return value + sep + self.get_signature(value)\\n\\n # Ignore overlapping signatures check, return_timestamp is the only\\n # parameter that affects the return type.\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[False] = False,\\n ) -> bytes: ...\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[True] = True,\\n ) -> tuple[bytes, datetime]: ...\\n\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n ) -> tuple[bytes, datetime] | bytes:\\n \\\"\\\"\\\"Works like the regular :meth:`.Signer.unsign` but can also\\n validate the time. See the base docstring of the class for\\n the general behavior. If ``return_timestamp`` is ``True`` the\\n timestamp of the signature will be returned as an aware\\n :class:`datetime.datetime` object in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n try:\\n result = super().unsign(signed_value)\\n sig_error = None\\n except BadSignature as e:\\n sig_error = e\\n result = e.payload or b\\\"\\\"\\n\\n sep = want_bytes(self.sep)\\n\\n # If there is no timestamp in the result there is something\\n # seriously wrong. In case there was a signature error, we raise\\n # that one directly, otherwise we have a weird situation in\\n # which we shouldn't have come except someone uses a time-based\\n # serializer on non-timestamp data, so catch that.\\n if sep not in result:\\n if sig_error:\\n raise sig_error\\n\\n raise BadTimeSignature(\\\"timestamp missing\\\", payload=result)\\n\\n value, ts_bytes = result.rsplit(sep, 1)\\n ts_int: int | None = None\\n ts_dt: datetime | None = None\\n\\n try:\\n ts_int = bytes_to_int(base64_decode(ts_bytes))\\n except Exception:\\n pass\\n\\n # Signature is *not* okay. Raise a proper error now that we have\\n # split the value and the timestamp.\\n if sig_error is not None:\\n if ts_int is not None:\\n try:\\n ts_dt = self.timestamp_to_datetime(ts_int)\\n except (ValueError, OSError, OverflowError) as exc:\\n # Windows raises OSError\\n # 32-bit raises OverflowError\\n raise BadTimeSignature(\\n \\\"Malformed timestamp\\\", payload=value\\n ) from exc\\n\\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\\n\\n # Signature was okay but the timestamp is actually not there or\\n # malformed. Should not happen, but we handle it anyway.\\n if ts_int is None:\\n raise BadTimeSignature(\\\"Malformed timestamp\\\", payload=value)\\n\\n # Check timestamp is not older than max_age\\n if max_age is not None:\\n age = self.get_timestamp() - ts_int\\n\\n if age > max_age:\\n raise SignatureExpired(\\n f\\\"Signature age {age} > {max_age} seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if age < 0:\\n raise SignatureExpired(\\n f\\\"Signature age {age} < 0 seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if return_timestamp:\\n return value, self.timestamp_to_datetime(ts_int)\\n\\n return value\\n\\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\\"\\\"\\\"\\n try:\\n self.unsign(signed_value, max_age=max_age)\\n return True\\n except BadSignature:\\n return False\\n\\n\\nclass TimedSerializer(Serializer[_TSerialized]):\\n \\\"\\\"\\\"Uses :class:`TimestampSigner` instead of the default\\n :class:`.Signer`.\\n \\\"\\\"\\\"\\n\\n default_signer: type[TimestampSigner] = TimestampSigner\\n\\n def iter_unsigners(\\n self, salt: str | bytes | None = None\\n ) -> cabc.Iterator[TimestampSigner]:\\n return t.cast(\\\"cabc.Iterator[TimestampSigner]\\\", super().iter_unsigners(salt))\\n\\n # TODO: Signature is incompatible because parameters were added\\n # before salt.\\n\\n def loads( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n salt: str | bytes | None = None,\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\\n signature validation fails. If a ``max_age`` is provided it will\\n ensure the signature is not older than that time in seconds. In\\n case the signature is outdated, :exc:`.SignatureExpired` is\\n raised. All arguments are forwarded to the signer's\\n :meth:`~TimestampSigner.unsign` method.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n base64d, timestamp = signer.unsign(\\n s, max_age=max_age, return_timestamp=True\\n )\\n payload = self.load_payload(base64d)\\n\\n if return_timestamp:\\n return payload, timestamp\\n\\n return payload\\n except SignatureExpired:\\n # The signature was unsigned successfully but was\\n # expired. Do not try the next signer.\\n raise\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def loads_unsafe( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n salt: str | bytes | None = None,\\n ) -> tuple[bool, t.Any]:\\n return self._loads_unsafe_impl(s, salt, load_kwargs={\\\"max_age\\\": max_age})\\n\\n[end of src/itsdangerous/timed.py]\",\n \"filename\": \"src/itsdangerous/timed.py\",\n \"id\": \"35\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport base64\\nimport string\\nimport struct\\nimport typing as t\\n\\nfrom .exc import BadData\\n\\n\\ndef want_bytes(\\n s: str | bytes, encoding: str = \\\"utf-8\\\", errors: str = \\\"strict\\\"\\n) -> bytes:\\n if isinstance(s, str):\\n s = s.encode(encoding, errors)\\n\\n return s\\n\\n\\ndef base64_encode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 encode a string of bytes or text. The resulting bytes are\\n safe to use in URLs.\\n \\\"\\\"\\\"\\n string = want_bytes(string)\\n return base64.urlsafe_b64encode(string).rstrip(b\\\"=\\\")\\n\\n\\ndef base64_decode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 decode a URL-safe string of bytes or text. The result is\\n bytes.\\n \\\"\\\"\\\"\\n string = want_bytes(string, encoding=\\\"ascii\\\", errors=\\\"ignore\\\")\\n string += b\\\"=\\\" * (-len(string) % 4)\\n\\n try:\\n return base64.urlsafe_b64decode(string)\\n except (TypeError, ValueError) as e:\\n raise BadData(\\\"Invalid base64-encoded data\\\") from e\\n\\n\\n# The alphabet used by base64.urlsafe_*\\n_base64_alphabet = f\\\"{string.ascii_letters}{string.digits}-_=\\\".encode(\\\"ascii\\\")\\n\\n_int64_struct = struct.Struct(\\\">Q\\\")\\n_int_to_bytes = _int64_struct.pack\\n_bytes_to_int = t.cast(\\\"t.Callable[[bytes], tuple[int]]\\\", _int64_struct.unpack)\\n\\n\\ndef int_to_bytes(num: int) -> bytes:\\n return _int_to_bytes(num).lstrip(b\\\"\\\\x00\\\")\\n\\n\\ndef bytes_to_int(bytestr: bytes) -> int:\\n return _bytes_to_int(bytestr.rjust(8, b\\\"\\\\x00\\\"))[0]\\n\\n[end of src/itsdangerous/encoding.py]\",\n \"filename\": \"src/itsdangerous/encoding.py\",\n \"id\": \"36\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\n\\nfrom .encoding import base64_decode as base64_decode\\nfrom .encoding import base64_encode as base64_encode\\nfrom .encoding import want_bytes as want_bytes\\nfrom .exc import BadData as BadData\\nfrom .exc import BadHeader as BadHeader\\nfrom .exc import BadPayload as BadPayload\\nfrom .exc import BadSignature as BadSignature\\nfrom .exc import BadTimeSignature as BadTimeSignature\\nfrom .exc import SignatureExpired as SignatureExpired\\nfrom .serializer import Serializer as Serializer\\nfrom .signer import HMACAlgorithm as HMACAlgorithm\\nfrom .signer import NoneAlgorithm as NoneAlgorithm\\nfrom .signer import Signer as Signer\\nfrom .timed import TimedSerializer as TimedSerializer\\nfrom .timed import TimestampSigner as TimestampSigner\\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\\n\\n\\ndef __getattr__(name: str) -> t.Any:\\n if name == \\\"__version__\\\":\\n import importlib.metadata\\n import warnings\\n\\n warnings.warn(\\n \\\"The '__version__' attribute is deprecated and will be removed in\\\"\\n \\\" ItsDangerous 2.3. Use feature detection or\\\"\\n \\\" 'importlib.metadata.version(\\\\\\\"itsdangerous\\\\\\\")' instead.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return importlib.metadata.version(\\\"itsdangerous\\\")\\n\\n raise AttributeError(name)\\n\\n[end of src/itsdangerous/__init__.py]\",\n \"filename\": \"src/itsdangerous/__init__.py\",\n \"id\": \"37\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nimport zlib\\n\\nfrom ._json import _CompactJSON\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .exc import BadPayload\\nfrom .serializer import _PDataSerializer\\nfrom .serializer import Serializer\\nfrom .timed import TimedSerializer\\n\\n\\nclass URLSafeSerializerMixin(Serializer[str]):\\n \\\"\\\"\\\"Mixed in with a regular serializer it will attempt to zlib\\n compress the string to make it shorter if necessary. It will also\\n base64 encode the string so that it can safely be placed in a URL.\\n \\\"\\\"\\\"\\n\\n default_serializer: _PDataSerializer[str] = _CompactJSON\\n\\n def load_payload(\\n self,\\n payload: bytes,\\n *args: t.Any,\\n serializer: t.Any | None = None,\\n **kwargs: t.Any,\\n ) -> t.Any:\\n decompress = False\\n\\n if payload.startswith(b\\\".\\\"):\\n payload = payload[1:]\\n decompress = True\\n\\n try:\\n json = base64_decode(payload)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not base64 decode the payload because of an exception\\\",\\n original_error=e,\\n ) from e\\n\\n if decompress:\\n try:\\n json = zlib.decompress(json)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not zlib decompress the payload before decoding the payload\\\",\\n original_error=e,\\n ) from e\\n\\n return super().load_payload(json, *args, **kwargs)\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n json = super().dump_payload(obj)\\n is_compressed = False\\n compressed = zlib.compress(json)\\n\\n if len(compressed) < (len(json) - 1):\\n json = compressed\\n is_compressed = True\\n\\n base64d = base64_encode(json)\\n\\n if is_compressed:\\n base64d = b\\\".\\\" + base64d\\n\\n return base64d\\n\\n\\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\\n \\\"\\\"\\\"Works like :class:`.Serializer` but dumps and loads into a URL\\n safe string consisting of the upper and lowercase character of the\\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n\\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\\n \\\"\\\"\\\"Works like :class:`.TimedSerializer` but dumps and loads into a\\n URL safe string consisting of the upper and lowercase character of\\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n[end of src/itsdangerous/url_safe.py]\",\n \"filename\": \"src/itsdangerous/url_safe.py\",\n \"id\": \"38\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nfrom datetime import datetime\\n\\n\\nclass BadData(Exception):\\n \\\"\\\"\\\"Raised if bad data of any sort was encountered. This is the base\\n for all exceptions that ItsDangerous defines.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str):\\n super().__init__(message)\\n self.message = message\\n\\n def __str__(self) -> str:\\n return self.message\\n\\n\\nclass BadSignature(BadData):\\n \\\"\\\"\\\"Raised if a signature does not match.\\\"\\\"\\\"\\n\\n def __init__(self, message: str, payload: t.Any | None = None):\\n super().__init__(message)\\n\\n #: The payload that failed the signature test. In some\\n #: situations you might still want to inspect this, even if\\n #: you know it was tampered with.\\n #:\\n #: .. versionadded:: 0.14\\n self.payload: t.Any | None = payload\\n\\n\\nclass BadTimeSignature(BadSignature):\\n \\\"\\\"\\\"Raised if a time-based signature is invalid. This is a subclass\\n of :class:`BadSignature`.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n date_signed: datetime | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the signature expired this exposes the date of when the\\n #: signature was created. This can be helpful in order to\\n #: tell the user how long a link has been gone stale.\\n #:\\n #: .. versionchanged:: 2.0\\n #: The datetime value is timezone-aware rather than naive.\\n #:\\n #: .. versionadded:: 0.14\\n self.date_signed = date_signed\\n\\n\\nclass SignatureExpired(BadTimeSignature):\\n \\\"\\\"\\\"Raised if a signature timestamp is older than ``max_age``. This\\n is a subclass of :exc:`BadTimeSignature`.\\n \\\"\\\"\\\"\\n\\n\\nclass BadHeader(BadSignature):\\n \\\"\\\"\\\"Raised if a signed header is invalid in some form. This only\\n happens for serializers that have a header that goes with the\\n signature.\\n\\n .. versionadded:: 0.24\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n header: t.Any | None = None,\\n original_error: Exception | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the header is actually available but just malformed it\\n #: might be stored here.\\n self.header: t.Any | None = header\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n\\nclass BadPayload(BadData):\\n \\\"\\\"\\\"Raised if a payload is invalid. This could happen if the payload\\n is loaded despite an invalid signature, or if there is a mismatch\\n between the serializer and deserializer. The original exception\\n that occurred during loading is stored on as :attr:`original_error`.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str, original_error: Exception | None = None):\\n super().__init__(message)\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n[end of src/itsdangerous/exc.py]\",\n \"filename\": \"src/itsdangerous/exc.py\",\n \"id\": \"39\"\n },\n {\n \"content\": \"[end of src/itsdangerous/py.typed]\",\n \"filename\": \"src/itsdangerous/py.typed\",\n \"id\": \"40\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport json\\nimport typing as t\\n\\nfrom .encoding import want_bytes\\nfrom .exc import BadPayload\\nfrom .exc import BadSignature\\nfrom .signer import _make_keys_list\\nfrom .signer import Signer\\n\\nif t.TYPE_CHECKING:\\n import typing_extensions as te\\n\\n # This should be either be str or bytes. To avoid having to specify the\\n # bound type, it falls back to a union if structural matching fails.\\n _TSerialized = te.TypeVar(\\n \\\"_TSerialized\\\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\\n )\\nelse:\\n # Still available at runtime on Python < 3.13, but without the default.\\n _TSerialized = t.TypeVar(\\\"_TSerialized\\\", bound=t.Union[str, bytes])\\n\\n\\nclass _PDataSerializer(t.Protocol[_TSerialized]):\\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\\n # A signature with additional arguments is not handled correctly by type\\n # checkers right now, so an overload is used below for serializers that\\n # don't match this strict protocol.\\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\\n\\n\\n# Use TypeIs once it's available in typing_extensions or 3.13.\\ndef is_text_serializer(\\n serializer: _PDataSerializer[t.Any],\\n) -> te.TypeGuard[_PDataSerializer[str]]:\\n \\\"\\\"\\\"Checks whether a serializer generates text or binary.\\\"\\\"\\\"\\n return isinstance(serializer.dumps({}), str)\\n\\n\\nclass Serializer(t.Generic[_TSerialized]):\\n \\\"\\\"\\\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\\n enable serializing and securely signing data other than bytes. It\\n can unsign to verify that the data hasn't been changed.\\n\\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\\n :mod:`json`, and by default uses :mod:`json` internally to serialize\\n the data to bytes.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param serializer: An object that provides ``dumps`` and ``loads``\\n methods for serializing data to a string. Defaults to\\n :attr:`default_serializer`, which defaults to :mod:`json`.\\n :param serializer_kwargs: Keyword arguments to pass when calling\\n ``serializer.dumps``.\\n :param signer: A ``Signer`` class to instantiate when signing data.\\n Defaults to :attr:`default_signer`, which defaults to\\n :class:`~itsdangerous.signer.Signer`.\\n :param signer_kwargs: Keyword arguments to pass when instantiating\\n the ``Signer`` class.\\n :param fallback_signers: List of signer parameters to try when\\n unsigning with the default signer fails. Each item can be a dict\\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\\n ``(signer, signer_kwargs)``. Defaults to\\n :attr:`default_fallback_signers`.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 2.0\\n Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``.\\n\\n .. versionchanged:: 1.1\\n Added support for ``fallback_signers`` and configured a default\\n SHA-512 fallback. This fallback is for users who used the yanked\\n 1.0.0 release which defaulted to SHA-512.\\n\\n .. versionchanged:: 0.14\\n The ``signer`` and ``signer_kwargs`` parameters were added to\\n the constructor.\\n \\\"\\\"\\\"\\n\\n #: The default serialization module to use to serialize data to a\\n #: string internally. The default is :mod:`json`, but can be changed\\n #: to any object that provides ``dumps`` and ``loads`` methods.\\n default_serializer: _PDataSerializer[t.Any] = json\\n\\n #: The default ``Signer`` class to instantiate when signing data.\\n #: The default is :class:`itsdangerous.signer.Signer`.\\n default_signer: type[Signer] = Signer\\n\\n #: The default fallback signers to try when unsigning fails.\\n default_fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = []\\n\\n # Serializer[str] if no data serializer is provided, or if it returns str.\\n @t.overload\\n def __init__(\\n self: Serializer[str],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: None | _PDataSerializer[str] = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer positional argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer keyword argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a positional argument. If the strict signature of\\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\\n # to specify the type.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a keyword argument.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: t.Any | None = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n # if salt is None then the signer's default is used\\n\\n self.salt = salt\\n\\n if serializer is None:\\n serializer = self.default_serializer\\n\\n self.serializer: _PDataSerializer[_TSerialized] = serializer\\n self.is_text_serializer: bool = is_text_serializer(serializer)\\n\\n if signer is None:\\n signer = self.default_signer\\n\\n self.signer: type[Signer] = signer\\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\\n\\n if fallback_signers is None:\\n fallback_signers = list(self.default_fallback_signers)\\n\\n self.fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = fallback_signers\\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def load_payload(\\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\\n ) -> t.Any:\\n \\\"\\\"\\\"Loads the encoded object. This function raises\\n :class:`.BadPayload` if the payload is not valid. The\\n ``serializer`` parameter can be used to override the serializer\\n stored on the class. The encoded ``payload`` should always be\\n bytes.\\n \\\"\\\"\\\"\\n if serializer is None:\\n use_serializer = self.serializer\\n is_text = self.is_text_serializer\\n else:\\n use_serializer = serializer\\n is_text = is_text_serializer(serializer)\\n\\n try:\\n if is_text:\\n return use_serializer.loads(payload.decode(\\\"utf-8\\\")) # type: ignore[arg-type]\\n\\n return use_serializer.loads(payload) # type: ignore[arg-type]\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not load the payload because an exception\\\"\\n \\\" occurred on unserializing the data.\\\",\\n original_error=e,\\n ) from e\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n \\\"\\\"\\\"Dumps the encoded object. The return value is always bytes.\\n If the internal serializer returns text, the value will be\\n encoded as UTF-8.\\n \\\"\\\"\\\"\\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\\n\\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\\n \\\"\\\"\\\"Creates a new instance of the signer to be used. The default\\n implementation uses the :class:`.Signer` base class.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\\n\\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\\n \\\"\\\"\\\"Iterates over all signers to be tried for unsigning. Starts\\n with the configured signer, then constructs each signer\\n specified in ``fallback_signers``.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n yield self.make_signer(salt)\\n\\n for fallback in self.fallback_signers:\\n if isinstance(fallback, dict):\\n kwargs = fallback\\n fallback = self.signer\\n elif isinstance(fallback, tuple):\\n fallback, kwargs = fallback\\n else:\\n kwargs = self.signer_kwargs\\n\\n for secret_key in self.secret_keys:\\n yield fallback(secret_key, salt=salt, **kwargs)\\n\\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\\n \\\"\\\"\\\"Returns a signed string serialized with the internal\\n serializer. The return value can be either a byte or unicode\\n string depending on the format of the internal serializer.\\n \\\"\\\"\\\"\\n payload = want_bytes(self.dump_payload(obj))\\n rv = self.make_signer(salt).sign(payload)\\n\\n if self.is_text_serializer:\\n return rv.decode(\\\"utf-8\\\") # type: ignore[return-value]\\n\\n return rv # type: ignore[return-value]\\n\\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\\n \\\"\\\"\\\"Like :meth:`dumps` but dumps into a file. The file handle has\\n to be compatible with what the internal serializer expects.\\n \\\"\\\"\\\"\\n f.write(self.dumps(obj, salt))\\n\\n def loads(\\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\\n signature validation fails.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n return self.load_payload(signer.unsign(s))\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\\n \\\"\\\"\\\"Like :meth:`loads` but loads from a file.\\\"\\\"\\\"\\n return self.loads(f.read(), salt)\\n\\n def loads_unsafe(\\n self, s: str | bytes, salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads` but without verifying the signature. This\\n is potentially very dangerous to use depending on how your\\n serializer works. The return value is ``(signature_valid,\\n payload)`` instead of just the payload. The first item will be a\\n boolean that indicates if the signature is valid. This function\\n never fails.\\n\\n Use it for debugging only and if you know that your serializer\\n module is not exploitable (for example, do not use it with a\\n pickle serializer).\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self._loads_unsafe_impl(s, salt)\\n\\n def _loads_unsafe_impl(\\n self,\\n s: str | bytes,\\n salt: str | bytes | None,\\n load_kwargs: dict[str, t.Any] | None = None,\\n load_payload_kwargs: dict[str, t.Any] | None = None,\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Low level helper function to implement :meth:`loads_unsafe`\\n in serializer subclasses.\\n \\\"\\\"\\\"\\n if load_kwargs is None:\\n load_kwargs = {}\\n\\n try:\\n return True, self.loads(s, salt=salt, **load_kwargs)\\n except BadSignature as e:\\n if e.payload is None:\\n return False, None\\n\\n if load_payload_kwargs is None:\\n load_payload_kwargs = {}\\n\\n try:\\n return (\\n False,\\n self.load_payload(e.payload, **load_payload_kwargs),\\n )\\n except BadPayload:\\n return False, None\\n\\n def load_unsafe(\\n self, f: t.IO[t.Any], salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads_unsafe` but loads from a file.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self.loads_unsafe(f.read(), salt=salt)\\n\\n[end of src/itsdangerous/serializer.py]\",\n \"filename\": \"src/itsdangerous/serializer.py\",\n \"id\": \"41\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport hashlib\\nimport hmac\\nimport typing as t\\n\\nfrom .encoding import _base64_alphabet\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\n\\n\\nclass SigningAlgorithm:\\n \\\"\\\"\\\"Subclasses must implement :meth:`get_signature` to provide\\n signature generation functionality.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given key and value.\\\"\\\"\\\"\\n raise NotImplementedError()\\n\\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\\n \\\"\\\"\\\"Verifies the given signature matches the expected\\n signature.\\n \\\"\\\"\\\"\\n return hmac.compare_digest(sig, self.get_signature(key, value))\\n\\n\\nclass NoneAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides an algorithm that does not perform any signing and\\n returns an empty signature.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n return b\\\"\\\"\\n\\n\\ndef _lazy_sha1(string: bytes = b\\\"\\\") -> t.Any:\\n \\\"\\\"\\\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\\n SHA-1, in which case the import and use as a default would fail before the\\n developer can configure something else.\\n \\\"\\\"\\\"\\n return hashlib.sha1(string)\\n\\n\\nclass HMACAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides signature generation using HMACs.\\\"\\\"\\\"\\n\\n #: The digest method to use with the MAC algorithm. This defaults to\\n #: SHA1, but can be changed to any other function in the hashlib\\n #: module.\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n def __init__(self, digest_method: t.Any = None):\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\\n return mac.digest()\\n\\n\\ndef _make_keys_list(\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n) -> list[bytes]:\\n if isinstance(secret_key, (str, bytes)):\\n return [want_bytes(secret_key)]\\n\\n return [want_bytes(s) for s in secret_key] # pyright: ignore\\n\\n\\nclass Signer:\\n \\\"\\\"\\\"A signer securely signs bytes, then unsigns them to verify that\\n the value hasn't been changed.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param sep: Separator between the signature and value.\\n :param key_derivation: How to derive the signing key from the secret\\n key and salt. Possible values are ``concat``, ``django-concat``,\\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\\n defaults to ``django-concat``.\\n :param digest_method: Hash function to use when generating the HMAC\\n signature. Defaults to :attr:`default_digest_method`, which\\n defaults to :func:`hashlib.sha1`. Note that the security of the\\n hash alone doesn't apply when used intermediately in HMAC.\\n :param algorithm: A :class:`SigningAlgorithm` instance to use\\n instead of building a default :class:`HMACAlgorithm` with the\\n ``digest_method``.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 0.18\\n ``algorithm`` was added as an argument to the class constructor.\\n\\n .. versionchanged:: 0.14\\n ``key_derivation`` and ``digest_method`` were added as arguments\\n to the class constructor.\\n \\\"\\\"\\\"\\n\\n #: The default digest method to use for the signer. The default is\\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\\n #: compatible object. Note that the security of the hash alone\\n #: doesn't apply when used intermediately in HMAC.\\n #:\\n #: .. versionadded:: 0.14\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n #: The default scheme to use to derive the signing key from the\\n #: secret key and salt. The default is ``django-concat``. Possible\\n #: values are ``concat``, ``django-concat``, and ``hmac``.\\n #:\\n #: .. versionadded:: 0.14\\n default_key_derivation: str = \\\"django-concat\\\"\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous.Signer\\\",\\n sep: str | bytes = b\\\".\\\",\\n key_derivation: str | None = None,\\n digest_method: t.Any | None = None,\\n algorithm: SigningAlgorithm | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n self.sep: bytes = want_bytes(sep)\\n\\n if self.sep in _base64_alphabet:\\n raise ValueError(\\n \\\"The given separator cannot be used because it may be\\\"\\n \\\" contained in the signature itself. ASCII letters,\\\"\\n \\\" digits, and '-_=' must not be used.\\\"\\n )\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n else:\\n salt = b\\\"itsdangerous.Signer\\\"\\n\\n self.salt = salt\\n\\n if key_derivation is None:\\n key_derivation = self.default_key_derivation\\n\\n self.key_derivation: str = key_derivation\\n\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n if algorithm is None:\\n algorithm = HMACAlgorithm(self.digest_method)\\n\\n self.algorithm: SigningAlgorithm = algorithm\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\\n \\\"\\\"\\\"This method is called to derive the key. The default key\\n derivation choices can be overridden here. Key derivation is not\\n intended to be used as a security method to make a complex key\\n out of a short password. Instead you should use large random\\n secret keys.\\n\\n :param secret_key: A specific secret key to derive from.\\n Defaults to the last item in :attr:`secret_keys`.\\n\\n .. versionchanged:: 2.0\\n Added the ``secret_key`` parameter.\\n \\\"\\\"\\\"\\n if secret_key is None:\\n secret_key = self.secret_keys[-1]\\n else:\\n secret_key = want_bytes(secret_key)\\n\\n if self.key_derivation == \\\"concat\\\":\\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\\n elif self.key_derivation == \\\"django-concat\\\":\\n return t.cast(\\n bytes, self.digest_method(self.salt + b\\\"signer\\\" + secret_key).digest()\\n )\\n elif self.key_derivation == \\\"hmac\\\":\\n mac = hmac.new(secret_key, digestmod=self.digest_method)\\n mac.update(self.salt)\\n return mac.digest()\\n elif self.key_derivation == \\\"none\\\":\\n return secret_key\\n else:\\n raise TypeError(\\\"Unknown key derivation method\\\")\\n\\n def get_signature(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given value.\\\"\\\"\\\"\\n value = want_bytes(value)\\n key = self.derive_key()\\n sig = self.algorithm.get_signature(key, value)\\n return base64_encode(sig)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string.\\\"\\\"\\\"\\n value = want_bytes(value)\\n return value + self.sep + self.get_signature(value)\\n\\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\\n \\\"\\\"\\\"Verifies the signature for the given value.\\\"\\\"\\\"\\n try:\\n sig = base64_decode(sig)\\n except Exception:\\n return False\\n\\n value = want_bytes(value)\\n\\n for secret_key in reversed(self.secret_keys):\\n key = self.derive_key(secret_key)\\n\\n if self.algorithm.verify_signature(key, value, sig):\\n return True\\n\\n return False\\n\\n def unsign(self, signed_value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Unsigns the given string.\\\"\\\"\\\"\\n signed_value = want_bytes(signed_value)\\n\\n if self.sep not in signed_value:\\n raise BadSignature(f\\\"No {self.sep!r} found in value\\\")\\n\\n value, sig = signed_value.rsplit(self.sep, 1)\\n\\n if self.verify_signature(value, sig):\\n return value\\n\\n raise BadSignature(f\\\"Signature {sig!r} does not match\\\", payload=value)\\n\\n def validate(self, signed_value: str | bytes) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\n \\\"\\\"\\\"\\n try:\\n self.unsign(signed_value)\\n return True\\n except BadSignature:\\n return False\\n\\n[end of src/itsdangerous/signer.py]\",\n \"filename\": \"src/itsdangerous/signer.py\",\n \"id\": \"42\"\n }\n]","isConversational":false}}},{"rowIdx":75,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 75,\n \"num_files\": 43,\n \"repo_id\": \"repo_0075\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerous itself. Use\none of the following resources for questions about using ItsDangerous or\nissues with your own code:\n\n- The ``#get-help`` channel on our Discord chat:\n https://discord.gg/pallets\n- The mailing list flask@python.org for long term discussion or larger\n issues.\n- Ask on `Stack Overflow`_. Search with Google first using:\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\n\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\n\n\nReporting issues\n----------------\n\nInclude the following information in your post:\n\n- Describe what you expected to happen.\n- If possible, include a `minimal reproducible example`_ to help us\n identify the issue. This also helps check that the issue is not with\n your own code.\n- Describe what actually happened. Include the full traceback if there\n was an exception.\n- List your Python and ItsDangerous versions. If possible, check if\n this issue is already fixed in the latest releases or the latest\n code in the repository.\n\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\n\n\nSubmitting patches\n------------------\n\nIf there is not an open issue for what you want to submit, prefer\nopening one for discussion before working on a PR. You can work on any\nissue that doesn't have an open PR linked to it or a maintainer assigned\nto it. These show up in the sidebar. No need to ask if you can work on\nan issue that interests you.\n\nInclude the following in your patch:\n\n- Use `Black`_ to format your code. This and other tools will run\n automatically if you install `pre-commit`_ using the instructions\n below.\n- Include tests if your patch adds or changes code. Make sure the test\n fails without your patch.\n- Update any relevant docs pages and docstrings. Docs pages and\n docstrings should be wrapped at 72 characters.\n- Add an entry in ``CHANGES.rst``. Use the same style as other\n entries. Also include ``.. versionchanged::`` inline changelogs in\n relevant docstrings.\n\n.. _Black: https://black.readthedocs.io\n.. _pre-commit: https://pre-commit.com\n\n\nFirst time setup\n~~~~~~~~~~~~~~~~\n\n- Download and install the `latest version of git`_.\n- Configure git with your `username`_ and `email`_.\n\n .. code-block:: text\n\n $ git config --global user.name 'your name'\n $ git config --global user.email 'your email'\n\n- Make sure you have a `GitHub account`_.\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\n button.\n- `Clone`_ the main repository locally.\n\n .. code-block:: text\n\n $ git clone https://github.com/pallets/itsdangerous\n $ cd itsdangerous\n\n- Add your fork as a remote to push your work to. Replace\n ``{username}`` with your username. This names the remote \"fork\", the\n default Pallets remote is \"origin\".\n\n .. code-block:: text\n\n $ git remote add fork https://github.com/{username}/itsdangerous\n\n- Create a virtualenv.\n\n .. code-block:: text\n\n $ python3 -m venv env\n $ . env/bin/activate\n\n On Windows, activating is different.\n\n .. code-block:: text\n\n > env\\Scripts\\activate\n\n- Install the development dependencies, then install ItsDangerous in\n editable mode.\n\n .. code-block:: text\n\n $ pip install -r requirements/dev.txt && pip install -e .\n\n- Install the pre-commit hooks.\n\n .. code-block:: text\n\n $ pre-commit install\n\n.. _latest version of git: https://git-scm.com/downloads\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\n.. _GitHub account: https://github.com/join\n.. _Fork: https://github.com/pallets/itsdangerous/fork\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\n\n\nStart coding\n~~~~~~~~~~~~\n\n- Create a branch to identify the issue you would like to work on. If\n you're submitting a bug or documentation fix, branch off of the\n latest \".x\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/2.0.x\n\n If you're submitting a feature addition or change, branch off of the\n \"main\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/main\n\n- Using your favorite editor, make your changes,\n `committing as you go`_.\n- Include tests that cover any code changes you make. Make sure the\n test fails without your patch. Run the tests as described below.\n- Push your commits to your fork on GitHub and\n `create a pull request`_. Link to the issue being addressed with\n ``fixes #123`` in the pull request.\n\n .. code-block:: text\n\n $ git push --set-upstream fork your-branch-name\n\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\n\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nRun the basic test suite with pytest.\n\n.. code-block:: text\n\n $ pytest\n\nThis runs the tests for the current environment, which is usually\nsufficient. CI will run the full suite when you submit your pull\nrequest. You can run the full test suite with tox if you don't want to\nwait.\n\n.. code-block:: text\n\n $ tox\n\n\nRunning test coverage\n~~~~~~~~~~~~~~~~~~~~~\n\nGenerating a report of lines that do not have test coverage can indicate\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\ngenerate a report.\n\n.. code-block:: text\n\n $ pip install coverage\n $ coverage run -m pytest\n $ coverage html\n\nOpen ``htmlcov/index.html`` in your browser to explore the report.\n\nRead more about `coverage <https://coverage.readthedocs.io>`__.\n\n\nBuilding the docs\n~~~~~~~~~~~~~~~~~\n\nBuild the docs in the ``docs`` directory using Sphinx.\n\n.. code-block:: text\n\n $ cd docs\n $ make html\n\nOpen ``_build/html/index.html`` in your browser to view the docs.\n\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\n\n[end of CONTRIBUTING.rst]","filename":"CONTRIBUTING.rst","id":"0"},{"content":"repos:\n - repo: https://github.com/astral-sh/ruff-pre-commit\n rev: v0.7.1\n hooks:\n - id: ruff\n - id: ruff-format\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: check-merge-conflict\n - id: debug-statements\n - id: fix-byte-order-marker\n - id: trailing-whitespace\n - id: end-of-file-fixer\n\n[end of .pre-commit-config.yaml]","filename":".pre-commit-config.yaml","id":"1"},{"content":"[project]\nname = \"itsdangerous\"\nversion = \"2.2.0\"\ndescription = \"Safely pass data to untrusted environments and back.\"\nreadme = \"README.md\"\nlicense = { file = \"LICENSE.txt\" }\nmaintainers = [{ name = \"Pallets\", email = \"contact@palletsprojects.com\" }]\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python\",\n \"Typing :: Typed\",\n]\nrequires-python = \">=3.8\"\n\n[project.urls]\nDonate = \"https://palletsprojects.com/donate\"\nDocumentation = \"https://itsdangerous.palletsprojects.com/\"\nChanges = \"https://itsdangerous.palletsprojects.com/changes/\"\nSource = \"https://github.com/pallets/itsdangerous/\"\nChat = \"https://discord.gg/pallets\"\n\n[build-system]\nrequires = [\"flit_core<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.module]\nname = \"itsdangerous\"\n\n[tool.flit.sdist]\ninclude = [\n \"docs/\",\n \"requirements/\",\n \"tests/\",\n \"CHANGES.rst\",\n \"tox.ini\",\n]\nexclude = [\n \"docs/_build/\",\n]\n\n[tool.pytest.ini_options]\ntestpaths = [\"tests\"]\nfilterwarnings = [\n \"error\",\n]\n\n[tool.coverage.run]\nbranch = true\nsource = [\"itsdangerous\", \"tests\"]\n\n[tool.coverage.paths]\nsource = [\"src\", \"*/site-packages\"]\n\n[tool.mypy]\npython_version = \"3.8\"\nfiles = [\"src/itsdangerous\"]\nshow_error_codes = true\npretty = true\nstrict = true\n\n[tool.pyright]\npythonVersion = \"3.8\"\ninclude = [\"src/itsdangerous\"]\ntypeCheckingMode = \"basic\"\n\n[tool.ruff]\nsrc = [\"src\"]\nfix = true\nshow-fixes = true\noutput-format = \"full\"\n\n[tool.ruff.lint]\nselect = [\n \"B\", # flake8-bugbear\n \"E\", # pycodestyle error\n \"F\", # pyflakes\n \"I\", # isort\n \"UP\", # pyupgrade\n \"W\", # pycodestyle warning\n]\n\n[tool.ruff.lint.isort]\nforce-single-line = true\norder-by-type = false\n\n[tool.gha-update]\ntag-only = [\n \"slsa-framework/slsa-github-generator\",\n]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"root = true\n\n[*]\nindent_style = space\nindent_size = 4\ninsert_final_newline = true\ntrim_trailing_whitespace = true\nend_of_line = lf\ncharset = utf-8\nmax_line_length = 88\n\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"3"},{"content":"# ItsDangerous\n\n... so better sign this\n\nVarious helpers to pass data to untrusted environments and to get it\nback safe and sound. Data is cryptographically signed to ensure that a\ntoken has not been tampered with.\n\nIt's possible to customize how data is serialized. Data is compressed as\nneeded. A timestamp can be added and verified automatically while\nloading a token.\n\n\n## A Simple Example\n\nHere's how you could generate a token for transmitting a user's id and\nname between web requests.\n\n```python\nfrom itsdangerous import URLSafeSerializer\nauth_s = URLSafeSerializer(\"secret key\", \"auth\")\ntoken = auth_s.dumps({\"id\": 5, \"name\": \"itsdangerous\"})\n\nprint(token)\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\n\ndata = auth_s.loads(token)\nprint(data[\"name\"])\n# itsdangerous\n```\n\n\n## Donate\n\nThe Pallets organization develops and supports ItsDangerous and other\npopular packages. In order to grow the community of contributors and\nusers, and allow the maintainers to devote more time to the projects,\n[please donate today][].\n\n[please donate today]: https://palletsprojects.com/donate\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"[tox]\nenvlist =\n py3{13,12,11,10,9,8}\n pypy310\n style\n typing\n docs\nskip_missing_interpreters = true\n\n[testenv]\npackage = wheel\nwheel_build_env = .pkg\nconstrain_package_deps = true\nuse_frozen_constraints = true\ndeps = -r requirements/tests.txt\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\n\n[testenv:style]\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit run --all-files\n\n[testenv:typing]\ndeps = -r requirements/typing.txt\ncommands =\n mypy\n pyright\n pyright --verifytypes itsdangerous --ignoreexternal\n\n[testenv:docs]\ndeps = -r requirements/docs.txt\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\n\n[testenv:update-actions]\nlabels = update\ndeps = gha-update\ncommands = gha-update\n\n[testenv:update-pre_commit]\nlabels = update\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit autoupdate -j4\n\n[testenv:update-requirements]\nlabels = update\ndeps = pip-tools\nskip_install = true\nchange_dir = requirements\ncommands =\n pip-compile build.in -q {posargs:-U}\n pip-compile docs.in -q {posargs:-U}\n pip-compile tests.in -q {posargs:-U}\n pip-compile typing.in -q {posargs:-U}\n pip-compile dev.in -q {posargs:-U}\n\n[end of tox.ini]","filename":"tox.ini","id":"5"},{"content":"Copyright 2011 Pallets\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n1. Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n2. 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\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE.txt]","filename":"LICENSE.txt","id":"6"},{"content":"Version 2.2.0\n-------------\n\nReleased 2024-04-16\n\n- Drop support for Python 3.7. :pr:`372`\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\n :pr:`326`\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\n- Deprecate the ``__version__`` attribute. Use feature detection, or\n ``importlib.metadata.version(\"itsdangerous\")``, instead. :issue:`371`\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\n different ``serializer`` argument is given, it will try to infer the return\n type of its ``dumps`` method. :issue:`347`\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\n access it at import time so the developer has time to change the default.\n :issue:`375`\n\n\nVersion 2.1.2\n-------------\n\nReleased 2022-03-24\n\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\n\n\nVersion 2.1.1\n-------------\n\nReleased 2022-03-09\n\n- Handle date overflow in timed unsign. :pr:`296`\n\n\nVersion 2.1.0\n-------------\n\nReleased 2022-02-17\n\n- Drop support for Python 3.6. :pr:`272`\n- Remove previously deprecated code. :pr:`273`\n\n - JWS functionality: Use a dedicated library such as Authlib\n instead.\n - ``import itsdangerous.json``: Import ``json`` from the standard\n library instead.\n\n\nVersion 2.0.1\n-------------\n\nReleased 2021-05-18\n\n- Mark top-level names as exported so type checking understands\n imports in user projects. :pr:`240`\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\n ``None`` again. :issue:`237`\n\n\nVersion 2.0.0\n-------------\n\nReleased 2021-05-11\n\n- Drop support for Python 2 and 3.5.\n- JWS support (``JSONWebSignatureSerializer``,\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\n JWS/JWT library such as authlib instead. :issue:`129`\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\n ``json`` module instead. :pr:`152`\n- Simplejson is no longer used if it is installed. To use a different\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\n- If a signature has an age less than 0, it will raise\n ``SignatureExpired`` rather than appearing valid. This can happen if\n the timestamp offset is changed. :issue:`126`\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\n rather than an ``int`` in some cases. :issue:`124`\n- Added support for key rotation. A list of keys can be passed as\n ``secret_key``, oldest to newest. The newest key is used for\n signing, all keys are tried for unsigning. :pr:`141`\n- Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``. :issue:`155`\n- Add type information for static typing tools. :pr:`186`\n\n\nVersion 1.1.0\n-------------\n\nReleased 2018-10-26\n\n- Change default signing algorithm back to SHA-1. :pr:`113`\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\n release which defaulted to SHA-512. :pr:`114`\n- Add support for fallback algorithms during deserialization to\n support changing the default in the future without breaking existing\n signatures. :pr:`113`\n- Changed capitalization of packages back to lowercase as the change\n in capitalization broke some tooling. :pr:`113`\n\n\nVersion 1.0.0\n-------------\n\nReleased 2018-10-18\n\nYANKED\n\n*Note*: This release was yanked from PyPI because it changed the default\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\nat SHA1.\n\n- Drop support for Python 2.6 and 3.3.\n- Refactor code from a single module to a package. Any object in the\n API docs is still importable from the top-level ``itsdangerous``\n name, but other imports will need to be changed. A future release\n will remove many of these compatibility imports. :pr:`107`\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\n :pr:`27`\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\n Python 3. :issue:`29`\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\n- More compact JSON dumps for unicode strings. :issue:`38`\n- Use the full timestamp rather than an offset, allowing dates before\n 2011. :issue:`46`\n\n To retain compatibility with signers from previous versions,\n consider using `this shim <https://github.com/pallets/itsdangerous\n /issues/120#issuecomment-456913331>`_ when unsigning.\n- Detect a ``sep`` character that may show up in the signature itself\n and raise a ``ValueError``. :issue:`62`\n- Use a consistent signature for keyword arguments for\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\n- Convert JWS exp header to an int when loading. :pr:`99`\n\n\nVersion 0.24\n------------\n\nReleased 2014-03-28\n\n- Added a ``BadHeader`` exception that is used for bad headers that\n replaces the old ``BadPayload`` exception that was reused in those\n cases.\n\n\nVersion 0.23\n------------\n\nReleased 2013-08-08\n\n- Fixed a packaging mistake that caused the tests and license files to\n not be included.\n\n\nVersion 0.22\n------------\n\nReleased 2013-07-03\n\n- Added support for ``TimedJSONWebSignatureSerializer``.\n- Made it possible to override the signature verification function to\n allow implementing asymmetrical algorithms.\n\n\nVersion 0.21\n------------\n\nReleased 2013-05-26\n\n- Fixed an issue on Python 3 which caused invalid errors to be\n generated.\n\n\nVersion 0.20\n------------\n\nReleased 2013-05-23\n\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\n ItsDangerous on Python 2.6.\n\n\nVersion 0.19\n------------\n\nReleased 2013-05-21\n\n- Dropped support for 2.5 and added support for 3.3.\n\n\nVersion 0.18\n------------\n\nReleased 2013-05-03\n\n- Added support for JSON Web Signatures (JWS).\n\n\nVersion 0.17\n------------\n\nReleased 2012-08-10\n\n- Fixed a name error when overriding the digest method.\n\n\nVersion 0.16\n------------\n\nReleased 2012-07-11\n\n- Made it possible to pass unicode values to ``load_payload`` to make\n it easier to debug certain things.\n\n\nVersion 0.15\n------------\n\nReleased 2012-07-11\n\n- Made standalone ``load_payload`` more robust by raising one specific\n error if something goes wrong.\n- Refactored exceptions to catch more cases individually, added more\n attributes.\n- Fixed an issue that caused ``load_payload`` not work in some\n situations with timestamp based serializers\n- Added an ``loads_unsafe`` method.\n\n\nVersion 0.14\n------------\n\nReleased 2012-06-29\n\n- API refactoring to support different key derivations.\n- Added attributes to exceptions so that you can inspect the data even\n if the signature check failed.\n\n\nVersion 0.13\n------------\n\nReleased 2012-06-10\n\n- Small API change that enables customization of the digest module.\n\n\nVersion 0.12\n------------\n\nReleased 2012-02-22\n\n- Fixed a problem with the local timezone being used for the epoch\n calculation. This might invalidate some of your signatures if you\n were not running in UTC timezone. You can revert to the old behavior\n by monkey patching ``itsdangerous.EPOCH``.\n\n\nVersion 0.11\n------------\n\nReleased 2011-07-07\n\n- Fixed an uncaught value error.\n\n\nVersion 0.10\n------------\n\nReleased 2011-06-25\n\n- Refactored interface that the underlying serializers can be swapped\n by passing in a module instead of having to override the payload\n loaders and dumpers. This makes the interface more compatible with\n Django's recent changes.\n\n[end of CHANGES.rst]","filename":"CHANGES.rst","id":"7"},{"content":"version: 2\nbuild:\n os: ubuntu-22.04\n tools:\n python: '3.12'\npython:\n install:\n - requirements: requirements/docs.txt\n - method: pip\n path: .\nsphinx:\n builder: dirhtml\n fail_on_warning: true\n\n[end of .readthedocs.yaml]","filename":".readthedocs.yaml","id":"8"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile dev.in\n#\nalabaster==1.0.0\n # via\n # -r docs.txt\n # sphinx\nbabel==2.16.0\n # via\n # -r docs.txt\n # sphinx\ncachetools==5.5.0\n # via tox\ncertifi==2024.8.30\n # via\n # -r docs.txt\n # requests\ncfgv==3.4.0\n # via pre-commit\nchardet==5.2.0\n # via tox\ncharset-normalizer==3.4.0\n # via\n # -r docs.txt\n # requests\ncolorama==0.4.6\n # via tox\ndistlib==0.3.9\n # via virtualenv\ndocutils==0.21.2\n # via\n # -r docs.txt\n # sphinx\nfilelock==3.16.1\n # via\n # tox\n # virtualenv\nfreezegun==1.5.1\n # via -r tests.txt\nidentify==2.6.1\n # via pre-commit\nidna==3.10\n # via\n # -r docs.txt\n # requests\nimagesize==1.4.1\n # via\n # -r docs.txt\n # sphinx\niniconfig==2.0.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\njinja2==3.1.4\n # via\n # -r docs.txt\n # sphinx\nmarkupsafe==3.0.2\n # via\n # -r docs.txt\n # jinja2\nmypy==1.13.0\n # via -r typing.txt\nmypy-extensions==1.0.0\n # via\n # -r typing.txt\n # mypy\nnodeenv==1.9.1\n # via\n # -r typing.txt\n # pre-commit\n # pyright\npackaging==24.1\n # via\n # -r docs.txt\n # -r tests.txt\n # -r typing.txt\n # pallets-sphinx-themes\n # pyproject-api\n # pytest\n # sphinx\n # tox\npallets-sphinx-themes==2.3.0\n # via -r docs.txt\nplatformdirs==4.3.6\n # via\n # tox\n # virtualenv\npluggy==1.5.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\n # tox\npre-commit==4.0.1\n # via -r dev.in\npygments==2.18.0\n # via\n # -r docs.txt\n # sphinx\npyproject-api==1.8.0\n # via tox\npyright==1.1.386\n # via -r typing.txt\npytest==8.3.3\n # via\n # -r tests.txt\n # -r typing.txt\npython-dateutil==2.9.0.post0\n # via\n # -r tests.txt\n # freezegun\npyyaml==6.0.2\n # via pre-commit\nrequests==2.32.3\n # via\n # -r docs.txt\n # sphinx\nsix==1.16.0\n # via\n # -r tests.txt\n # python-dateutil\nsnowballstemmer==2.2.0\n # via\n # -r docs.txt\n # sphinx\nsphinx==8.1.3\n # via\n # -r docs.txt\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via\n # -r docs.txt\n # pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-devhelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-jsmath==1.0.1\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.txt\nsphinxcontrib-qthelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via\n # -r docs.txt\n # sphinx\ntox==4.23.2\n # via -r dev.in\ntyping-extensions==4.12.2\n # via\n # -r typing.txt\n # mypy\n # pyright\nurllib3==2.2.3\n # via\n # -r docs.txt\n # requests\nvirtualenv==20.27.0\n # via\n # pre-commit\n # tox\n\n[end of requirements/dev.txt]","filename":"requirements/dev.txt","id":"9"},{"content":"pallets-sphinx-themes\nsphinx\nsphinxcontrib-log-cabinet\n\n[end of requirements/docs.in]","filename":"requirements/docs.in","id":"10"},{"content":"build\n\n[end of requirements/build.in]","filename":"requirements/build.in","id":"11"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile typing.in\n#\niniconfig==2.0.0\n # via pytest\nmypy==1.13.0\n # via -r typing.in\nmypy-extensions==1.0.0\n # via mypy\nnodeenv==1.9.1\n # via pyright\npackaging==24.1\n # via pytest\npluggy==1.5.0\n # via pytest\npyright==1.1.386\n # via -r typing.in\npytest==8.3.3\n # via -r typing.in\ntyping-extensions==4.12.2\n # via\n # mypy\n # pyright\n\n[end of requirements/typing.txt]","filename":"requirements/typing.txt","id":"12"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile build.in\n#\nbuild==1.2.2.post1\n # via -r build.in\npackaging==24.1\n # via build\npyproject-hooks==1.2.0\n # via build\n\n[end of requirements/build.txt]","filename":"requirements/build.txt","id":"13"},{"content":"mypy\npyright\npytest\n\n[end of requirements/typing.in]","filename":"requirements/typing.in","id":"14"},{"content":"-r docs.txt\n-r tests.txt\n-r typing.txt\npre-commit\ntox\n\n[end of requirements/dev.in]","filename":"requirements/dev.in","id":"15"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile docs.in\n#\nalabaster==1.0.0\n # via sphinx\nbabel==2.16.0\n # via sphinx\ncertifi==2024.8.30\n # via requests\ncharset-normalizer==3.4.0\n # via requests\ndocutils==0.21.2\n # via sphinx\nidna==3.10\n # via requests\nimagesize==1.4.1\n # via sphinx\njinja2==3.1.4\n # via sphinx\nmarkupsafe==3.0.2\n # via jinja2\npackaging==24.1\n # via\n # pallets-sphinx-themes\n # sphinx\npallets-sphinx-themes==2.3.0\n # via -r docs.in\npygments==2.18.0\n # via sphinx\nrequests==2.32.3\n # via sphinx\nsnowballstemmer==2.2.0\n # via sphinx\nsphinx==8.1.3\n # via\n # -r docs.in\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via sphinx\nsphinxcontrib-devhelp==2.0.0\n # via sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via sphinx\nsphinxcontrib-jsmath==1.0.1\n # via sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.in\nsphinxcontrib-qthelp==2.0.0\n # via sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via sphinx\nurllib3==2.2.3\n # via requests\n\n[end of requirements/docs.txt]","filename":"requirements/docs.txt","id":"16"},{"content":".. rst-class:: hide-header\n\nItsDangerous\n============\n\n.. image:: _static/itsdangerous-logo.png\n :align: center\n :target: https://palletsprojects.com/p/itsdangerous/\n\nSometimes you want to send some data to untrusted environments, then get\nit back later. To do this safely, the data must be signed to detect\nchanges.\n\nGiven a key only you know, you can cryptographically sign your data and\nhand it over to someone else. When you get the data back you can ensure\nthat nobody tampered with it.\n\nThe receiver can see the data, but they can not modify it unless they\nalso have your key. So if you keep the key secret and complex, you will\nbe fine.\n\n\nInstalling\n----------\n\nInstall and update using `pip`_:\n\n.. code-block:: text\n\n pip install -U itsdangerous\n\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\n\n\nExample Use Cases\n-----------------\n\n- Sign a user ID in a URL and email it to them to unsubscribe from a\n newsletter. This way you don't need to generate one-time tokens and\n store them in the database. Same thing with any kind of activation\n link for accounts and similar things.\n- Signed objects can be stored in cookies or other untrusted sources\n which means you don't need to have sessions stored on the server,\n which reduces the number of necessary database queries.\n- Signed information can safely do a round trip between server and\n client in general which makes them useful for passing server-side\n state to a client and then back.\n\n\nTable of Contents\n-----------------\n\n.. toctree::\n\n concepts\n serializer\n signer\n exceptions\n timed\n url_safe\n encoding\n license\n changes\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"17"},{"content":".. module:: itsdangerous.serializer\n\nSerialization Interface\n=======================\n\nThe :doc:`/signer` only signs bytes. To sign other types, the\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\nsimilar to Python's :mod:`json` module, which serializes the object to a\nstring then signs that.\n\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n s = Serializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\n\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\nthe data.\n\n.. code-block:: python\n\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\n [1, 2, 3, 4]\n\nBy default, data is serialized to JSON with the built-in :mod:`json`\nmodule. This internal serializer can be changed by subclassing.\n\nTo record and validate the age of the signature, see :doc:`/timed`.\nTo serialize to a format that is safe to use in URLs, see\n:doc:`/url_safe`.\n\n\nResponding to Failure\n---------------------\n\nExceptions have helpful attributes which allow you to inspect the\npayload if the signature check failed. This has to be done with extra\ncare because at that point you know that someone tampered with your data\nbut it might be useful for debugging purposes.\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n from itsdangerous.exc import BadSignature, BadData\n\n s = URLSafeSerializer(\"secret-key\")\n decoded_payload = None\n\n try:\n decoded_payload = s.loads(data)\n # This payload is decoded and safe\n except BadSignature as e:\n if e.payload is not None:\n try:\n decoded_payload = s.load_payload(e.payload)\n except BadData:\n pass\n # This payload is decoded but unsafe because someone\n # tampered with the signature. The decode (load_payload)\n # step is explicit because it might be unsafe to unserialize\n # the payload (think pickle instead of json!)\n\nIf you don't want to inspect attributes to figure out what exactly went\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\n\n.. code-block:: python\n\n sig_okay, payload = s.loads_unsafe(data)\n\nThe first item in the returned tuple is a boolean that indicates if the\nsignature was correct.\n\n\nFallback Signers\n----------------\n\nYou may want to upgrade the signing parameters without invalidating\nexisting signatures immediately. For example, you may decide that you\nwant to use a different digest method. New signatures should use the new\nmethod, but old signatures should still validate.\n\nA list of ``fallback_signers`` can be given that will be tried if\nunsigning with the current signer fails. Each item in the list can be:\n\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\n passed to the serializer.\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\n serializer.\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\n given class with the given args.\n\nFor example, this is a serializer that signs using SHA-512, but will\nunsign using either SHA-512 or SHA-1:\n\n.. code-block:: python\n\n s = Serializer(\n signer_kwargs={\"digest_method\": hashlib.sha512},\n fallback_signers=[{\"digest_method\": hashlib.sha1}]\n )\n\n\n\nAPI\n---\n\n.. autoclass:: Serializer\n :members:\n\n[end of docs/serializer.rst]","filename":"docs/serializer.rst","id":"18"},{"content":".. module:: itsdangerous.signer\n\nSigning Interface\n=================\n\nThe most basic interface is the signing interface. The :class:`Signer`\nclass can be used to attach a signature to a specific string:\n\n.. code-block:: python\n\n from itsdangerous import Signer\n s = Signer(\"secret-key\")\n s.sign(\"my string\")\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\n\nThe signature is appended to the string, separated by a dot. To validate\nthe string, use the :meth:`~Signer.unsign` method:\n\n.. code-block:: python\n\n s.unsign(b\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n b'my string'\n\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\nHowever after unsigning you won't be able to tell if it was unicode or\na bytestring.\n\nIf the value is changed, the signature will no longer match, and\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\n\n.. code-block:: python\n\n s.unsign(b\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nTo record and validate the age of a signature, see :doc:`/timed`.\n\n.. autoclass:: Signer\n :members:\n\n\nSigning Algorithms\n------------------\n\n.. autoclass:: NoneAlgorithm\n\n.. autoclass:: HMACAlgorithm\n\n[end of docs/signer.rst]","filename":"docs/signer.rst","id":"19"},{"content":"General Concepts\n================\n\n\nSerializer vs Signer\n--------------------\n\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\nthe basic system that signs a given ``bytes`` value based on the given\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\nserializing and signing other data besides ``bytes``.\n\nTypically, you'll want to use a serializer, not a signer. You can\nconfigure the signing parameters through the serializer, and even\nprovide fallback signers to upgrade old tokens to new parameters.\n\n\nThe Secret Key\n--------------\n\nSignatures are secured by the ``secret_key``. Typically one secret key\nis used with all signers, and the salt is used to distinguish different\ncontexts. Changing the secret key will invalidate existing tokens.\n\nIt should be a long random string of bytes. This value must be kept\nsecret and should not be saved in source code or committed to version\ncontrol. If an attacker learns the secret key, they can change and\nresign data to look valid. If you suspect this happened, change the\nsecret key to invalidate existing tokens.\n\nOne way to keep the secret key separate is to read it from an\nenvironment variable. When deploying for the first time, generate a key\nand set the environment variable when running the application. All\nprocess managers (like systemd) and hosting services have a way to\nspecify environment variables.\n\n.. code-block:: python\n\n import os\n from itsdangerous.serializer import Serializer\n SECRET_KEY = os.environ.get(\"SECRET_KEY\")\n s = Serializer(SECRET_KEY)\n\n.. code-block:: text\n\n $ export SECRET_KEY=\"base64 encoded random bytes\"\n $ python application.py\n\nOne way to generate a key is to use :func:`os.urandom`.\n\n.. code-block:: text\n\n $ python3 -c 'import os; print(os.urandom(16).hex())'\n\n\nThe Salt\n--------\n\nThe salt is combined with the secret key to derive a unique key for\ndistinguishing different contexts. Unlike the secret key, the salt\ndoesn't have to be random, and can be saved in code. It only has to be\nunique between contexts, not private.\n\nFor example, you want to email activation links to activate user\naccounts, and upgrade links to upgrade users to a paid accounts. If all\nyou sign is the user id, and you don't use different salts, a user could\nreuse the token from the activation link to upgrade the account. If you\nuse different salts, the signatures will be different and will not be\nvalid in the other context.\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n\n s1 = URLSafeSerializer(\"secret-key\", salt=\"activate\")\n s1.dumps(42)\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\n\n s2 = URLSafeSerializer(\"secret-key\", salt=\"upgrade\")\n s2.dumps(42)\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\n\nThe second serializer can't load data dumped with the first because the\nsalts differ.\n\n.. code-block:: python\n\n s2.loads(s1.dumps(42))\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nOnly the serializer with the same salt can load the data.\n\n.. code-block:: python\n\n s2.loads(s2.dumps(42))\n 42\n\n\nKey Rotation\n------------\n\nKey rotation can provide an extra layer of mitigation against an\nattacker discovering a secret key. A rotation system will keep a list of\nvalid keys, generating a new key and removing the oldest key\nperiodically. If it takes four weeks for an attacker to crack a key, but\nthe key is rotated out after three weeks, they will not be able to use\nany keys they crack. However, if a user doesn't refresh their token\nwithin three weeks it will be invalid too.\n\nThe system that generates and maintains this list is outside the scope\nof ItsDangerous, but ItsDangerous does support validating against a list\nof keys.\n\nInstead of passing a single key, you can pass a list of keys, oldest to\nnewest. When signing the last (newest) key will be used, and when\nvalidating each key will be tried from newest to oldest before raising\na validation error.\n\n.. code-block:: python\n\n SECRET_KEYS = [\"2b9cd98e\", \"169d7886\", \"b6af09f5\"]\n\n # sign some data with the latest key\n s = Serializer(SECRET_KEYS)\n t = s.dumps({\"id\": 42})\n\n # rotate a new key in and the oldest key out\n SECRET_KEYS.append(\"cf9b3588\")\n del SECRET_KEYS[0]\n\n s = Serializer(SECRET_KEYS)\n s.loads(t) # valid even though it was signed with a previous key\n\n\nDigest Method Security\n----------------------\n\nA signer is configured with a ``digest_method``, a hash function that\nis used as an intermediate step when generating the HMAC signature. The\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\nconcerned about this default because they have heard about hash\ncollisions with SHA-1.\n\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\nhash alone doesn't apply when used in HMAC.\n\nIf a project considers SHA-1 a risk anyway, they can configure the\nsigner with a different digest method such as :func:`hashlib.sha512`.\nA fallback signer for SHA-1 can be configured so that old tokens will be\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\nspace, which is relevant in cookies and URLs.\n\n[end of docs/concepts.rst]","filename":"docs/concepts.rst","id":"20"},{"content":".. module:: itsdangerous.url_safe\n\nURL Safe Serialization\n======================\n\nOften it is helpful if you can pass these trusted strings in places\nwhere you only have a limited set of characters available. Because of\nthis, ItsDangerous also provides URL safe serializers:\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n s = URLSafeSerializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\n s.loads(\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\")\n [1, 2, 3, 4]\n\n.. autoclass:: URLSafeSerializer\n\n.. autoclass:: URLSafeTimedSerializer\n\n[end of docs/url_safe.rst]","filename":"docs/url_safe.rst","id":"21"},{"content":".. module:: itsdangerous.encoding\n\nEncoding Utilities\n==================\n\n.. autofunction:: base64_encode\n\n.. autofunction:: base64_decode\n\n[end of docs/encoding.rst]","filename":"docs/encoding.rst","id":"22"},{"content":"# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSOURCEDIR = .\nBUILDDIR = _build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"23"},{"content":"from pallets_sphinx_themes import get_version\nfrom pallets_sphinx_themes import ProjectLink\n\n# Project --------------------------------------------------------------\n\nproject = \"ItsDangerous\"\ncopyright = \"2011 Pallets\"\nauthor = \"Pallets\"\nrelease, version = get_version(\"itsdangerous\")\n\n# General --------------------------------------------------------------\n\ndefault_role = \"code\"\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.extlinks\",\n \"sphinx.ext.intersphinx\",\n \"sphinxcontrib.log_cabinet\",\n \"pallets_sphinx_themes\",\n]\nautoclass_content = \"both\"\nautodoc_member_order = \"bysource\"\nautodoc_typehints = \"description\"\nautodoc_preserve_defaults = True\nextlinks = {\n \"issue\": (\"https://github.com/pallets/itsdangerous/issues/%s\", \"#%s\"),\n \"pr\": (\"https://github.com/pallets/itsdangerous/pull/%s\", \"#%s\"),\n}\nintersphinx_mapping = {\n \"python\": (\"https://docs.python.org/3/\", None),\n}\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = \"flask\"\nhtml_theme_options = {\"index_sidebar_logo\": False}\nhtml_context = {\n \"project_links\": [\n ProjectLink(\"Donate\", \"https://palletsprojects.com/donate\"),\n ProjectLink(\"PyPI Releases\", \"https://pypi.org/project/itsdangerous/\"),\n ProjectLink(\"Source Code\", \"https://github.com/pallets/itsdangerous/\"),\n ProjectLink(\"Issue Tracker\", \"https://github.com/pallets/itsdangerous/issues/\"),\n ProjectLink(\"Chat\", \"https://discord.gg/pallets\"),\n ]\n}\nhtml_sidebars = {\n \"index\": [\"project.html\", \"localtoc.html\", \"searchbox.html\", \"ethicalads.html\"],\n \"**\": [\"localtoc.html\", \"relations.html\", \"searchbox.html\", \"ethicalads.html\"],\n}\nsinglehtml_sidebars = {\"index\": [\"project.html\", \"localtoc.html\", \"ethicalads.html\"]}\nhtml_static_path = [\"_static\"]\nhtml_favicon = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_logo = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_title = f\"{project} Documentation ({version})\"\nhtml_show_sourcelink = False\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"24"},{"content":"@ECHO OFF\n\npushd %~dp0\n\nREM Command file for Sphinx documentation\n\nif \"%SPHINXBUILD%\" == \"\" (\n\tset SPHINXBUILD=sphinx-build\n)\nset SOURCEDIR=.\nset BUILDDIR=_build\n\nif \"%1\" == \"\" goto help\n\n%SPHINXBUILD% >NUL 2>NUL\nif errorlevel 9009 (\n\techo.\n\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\n\techo.installed, then set the SPHINXBUILD environment variable to point\n\techo.to the full path of the 'sphinx-build' executable. Alternatively you\n\techo.may add the Sphinx directory to PATH.\n\techo.\n\techo.If you don't have Sphinx installed, grab it from\n\techo.http://sphinx-doc.org/\n\texit /b 1\n)\n\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\ngoto end\n\n:help\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\n\n:end\npopd\n\n[end of docs/make.bat]","filename":"docs/make.bat","id":"25"},{"content":".. module:: itsdangerous.timed\n\nSigning With Timestamps\n=======================\n\nIf you want to expire signatures you can use the\n:class:`TimestampSigner` class which adds timestamp information and\nsigns it. On unsigning you can validate that the timestamp is not older\nthan a given age.\n\n.. code-block:: python\n\n from itsdangerous import TimestampSigner\n s = TimestampSigner('secret-key')\n string = s.sign('foo')\n\n.. code-block:: python\n\n s.unsign(string, max_age=5)\n Traceback (most recent call last):\n ...\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\n\n.. autoclass:: TimestampSigner\n :members:\n\n.. autoclass:: TimedSerializer\n :members:\n\n[end of docs/timed.rst]","filename":"docs/timed.rst","id":"26"},{"content":"BSD-3-Clause License\n====================\n\n.. literalinclude:: ../LICENSE.txt\n :language: text\n\n[end of docs/license.rst]","filename":"docs/license.rst","id":"27"},{"content":"Changes\n=======\n\n.. include:: ../CHANGES.rst\n\n[end of docs/changes.rst]","filename":"docs/changes.rst","id":"28"},{"content":".. module:: itsdangerous.exc\n\nExceptions\n==========\n\n.. autoexception:: BadData\n :members:\n\n.. autoexception:: BadSignature\n :members:\n\n.. autoexception:: BadTimeSignature\n :members:\n\n.. autoexception:: SignatureExpired\n :members:\n\n.. autoexception:: BadHeader\n :members:\n\n.. autoexception:: BadPayload\n :members:\n\n[end of docs/exceptions.rst]","filename":"docs/exceptions.rst","id":"29"},{"content":"#!/bin/bash\nset -e\npython3 -m venv --upgrade-deps .venv\n. .venv/bin/activate\npip install -r requirements/dev.txt\npip install -e .\npre-commit install --install-hooks\n\n[end of .devcontainer/on-create-command.sh]","filename":".devcontainer/on-create-command.sh","id":"30"},{"content":"{\n \"name\": \"pallets/itsdangerous\",\n \"image\": \"mcr.microsoft.com/devcontainers/python:3\",\n \"customizations\": {\n \"vscode\": {\n \"settings\": {\n \"python.defaultInterpreterPath\": \"${workspaceFolder}/.venv\",\n \"python.terminal.activateEnvInCurrentTerminal\": true,\n \"python.terminal.launchArgs\": [\n \"-X\",\n \"dev\"\n ]\n }\n }\n },\n \"onCreateCommand\": \".devcontainer/on-create-command.sh\"\n}\n\n[end of .devcontainer/devcontainer.json]","filename":".devcontainer/devcontainer.json","id":"31"},{"content":"None\n[end of docs/_static/itsdangerous-logo-sidebar.png]","filename":"docs/_static/itsdangerous-logo-sidebar.png","id":"32"},{"content":"None\n[end of docs/_static/itsdangerous-logo.png]","filename":"docs/_static/itsdangerous-logo.png","id":"33"},{"content":"from __future__ import annotations\n\nimport json as _json\nimport typing as t\n\n\nclass _CompactJSON:\n \"\"\"Wrapper around json module that strips whitespace.\"\"\"\n\n @staticmethod\n def loads(payload: str | bytes) -> t.Any:\n return _json.loads(payload)\n\n @staticmethod\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\n kwargs.setdefault(\"ensure_ascii\", False)\n kwargs.setdefault(\"separators\", (\",\", \":\"))\n return _json.dumps(obj, **kwargs)\n\n[end of src/itsdangerous/_json.py]","filename":"src/itsdangerous/_json.py","id":"34"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport time\nimport typing as t\nfrom datetime import datetime\nfrom datetime import timezone\n\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import bytes_to_int\nfrom .encoding import int_to_bytes\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\nfrom .exc import BadTimeSignature\nfrom .exc import SignatureExpired\nfrom .serializer import _TSerialized\nfrom .serializer import Serializer\nfrom .signer import Signer\n\n\nclass TimestampSigner(Signer):\n \"\"\"Works like the regular :class:`.Signer` but also records the time\n of the signing and can be used to expire signatures. The\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\n unsigning failed because the signature is expired.\n \"\"\"\n\n def get_timestamp(self) -> int:\n \"\"\"Returns the current timestamp. The function must return an\n integer.\n \"\"\"\n return int(time.time())\n\n def timestamp_to_datetime(self, ts: int) -> datetime:\n \"\"\"Convert the timestamp from :meth:`get_timestamp` into an\n aware :class`datetime.datetime` in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n return datetime.fromtimestamp(ts, tz=timezone.utc)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string and also attaches time information.\"\"\"\n value = want_bytes(value)\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\n sep = want_bytes(self.sep)\n value = value + sep + timestamp\n return value + sep + self.get_signature(value)\n\n # Ignore overlapping signatures check, return_timestamp is the only\n # parameter that affects the return type.\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[False] = False,\n ) -> bytes: ...\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[True] = True,\n ) -> tuple[bytes, datetime]: ...\n\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n ) -> tuple[bytes, datetime] | bytes:\n \"\"\"Works like the regular :meth:`.Signer.unsign` but can also\n validate the time. See the base docstring of the class for\n the general behavior. If ``return_timestamp`` is ``True`` the\n timestamp of the signature will be returned as an aware\n :class:`datetime.datetime` object in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n try:\n result = super().unsign(signed_value)\n sig_error = None\n except BadSignature as e:\n sig_error = e\n result = e.payload or b\"\"\n\n sep = want_bytes(self.sep)\n\n # If there is no timestamp in the result there is something\n # seriously wrong. In case there was a signature error, we raise\n # that one directly, otherwise we have a weird situation in\n # which we shouldn't have come except someone uses a time-based\n # serializer on non-timestamp data, so catch that.\n if sep not in result:\n if sig_error:\n raise sig_error\n\n raise BadTimeSignature(\"timestamp missing\", payload=result)\n\n value, ts_bytes = result.rsplit(sep, 1)\n ts_int: int | None = None\n ts_dt: datetime | None = None\n\n try:\n ts_int = bytes_to_int(base64_decode(ts_bytes))\n except Exception:\n pass\n\n # Signature is *not* okay. Raise a proper error now that we have\n # split the value and the timestamp.\n if sig_error is not None:\n if ts_int is not None:\n try:\n ts_dt = self.timestamp_to_datetime(ts_int)\n except (ValueError, OSError, OverflowError) as exc:\n # Windows raises OSError\n # 32-bit raises OverflowError\n raise BadTimeSignature(\n \"Malformed timestamp\", payload=value\n ) from exc\n\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\n\n # Signature was okay but the timestamp is actually not there or\n # malformed. Should not happen, but we handle it anyway.\n if ts_int is None:\n raise BadTimeSignature(\"Malformed timestamp\", payload=value)\n\n # Check timestamp is not older than max_age\n if max_age is not None:\n age = self.get_timestamp() - ts_int\n\n if age > max_age:\n raise SignatureExpired(\n f\"Signature age {age} > {max_age} seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if age < 0:\n raise SignatureExpired(\n f\"Signature age {age} < 0 seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if return_timestamp:\n return value, self.timestamp_to_datetime(ts_int)\n\n return value\n\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\"\"\"\n try:\n self.unsign(signed_value, max_age=max_age)\n return True\n except BadSignature:\n return False\n\n\nclass TimedSerializer(Serializer[_TSerialized]):\n \"\"\"Uses :class:`TimestampSigner` instead of the default\n :class:`.Signer`.\n \"\"\"\n\n default_signer: type[TimestampSigner] = TimestampSigner\n\n def iter_unsigners(\n self, salt: str | bytes | None = None\n ) -> cabc.Iterator[TimestampSigner]:\n return t.cast(\"cabc.Iterator[TimestampSigner]\", super().iter_unsigners(salt))\n\n # TODO: Signature is incompatible because parameters were added\n # before salt.\n\n def loads( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n salt: str | bytes | None = None,\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\n signature validation fails. If a ``max_age`` is provided it will\n ensure the signature is not older than that time in seconds. In\n case the signature is outdated, :exc:`.SignatureExpired` is\n raised. All arguments are forwarded to the signer's\n :meth:`~TimestampSigner.unsign` method.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n base64d, timestamp = signer.unsign(\n s, max_age=max_age, return_timestamp=True\n )\n payload = self.load_payload(base64d)\n\n if return_timestamp:\n return payload, timestamp\n\n return payload\n except SignatureExpired:\n # The signature was unsigned successfully but was\n # expired. Do not try the next signer.\n raise\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def loads_unsafe( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n salt: str | bytes | None = None,\n ) -> tuple[bool, t.Any]:\n return self._loads_unsafe_impl(s, salt, load_kwargs={\"max_age\": max_age})\n\n[end of src/itsdangerous/timed.py]","filename":"src/itsdangerous/timed.py","id":"35"},{"content":"from __future__ import annotations\n\nimport base64\nimport string\nimport struct\nimport typing as t\n\nfrom .exc import BadData\n\n\ndef want_bytes(\n s: str | bytes, encoding: str = \"utf-8\", errors: str = \"strict\"\n) -> bytes:\n if isinstance(s, str):\n s = s.encode(encoding, errors)\n\n return s\n\n\ndef base64_encode(string: str | bytes) -> bytes:\n \"\"\"Base64 encode a string of bytes or text. The resulting bytes are\n safe to use in URLs.\n \"\"\"\n string = want_bytes(string)\n return base64.urlsafe_b64encode(string).rstrip(b\"=\")\n\n\ndef base64_decode(string: str | bytes) -> bytes:\n \"\"\"Base64 decode a URL-safe string of bytes or text. The result is\n bytes.\n \"\"\"\n string = want_bytes(string, encoding=\"ascii\", errors=\"ignore\")\n string += b\"=\" * (-len(string) % 4)\n\n try:\n return base64.urlsafe_b64decode(string)\n except (TypeError, ValueError) as e:\n raise BadData(\"Invalid base64-encoded data\") from e\n\n\n# The alphabet used by base64.urlsafe_*\n_base64_alphabet = f\"{string.ascii_letters}{string.digits}-_=\".encode(\"ascii\")\n\n_int64_struct = struct.Struct(\">Q\")\n_int_to_bytes = _int64_struct.pack\n_bytes_to_int = t.cast(\"t.Callable[[bytes], tuple[int]]\", _int64_struct.unpack)\n\n\ndef int_to_bytes(num: int) -> bytes:\n return _int_to_bytes(num).lstrip(b\"\\x00\")\n\n\ndef bytes_to_int(bytestr: bytes) -> int:\n return _bytes_to_int(bytestr.rjust(8, b\"\\x00\"))[0]\n\n[end of src/itsdangerous/encoding.py]","filename":"src/itsdangerous/encoding.py","id":"36"},{"content":"from __future__ import annotations\n\nimport typing as t\n\nfrom .encoding import base64_decode as base64_decode\nfrom .encoding import base64_encode as base64_encode\nfrom .encoding import want_bytes as want_bytes\nfrom .exc import BadData as BadData\nfrom .exc import BadHeader as BadHeader\nfrom .exc import BadPayload as BadPayload\nfrom .exc import BadSignature as BadSignature\nfrom .exc import BadTimeSignature as BadTimeSignature\nfrom .exc import SignatureExpired as SignatureExpired\nfrom .serializer import Serializer as Serializer\nfrom .signer import HMACAlgorithm as HMACAlgorithm\nfrom .signer import NoneAlgorithm as NoneAlgorithm\nfrom .signer import Signer as Signer\nfrom .timed import TimedSerializer as TimedSerializer\nfrom .timed import TimestampSigner as TimestampSigner\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\n\n\ndef __getattr__(name: str) -> t.Any:\n if name == \"__version__\":\n import importlib.metadata\n import warnings\n\n warnings.warn(\n \"The '__version__' attribute is deprecated and will be removed in\"\n \" ItsDangerous 2.3. Use feature detection or\"\n \" 'importlib.metadata.version(\\\"itsdangerous\\\")' instead.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return importlib.metadata.version(\"itsdangerous\")\n\n raise AttributeError(name)\n\n[end of src/itsdangerous/__init__.py]","filename":"src/itsdangerous/__init__.py","id":"37"},{"content":"from __future__ import annotations\n\nimport typing as t\nimport zlib\n\nfrom ._json import _CompactJSON\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .exc import BadPayload\nfrom .serializer import _PDataSerializer\nfrom .serializer import Serializer\nfrom .timed import TimedSerializer\n\n\nclass URLSafeSerializerMixin(Serializer[str]):\n \"\"\"Mixed in with a regular serializer it will attempt to zlib\n compress the string to make it shorter if necessary. It will also\n base64 encode the string so that it can safely be placed in a URL.\n \"\"\"\n\n default_serializer: _PDataSerializer[str] = _CompactJSON\n\n def load_payload(\n self,\n payload: bytes,\n *args: t.Any,\n serializer: t.Any | None = None,\n **kwargs: t.Any,\n ) -> t.Any:\n decompress = False\n\n if payload.startswith(b\".\"):\n payload = payload[1:]\n decompress = True\n\n try:\n json = base64_decode(payload)\n except Exception as e:\n raise BadPayload(\n \"Could not base64 decode the payload because of an exception\",\n original_error=e,\n ) from e\n\n if decompress:\n try:\n json = zlib.decompress(json)\n except Exception as e:\n raise BadPayload(\n \"Could not zlib decompress the payload before decoding the payload\",\n original_error=e,\n ) from e\n\n return super().load_payload(json, *args, **kwargs)\n\n def dump_payload(self, obj: t.Any) -> bytes:\n json = super().dump_payload(obj)\n is_compressed = False\n compressed = zlib.compress(json)\n\n if len(compressed) < (len(json) - 1):\n json = compressed\n is_compressed = True\n\n base64d = base64_encode(json)\n\n if is_compressed:\n base64d = b\".\" + base64d\n\n return base64d\n\n\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\n \"\"\"Works like :class:`.Serializer` but dumps and loads into a URL\n safe string consisting of the upper and lowercase character of the\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\n \"\"\"Works like :class:`.TimedSerializer` but dumps and loads into a\n URL safe string consisting of the upper and lowercase character of\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n[end of src/itsdangerous/url_safe.py]","filename":"src/itsdangerous/url_safe.py","id":"38"},{"content":"from __future__ import annotations\n\nimport typing as t\nfrom datetime import datetime\n\n\nclass BadData(Exception):\n \"\"\"Raised if bad data of any sort was encountered. This is the base\n for all exceptions that ItsDangerous defines.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str):\n super().__init__(message)\n self.message = message\n\n def __str__(self) -> str:\n return self.message\n\n\nclass BadSignature(BadData):\n \"\"\"Raised if a signature does not match.\"\"\"\n\n def __init__(self, message: str, payload: t.Any | None = None):\n super().__init__(message)\n\n #: The payload that failed the signature test. In some\n #: situations you might still want to inspect this, even if\n #: you know it was tampered with.\n #:\n #: .. versionadded:: 0.14\n self.payload: t.Any | None = payload\n\n\nclass BadTimeSignature(BadSignature):\n \"\"\"Raised if a time-based signature is invalid. This is a subclass\n of :class:`BadSignature`.\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n date_signed: datetime | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the signature expired this exposes the date of when the\n #: signature was created. This can be helpful in order to\n #: tell the user how long a link has been gone stale.\n #:\n #: .. versionchanged:: 2.0\n #: The datetime value is timezone-aware rather than naive.\n #:\n #: .. versionadded:: 0.14\n self.date_signed = date_signed\n\n\nclass SignatureExpired(BadTimeSignature):\n \"\"\"Raised if a signature timestamp is older than ``max_age``. This\n is a subclass of :exc:`BadTimeSignature`.\n \"\"\"\n\n\nclass BadHeader(BadSignature):\n \"\"\"Raised if a signed header is invalid in some form. This only\n happens for serializers that have a header that goes with the\n signature.\n\n .. versionadded:: 0.24\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n header: t.Any | None = None,\n original_error: Exception | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the header is actually available but just malformed it\n #: might be stored here.\n self.header: t.Any | None = header\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n\nclass BadPayload(BadData):\n \"\"\"Raised if a payload is invalid. This could happen if the payload\n is loaded despite an invalid signature, or if there is a mismatch\n between the serializer and deserializer. The original exception\n that occurred during loading is stored on as :attr:`original_error`.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str, original_error: Exception | None = None):\n super().__init__(message)\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n[end of src/itsdangerous/exc.py]","filename":"src/itsdangerous/exc.py","id":"39"},{"content":"[end of src/itsdangerous/py.typed]","filename":"src/itsdangerous/py.typed","id":"40"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport json\nimport typing as t\n\nfrom .encoding import want_bytes\nfrom .exc import BadPayload\nfrom .exc import BadSignature\nfrom .signer import _make_keys_list\nfrom .signer import Signer\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n # This should be either be str or bytes. To avoid having to specify the\n # bound type, it falls back to a union if structural matching fails.\n _TSerialized = te.TypeVar(\n \"_TSerialized\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\n )\nelse:\n # Still available at runtime on Python < 3.13, but without the default.\n _TSerialized = t.TypeVar(\"_TSerialized\", bound=t.Union[str, bytes])\n\n\nclass _PDataSerializer(t.Protocol[_TSerialized]):\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\n # A signature with additional arguments is not handled correctly by type\n # checkers right now, so an overload is used below for serializers that\n # don't match this strict protocol.\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\n\n\n# Use TypeIs once it's available in typing_extensions or 3.13.\ndef is_text_serializer(\n serializer: _PDataSerializer[t.Any],\n) -> te.TypeGuard[_PDataSerializer[str]]:\n \"\"\"Checks whether a serializer generates text or binary.\"\"\"\n return isinstance(serializer.dumps({}), str)\n\n\nclass Serializer(t.Generic[_TSerialized]):\n \"\"\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\n enable serializing and securely signing data other than bytes. It\n can unsign to verify that the data hasn't been changed.\n\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\n :mod:`json`, and by default uses :mod:`json` internally to serialize\n the data to bytes.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param serializer: An object that provides ``dumps`` and ``loads``\n methods for serializing data to a string. Defaults to\n :attr:`default_serializer`, which defaults to :mod:`json`.\n :param serializer_kwargs: Keyword arguments to pass when calling\n ``serializer.dumps``.\n :param signer: A ``Signer`` class to instantiate when signing data.\n Defaults to :attr:`default_signer`, which defaults to\n :class:`~itsdangerous.signer.Signer`.\n :param signer_kwargs: Keyword arguments to pass when instantiating\n the ``Signer`` class.\n :param fallback_signers: List of signer parameters to try when\n unsigning with the default signer fails. Each item can be a dict\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\n ``(signer, signer_kwargs)``. Defaults to\n :attr:`default_fallback_signers`.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 2.0\n Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``.\n\n .. versionchanged:: 1.1\n Added support for ``fallback_signers`` and configured a default\n SHA-512 fallback. This fallback is for users who used the yanked\n 1.0.0 release which defaulted to SHA-512.\n\n .. versionchanged:: 0.14\n The ``signer`` and ``signer_kwargs`` parameters were added to\n the constructor.\n \"\"\"\n\n #: The default serialization module to use to serialize data to a\n #: string internally. The default is :mod:`json`, but can be changed\n #: to any object that provides ``dumps`` and ``loads`` methods.\n default_serializer: _PDataSerializer[t.Any] = json\n\n #: The default ``Signer`` class to instantiate when signing data.\n #: The default is :class:`itsdangerous.signer.Signer`.\n default_signer: type[Signer] = Signer\n\n #: The default fallback signers to try when unsigning fails.\n default_fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = []\n\n # Serializer[str] if no data serializer is provided, or if it returns str.\n @t.overload\n def __init__(\n self: Serializer[str],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: None | _PDataSerializer[str] = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer positional argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer keyword argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a positional argument. If the strict signature of\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\n # to specify the type.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a keyword argument.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: t.Any | None = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n\n if salt is not None:\n salt = want_bytes(salt)\n # if salt is None then the signer's default is used\n\n self.salt = salt\n\n if serializer is None:\n serializer = self.default_serializer\n\n self.serializer: _PDataSerializer[_TSerialized] = serializer\n self.is_text_serializer: bool = is_text_serializer(serializer)\n\n if signer is None:\n signer = self.default_signer\n\n self.signer: type[Signer] = signer\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\n\n if fallback_signers is None:\n fallback_signers = list(self.default_fallback_signers)\n\n self.fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = fallback_signers\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def load_payload(\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\n ) -> t.Any:\n \"\"\"Loads the encoded object. This function raises\n :class:`.BadPayload` if the payload is not valid. The\n ``serializer`` parameter can be used to override the serializer\n stored on the class. The encoded ``payload`` should always be\n bytes.\n \"\"\"\n if serializer is None:\n use_serializer = self.serializer\n is_text = self.is_text_serializer\n else:\n use_serializer = serializer\n is_text = is_text_serializer(serializer)\n\n try:\n if is_text:\n return use_serializer.loads(payload.decode(\"utf-8\")) # type: ignore[arg-type]\n\n return use_serializer.loads(payload) # type: ignore[arg-type]\n except Exception as e:\n raise BadPayload(\n \"Could not load the payload because an exception\"\n \" occurred on unserializing the data.\",\n original_error=e,\n ) from e\n\n def dump_payload(self, obj: t.Any) -> bytes:\n \"\"\"Dumps the encoded object. The return value is always bytes.\n If the internal serializer returns text, the value will be\n encoded as UTF-8.\n \"\"\"\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\n\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\n \"\"\"Creates a new instance of the signer to be used. The default\n implementation uses the :class:`.Signer` base class.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\n\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\n \"\"\"Iterates over all signers to be tried for unsigning. Starts\n with the configured signer, then constructs each signer\n specified in ``fallback_signers``.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n yield self.make_signer(salt)\n\n for fallback in self.fallback_signers:\n if isinstance(fallback, dict):\n kwargs = fallback\n fallback = self.signer\n elif isinstance(fallback, tuple):\n fallback, kwargs = fallback\n else:\n kwargs = self.signer_kwargs\n\n for secret_key in self.secret_keys:\n yield fallback(secret_key, salt=salt, **kwargs)\n\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\n \"\"\"Returns a signed string serialized with the internal\n serializer. The return value can be either a byte or unicode\n string depending on the format of the internal serializer.\n \"\"\"\n payload = want_bytes(self.dump_payload(obj))\n rv = self.make_signer(salt).sign(payload)\n\n if self.is_text_serializer:\n return rv.decode(\"utf-8\") # type: ignore[return-value]\n\n return rv # type: ignore[return-value]\n\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\n \"\"\"Like :meth:`dumps` but dumps into a file. The file handle has\n to be compatible with what the internal serializer expects.\n \"\"\"\n f.write(self.dumps(obj, salt))\n\n def loads(\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\n signature validation fails.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n return self.load_payload(signer.unsign(s))\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\n \"\"\"Like :meth:`loads` but loads from a file.\"\"\"\n return self.loads(f.read(), salt)\n\n def loads_unsafe(\n self, s: str | bytes, salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads` but without verifying the signature. This\n is potentially very dangerous to use depending on how your\n serializer works. The return value is ``(signature_valid,\n payload)`` instead of just the payload. The first item will be a\n boolean that indicates if the signature is valid. This function\n never fails.\n\n Use it for debugging only and if you know that your serializer\n module is not exploitable (for example, do not use it with a\n pickle serializer).\n\n .. versionadded:: 0.15\n \"\"\"\n return self._loads_unsafe_impl(s, salt)\n\n def _loads_unsafe_impl(\n self,\n s: str | bytes,\n salt: str | bytes | None,\n load_kwargs: dict[str, t.Any] | None = None,\n load_payload_kwargs: dict[str, t.Any] | None = None,\n ) -> tuple[bool, t.Any]:\n \"\"\"Low level helper function to implement :meth:`loads_unsafe`\n in serializer subclasses.\n \"\"\"\n if load_kwargs is None:\n load_kwargs = {}\n\n try:\n return True, self.loads(s, salt=salt, **load_kwargs)\n except BadSignature as e:\n if e.payload is None:\n return False, None\n\n if load_payload_kwargs is None:\n load_payload_kwargs = {}\n\n try:\n return (\n False,\n self.load_payload(e.payload, **load_payload_kwargs),\n )\n except BadPayload:\n return False, None\n\n def load_unsafe(\n self, f: t.IO[t.Any], salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads_unsafe` but loads from a file.\n\n .. versionadded:: 0.15\n \"\"\"\n return self.loads_unsafe(f.read(), salt=salt)\n\n[end of src/itsdangerous/serializer.py]","filename":"src/itsdangerous/serializer.py","id":"41"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport hashlib\nimport hmac\nimport typing as t\n\nfrom .encoding import _base64_alphabet\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\n\n\nclass SigningAlgorithm:\n \"\"\"Subclasses must implement :meth:`get_signature` to provide\n signature generation functionality.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n \"\"\"Returns the signature for the given key and value.\"\"\"\n raise NotImplementedError()\n\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\n \"\"\"Verifies the given signature matches the expected\n signature.\n \"\"\"\n return hmac.compare_digest(sig, self.get_signature(key, value))\n\n\nclass NoneAlgorithm(SigningAlgorithm):\n \"\"\"Provides an algorithm that does not perform any signing and\n returns an empty signature.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n return b\"\"\n\n\ndef _lazy_sha1(string: bytes = b\"\") -> t.Any:\n \"\"\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\n SHA-1, in which case the import and use as a default would fail before the\n developer can configure something else.\n \"\"\"\n return hashlib.sha1(string)\n\n\nclass HMACAlgorithm(SigningAlgorithm):\n \"\"\"Provides signature generation using HMACs.\"\"\"\n\n #: The digest method to use with the MAC algorithm. This defaults to\n #: SHA1, but can be changed to any other function in the hashlib\n #: module.\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n def __init__(self, digest_method: t.Any = None):\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\n return mac.digest()\n\n\ndef _make_keys_list(\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n) -> list[bytes]:\n if isinstance(secret_key, (str, bytes)):\n return [want_bytes(secret_key)]\n\n return [want_bytes(s) for s in secret_key] # pyright: ignore\n\n\nclass Signer:\n \"\"\"A signer securely signs bytes, then unsigns them to verify that\n the value hasn't been changed.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param sep: Separator between the signature and value.\n :param key_derivation: How to derive the signing key from the secret\n key and salt. Possible values are ``concat``, ``django-concat``,\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\n defaults to ``django-concat``.\n :param digest_method: Hash function to use when generating the HMAC\n signature. Defaults to :attr:`default_digest_method`, which\n defaults to :func:`hashlib.sha1`. Note that the security of the\n hash alone doesn't apply when used intermediately in HMAC.\n :param algorithm: A :class:`SigningAlgorithm` instance to use\n instead of building a default :class:`HMACAlgorithm` with the\n ``digest_method``.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 0.18\n ``algorithm`` was added as an argument to the class constructor.\n\n .. versionchanged:: 0.14\n ``key_derivation`` and ``digest_method`` were added as arguments\n to the class constructor.\n \"\"\"\n\n #: The default digest method to use for the signer. The default is\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\n #: compatible object. Note that the security of the hash alone\n #: doesn't apply when used intermediately in HMAC.\n #:\n #: .. versionadded:: 0.14\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n #: The default scheme to use to derive the signing key from the\n #: secret key and salt. The default is ``django-concat``. Possible\n #: values are ``concat``, ``django-concat``, and ``hmac``.\n #:\n #: .. versionadded:: 0.14\n default_key_derivation: str = \"django-concat\"\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous.Signer\",\n sep: str | bytes = b\".\",\n key_derivation: str | None = None,\n digest_method: t.Any | None = None,\n algorithm: SigningAlgorithm | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n self.sep: bytes = want_bytes(sep)\n\n if self.sep in _base64_alphabet:\n raise ValueError(\n \"The given separator cannot be used because it may be\"\n \" contained in the signature itself. ASCII letters,\"\n \" digits, and '-_=' must not be used.\"\n )\n\n if salt is not None:\n salt = want_bytes(salt)\n else:\n salt = b\"itsdangerous.Signer\"\n\n self.salt = salt\n\n if key_derivation is None:\n key_derivation = self.default_key_derivation\n\n self.key_derivation: str = key_derivation\n\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n if algorithm is None:\n algorithm = HMACAlgorithm(self.digest_method)\n\n self.algorithm: SigningAlgorithm = algorithm\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\n \"\"\"This method is called to derive the key. The default key\n derivation choices can be overridden here. Key derivation is not\n intended to be used as a security method to make a complex key\n out of a short password. Instead you should use large random\n secret keys.\n\n :param secret_key: A specific secret key to derive from.\n Defaults to the last item in :attr:`secret_keys`.\n\n .. versionchanged:: 2.0\n Added the ``secret_key`` parameter.\n \"\"\"\n if secret_key is None:\n secret_key = self.secret_keys[-1]\n else:\n secret_key = want_bytes(secret_key)\n\n if self.key_derivation == \"concat\":\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\n elif self.key_derivation == \"django-concat\":\n return t.cast(\n bytes, self.digest_method(self.salt + b\"signer\" + secret_key).digest()\n )\n elif self.key_derivation == \"hmac\":\n mac = hmac.new(secret_key, digestmod=self.digest_method)\n mac.update(self.salt)\n return mac.digest()\n elif self.key_derivation == \"none\":\n return secret_key\n else:\n raise TypeError(\"Unknown key derivation method\")\n\n def get_signature(self, value: str | bytes) -> bytes:\n \"\"\"Returns the signature for the given value.\"\"\"\n value = want_bytes(value)\n key = self.derive_key()\n sig = self.algorithm.get_signature(key, value)\n return base64_encode(sig)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string.\"\"\"\n value = want_bytes(value)\n return value + self.sep + self.get_signature(value)\n\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\n \"\"\"Verifies the signature for the given value.\"\"\"\n try:\n sig = base64_decode(sig)\n except Exception:\n return False\n\n value = want_bytes(value)\n\n for secret_key in reversed(self.secret_keys):\n key = self.derive_key(secret_key)\n\n if self.algorithm.verify_signature(key, value, sig):\n return True\n\n return False\n\n def unsign(self, signed_value: str | bytes) -> bytes:\n \"\"\"Unsigns the given string.\"\"\"\n signed_value = want_bytes(signed_value)\n\n if self.sep not in signed_value:\n raise BadSignature(f\"No {self.sep!r} found in value\")\n\n value, sig = signed_value.rsplit(self.sep, 1)\n\n if self.verify_signature(value, sig):\n return value\n\n raise BadSignature(f\"Signature {sig!r} does not match\", payload=value)\n\n def validate(self, signed_value: str | bytes) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\n \"\"\"\n try:\n self.unsign(signed_value)\n return True\n except BadSignature:\n return False\n\n[end of src/itsdangerous/signer.py]","filename":"src/itsdangerous/signer.py","id":"42"}],"string":"[\n {\n \"content\": \"How to contribute to ItsDangerous\\n=================================\\n\\nThank you for considering contributing to ItsDangerous!\\n\\n\\nSupport questions\\n-----------------\\n\\nPlease don't use the issue tracker for this. The issue tracker is a\\ntool to address bugs and feature requests in ItsDangerous itself. Use\\none of the following resources for questions about using ItsDangerous or\\nissues with your own code:\\n\\n- The ``#get-help`` channel on our Discord chat:\\n https://discord.gg/pallets\\n- The mailing list flask@python.org for long term discussion or larger\\n issues.\\n- Ask on `Stack Overflow`_. Search with Google first using:\\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\\n\\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\\n\\n\\nReporting issues\\n----------------\\n\\nInclude the following information in your post:\\n\\n- Describe what you expected to happen.\\n- If possible, include a `minimal reproducible example`_ to help us\\n identify the issue. This also helps check that the issue is not with\\n your own code.\\n- Describe what actually happened. Include the full traceback if there\\n was an exception.\\n- List your Python and ItsDangerous versions. If possible, check if\\n this issue is already fixed in the latest releases or the latest\\n code in the repository.\\n\\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\\n\\n\\nSubmitting patches\\n------------------\\n\\nIf there is not an open issue for what you want to submit, prefer\\nopening one for discussion before working on a PR. You can work on any\\nissue that doesn't have an open PR linked to it or a maintainer assigned\\nto it. These show up in the sidebar. No need to ask if you can work on\\nan issue that interests you.\\n\\nInclude the following in your patch:\\n\\n- Use `Black`_ to format your code. This and other tools will run\\n automatically if you install `pre-commit`_ using the instructions\\n below.\\n- Include tests if your patch adds or changes code. Make sure the test\\n fails without your patch.\\n- Update any relevant docs pages and docstrings. Docs pages and\\n docstrings should be wrapped at 72 characters.\\n- Add an entry in ``CHANGES.rst``. Use the same style as other\\n entries. Also include ``.. versionchanged::`` inline changelogs in\\n relevant docstrings.\\n\\n.. _Black: https://black.readthedocs.io\\n.. _pre-commit: https://pre-commit.com\\n\\n\\nFirst time setup\\n~~~~~~~~~~~~~~~~\\n\\n- Download and install the `latest version of git`_.\\n- Configure git with your `username`_ and `email`_.\\n\\n .. code-block:: text\\n\\n $ git config --global user.name 'your name'\\n $ git config --global user.email 'your email'\\n\\n- Make sure you have a `GitHub account`_.\\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\\n button.\\n- `Clone`_ the main repository locally.\\n\\n .. code-block:: text\\n\\n $ git clone https://github.com/pallets/itsdangerous\\n $ cd itsdangerous\\n\\n- Add your fork as a remote to push your work to. Replace\\n ``{username}`` with your username. This names the remote \\\"fork\\\", the\\n default Pallets remote is \\\"origin\\\".\\n\\n .. code-block:: text\\n\\n $ git remote add fork https://github.com/{username}/itsdangerous\\n\\n- Create a virtualenv.\\n\\n .. code-block:: text\\n\\n $ python3 -m venv env\\n $ . env/bin/activate\\n\\n On Windows, activating is different.\\n\\n .. code-block:: text\\n\\n > env\\\\Scripts\\\\activate\\n\\n- Install the development dependencies, then install ItsDangerous in\\n editable mode.\\n\\n .. code-block:: text\\n\\n $ pip install -r requirements/dev.txt && pip install -e .\\n\\n- Install the pre-commit hooks.\\n\\n .. code-block:: text\\n\\n $ pre-commit install\\n\\n.. _latest version of git: https://git-scm.com/downloads\\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\\n.. _GitHub account: https://github.com/join\\n.. _Fork: https://github.com/pallets/itsdangerous/fork\\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\\n\\n\\nStart coding\\n~~~~~~~~~~~~\\n\\n- Create a branch to identify the issue you would like to work on. If\\n you're submitting a bug or documentation fix, branch off of the\\n latest \\\".x\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/2.0.x\\n\\n If you're submitting a feature addition or change, branch off of the\\n \\\"main\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/main\\n\\n- Using your favorite editor, make your changes,\\n `committing as you go`_.\\n- Include tests that cover any code changes you make. Make sure the\\n test fails without your patch. Run the tests as described below.\\n- Push your commits to your fork on GitHub and\\n `create a pull request`_. Link to the issue being addressed with\\n ``fixes #123`` in the pull request.\\n\\n .. code-block:: text\\n\\n $ git push --set-upstream fork your-branch-name\\n\\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\\n\\n\\nRunning the tests\\n~~~~~~~~~~~~~~~~~\\n\\nRun the basic test suite with pytest.\\n\\n.. code-block:: text\\n\\n $ pytest\\n\\nThis runs the tests for the current environment, which is usually\\nsufficient. CI will run the full suite when you submit your pull\\nrequest. You can run the full test suite with tox if you don't want to\\nwait.\\n\\n.. code-block:: text\\n\\n $ tox\\n\\n\\nRunning test coverage\\n~~~~~~~~~~~~~~~~~~~~~\\n\\nGenerating a report of lines that do not have test coverage can indicate\\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\\ngenerate a report.\\n\\n.. code-block:: text\\n\\n $ pip install coverage\\n $ coverage run -m pytest\\n $ coverage html\\n\\nOpen ``htmlcov/index.html`` in your browser to explore the report.\\n\\nRead more about `coverage <https://coverage.readthedocs.io>`__.\\n\\n\\nBuilding the docs\\n~~~~~~~~~~~~~~~~~\\n\\nBuild the docs in the ``docs`` directory using Sphinx.\\n\\n.. code-block:: text\\n\\n $ cd docs\\n $ make html\\n\\nOpen ``_build/html/index.html`` in your browser to view the docs.\\n\\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\\n\\n[end of CONTRIBUTING.rst]\",\n \"filename\": \"CONTRIBUTING.rst\",\n \"id\": \"0\"\n },\n {\n \"content\": \"repos:\\n - repo: https://github.com/astral-sh/ruff-pre-commit\\n rev: v0.7.1\\n hooks:\\n - id: ruff\\n - id: ruff-format\\n - repo: https://github.com/pre-commit/pre-commit-hooks\\n rev: v5.0.0\\n hooks:\\n - id: check-merge-conflict\\n - id: debug-statements\\n - id: fix-byte-order-marker\\n - id: trailing-whitespace\\n - id: end-of-file-fixer\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[project]\\nname = \\\"itsdangerous\\\"\\nversion = \\\"2.2.0\\\"\\ndescription = \\\"Safely pass data to untrusted environments and back.\\\"\\nreadme = \\\"README.md\\\"\\nlicense = { file = \\\"LICENSE.txt\\\" }\\nmaintainers = [{ name = \\\"Pallets\\\", email = \\\"contact@palletsprojects.com\\\" }]\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Typing :: Typed\\\",\\n]\\nrequires-python = \\\">=3.8\\\"\\n\\n[project.urls]\\nDonate = \\\"https://palletsprojects.com/donate\\\"\\nDocumentation = \\\"https://itsdangerous.palletsprojects.com/\\\"\\nChanges = \\\"https://itsdangerous.palletsprojects.com/changes/\\\"\\nSource = \\\"https://github.com/pallets/itsdangerous/\\\"\\nChat = \\\"https://discord.gg/pallets\\\"\\n\\n[build-system]\\nrequires = [\\\"flit_core<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.module]\\nname = \\\"itsdangerous\\\"\\n\\n[tool.flit.sdist]\\ninclude = [\\n \\\"docs/\\\",\\n \\\"requirements/\\\",\\n \\\"tests/\\\",\\n \\\"CHANGES.rst\\\",\\n \\\"tox.ini\\\",\\n]\\nexclude = [\\n \\\"docs/_build/\\\",\\n]\\n\\n[tool.pytest.ini_options]\\ntestpaths = [\\\"tests\\\"]\\nfilterwarnings = [\\n \\\"error\\\",\\n]\\n\\n[tool.coverage.run]\\nbranch = true\\nsource = [\\\"itsdangerous\\\", \\\"tests\\\"]\\n\\n[tool.coverage.paths]\\nsource = [\\\"src\\\", \\\"*/site-packages\\\"]\\n\\n[tool.mypy]\\npython_version = \\\"3.8\\\"\\nfiles = [\\\"src/itsdangerous\\\"]\\nshow_error_codes = true\\npretty = true\\nstrict = true\\n\\n[tool.pyright]\\npythonVersion = \\\"3.8\\\"\\ninclude = [\\\"src/itsdangerous\\\"]\\ntypeCheckingMode = \\\"basic\\\"\\n\\n[tool.ruff]\\nsrc = [\\\"src\\\"]\\nfix = true\\nshow-fixes = true\\noutput-format = \\\"full\\\"\\n\\n[tool.ruff.lint]\\nselect = [\\n \\\"B\\\", # flake8-bugbear\\n \\\"E\\\", # pycodestyle error\\n \\\"F\\\", # pyflakes\\n \\\"I\\\", # isort\\n \\\"UP\\\", # pyupgrade\\n \\\"W\\\", # pycodestyle warning\\n]\\n\\n[tool.ruff.lint.isort]\\nforce-single-line = true\\norder-by-type = false\\n\\n[tool.gha-update]\\ntag-only = [\\n \\\"slsa-framework/slsa-github-generator\\\",\\n]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\nindent_style = space\\nindent_size = 4\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\nend_of_line = lf\\ncharset = utf-8\\nmax_line_length = 88\\n\\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"3\"\n },\n {\n \"content\": \"# ItsDangerous\\n\\n... so better sign this\\n\\nVarious helpers to pass data to untrusted environments and to get it\\nback safe and sound. Data is cryptographically signed to ensure that a\\ntoken has not been tampered with.\\n\\nIt's possible to customize how data is serialized. Data is compressed as\\nneeded. A timestamp can be added and verified automatically while\\nloading a token.\\n\\n\\n## A Simple Example\\n\\nHere's how you could generate a token for transmitting a user's id and\\nname between web requests.\\n\\n```python\\nfrom itsdangerous import URLSafeSerializer\\nauth_s = URLSafeSerializer(\\\"secret key\\\", \\\"auth\\\")\\ntoken = auth_s.dumps({\\\"id\\\": 5, \\\"name\\\": \\\"itsdangerous\\\"})\\n\\nprint(token)\\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\\n\\ndata = auth_s.loads(token)\\nprint(data[\\\"name\\\"])\\n# itsdangerous\\n```\\n\\n\\n## Donate\\n\\nThe Pallets organization develops and supports ItsDangerous and other\\npopular packages. In order to grow the community of contributors and\\nusers, and allow the maintainers to devote more time to the projects,\\n[please donate today][].\\n\\n[please donate today]: https://palletsprojects.com/donate\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"[tox]\\nenvlist =\\n py3{13,12,11,10,9,8}\\n pypy310\\n style\\n typing\\n docs\\nskip_missing_interpreters = true\\n\\n[testenv]\\npackage = wheel\\nwheel_build_env = .pkg\\nconstrain_package_deps = true\\nuse_frozen_constraints = true\\ndeps = -r requirements/tests.txt\\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\\n\\n[testenv:style]\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit run --all-files\\n\\n[testenv:typing]\\ndeps = -r requirements/typing.txt\\ncommands =\\n mypy\\n pyright\\n pyright --verifytypes itsdangerous --ignoreexternal\\n\\n[testenv:docs]\\ndeps = -r requirements/docs.txt\\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\\n\\n[testenv:update-actions]\\nlabels = update\\ndeps = gha-update\\ncommands = gha-update\\n\\n[testenv:update-pre_commit]\\nlabels = update\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit autoupdate -j4\\n\\n[testenv:update-requirements]\\nlabels = update\\ndeps = pip-tools\\nskip_install = true\\nchange_dir = requirements\\ncommands =\\n pip-compile build.in -q {posargs:-U}\\n pip-compile docs.in -q {posargs:-U}\\n pip-compile tests.in -q {posargs:-U}\\n pip-compile typing.in -q {posargs:-U}\\n pip-compile dev.in -q {posargs:-U}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"5\"\n },\n {\n \"content\": \"Copyright 2011 Pallets\\n\\nRedistribution and use in source and binary forms, with or without\\nmodification, are permitted provided that the following conditions are\\nmet:\\n\\n1. Redistributions of source code must retain the above copyright\\n notice, this list of conditions and the following disclaimer.\\n\\n2. 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\\n3. Neither the name of the copyright holder nor the names of its\\n contributors may be used to endorse or promote products derived from\\n this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE.txt]\",\n \"filename\": \"LICENSE.txt\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Version 2.2.0\\n-------------\\n\\nReleased 2024-04-16\\n\\n- Drop support for Python 3.7. :pr:`372`\\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\\n :pr:`326`\\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\\n- Deprecate the ``__version__`` attribute. Use feature detection, or\\n ``importlib.metadata.version(\\\"itsdangerous\\\")``, instead. :issue:`371`\\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\\n different ``serializer`` argument is given, it will try to infer the return\\n type of its ``dumps`` method. :issue:`347`\\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\\n access it at import time so the developer has time to change the default.\\n :issue:`375`\\n\\n\\nVersion 2.1.2\\n-------------\\n\\nReleased 2022-03-24\\n\\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\\n\\n\\nVersion 2.1.1\\n-------------\\n\\nReleased 2022-03-09\\n\\n- Handle date overflow in timed unsign. :pr:`296`\\n\\n\\nVersion 2.1.0\\n-------------\\n\\nReleased 2022-02-17\\n\\n- Drop support for Python 3.6. :pr:`272`\\n- Remove previously deprecated code. :pr:`273`\\n\\n - JWS functionality: Use a dedicated library such as Authlib\\n instead.\\n - ``import itsdangerous.json``: Import ``json`` from the standard\\n library instead.\\n\\n\\nVersion 2.0.1\\n-------------\\n\\nReleased 2021-05-18\\n\\n- Mark top-level names as exported so type checking understands\\n imports in user projects. :pr:`240`\\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\\n ``None`` again. :issue:`237`\\n\\n\\nVersion 2.0.0\\n-------------\\n\\nReleased 2021-05-11\\n\\n- Drop support for Python 2 and 3.5.\\n- JWS support (``JSONWebSignatureSerializer``,\\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\\n JWS/JWT library such as authlib instead. :issue:`129`\\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\\n ``json`` module instead. :pr:`152`\\n- Simplejson is no longer used if it is installed. To use a different\\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\\n- If a signature has an age less than 0, it will raise\\n ``SignatureExpired`` rather than appearing valid. This can happen if\\n the timestamp offset is changed. :issue:`126`\\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\\n rather than an ``int`` in some cases. :issue:`124`\\n- Added support for key rotation. A list of keys can be passed as\\n ``secret_key``, oldest to newest. The newest key is used for\\n signing, all keys are tried for unsigning. :pr:`141`\\n- Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``. :issue:`155`\\n- Add type information for static typing tools. :pr:`186`\\n\\n\\nVersion 1.1.0\\n-------------\\n\\nReleased 2018-10-26\\n\\n- Change default signing algorithm back to SHA-1. :pr:`113`\\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\\n release which defaulted to SHA-512. :pr:`114`\\n- Add support for fallback algorithms during deserialization to\\n support changing the default in the future without breaking existing\\n signatures. :pr:`113`\\n- Changed capitalization of packages back to lowercase as the change\\n in capitalization broke some tooling. :pr:`113`\\n\\n\\nVersion 1.0.0\\n-------------\\n\\nReleased 2018-10-18\\n\\nYANKED\\n\\n*Note*: This release was yanked from PyPI because it changed the default\\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\\nat SHA1.\\n\\n- Drop support for Python 2.6 and 3.3.\\n- Refactor code from a single module to a package. Any object in the\\n API docs is still importable from the top-level ``itsdangerous``\\n name, but other imports will need to be changed. A future release\\n will remove many of these compatibility imports. :pr:`107`\\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\\n :pr:`27`\\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\\n Python 3. :issue:`29`\\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\\n- More compact JSON dumps for unicode strings. :issue:`38`\\n- Use the full timestamp rather than an offset, allowing dates before\\n 2011. :issue:`46`\\n\\n To retain compatibility with signers from previous versions,\\n consider using `this shim <https://github.com/pallets/itsdangerous\\n /issues/120#issuecomment-456913331>`_ when unsigning.\\n- Detect a ``sep`` character that may show up in the signature itself\\n and raise a ``ValueError``. :issue:`62`\\n- Use a consistent signature for keyword arguments for\\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\\n- Convert JWS exp header to an int when loading. :pr:`99`\\n\\n\\nVersion 0.24\\n------------\\n\\nReleased 2014-03-28\\n\\n- Added a ``BadHeader`` exception that is used for bad headers that\\n replaces the old ``BadPayload`` exception that was reused in those\\n cases.\\n\\n\\nVersion 0.23\\n------------\\n\\nReleased 2013-08-08\\n\\n- Fixed a packaging mistake that caused the tests and license files to\\n not be included.\\n\\n\\nVersion 0.22\\n------------\\n\\nReleased 2013-07-03\\n\\n- Added support for ``TimedJSONWebSignatureSerializer``.\\n- Made it possible to override the signature verification function to\\n allow implementing asymmetrical algorithms.\\n\\n\\nVersion 0.21\\n------------\\n\\nReleased 2013-05-26\\n\\n- Fixed an issue on Python 3 which caused invalid errors to be\\n generated.\\n\\n\\nVersion 0.20\\n------------\\n\\nReleased 2013-05-23\\n\\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\\n ItsDangerous on Python 2.6.\\n\\n\\nVersion 0.19\\n------------\\n\\nReleased 2013-05-21\\n\\n- Dropped support for 2.5 and added support for 3.3.\\n\\n\\nVersion 0.18\\n------------\\n\\nReleased 2013-05-03\\n\\n- Added support for JSON Web Signatures (JWS).\\n\\n\\nVersion 0.17\\n------------\\n\\nReleased 2012-08-10\\n\\n- Fixed a name error when overriding the digest method.\\n\\n\\nVersion 0.16\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made it possible to pass unicode values to ``load_payload`` to make\\n it easier to debug certain things.\\n\\n\\nVersion 0.15\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made standalone ``load_payload`` more robust by raising one specific\\n error if something goes wrong.\\n- Refactored exceptions to catch more cases individually, added more\\n attributes.\\n- Fixed an issue that caused ``load_payload`` not work in some\\n situations with timestamp based serializers\\n- Added an ``loads_unsafe`` method.\\n\\n\\nVersion 0.14\\n------------\\n\\nReleased 2012-06-29\\n\\n- API refactoring to support different key derivations.\\n- Added attributes to exceptions so that you can inspect the data even\\n if the signature check failed.\\n\\n\\nVersion 0.13\\n------------\\n\\nReleased 2012-06-10\\n\\n- Small API change that enables customization of the digest module.\\n\\n\\nVersion 0.12\\n------------\\n\\nReleased 2012-02-22\\n\\n- Fixed a problem with the local timezone being used for the epoch\\n calculation. This might invalidate some of your signatures if you\\n were not running in UTC timezone. You can revert to the old behavior\\n by monkey patching ``itsdangerous.EPOCH``.\\n\\n\\nVersion 0.11\\n------------\\n\\nReleased 2011-07-07\\n\\n- Fixed an uncaught value error.\\n\\n\\nVersion 0.10\\n------------\\n\\nReleased 2011-06-25\\n\\n- Refactored interface that the underlying serializers can be swapped\\n by passing in a module instead of having to override the payload\\n loaders and dumpers. This makes the interface more compatible with\\n Django's recent changes.\\n\\n[end of CHANGES.rst]\",\n \"filename\": \"CHANGES.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"version: 2\\nbuild:\\n os: ubuntu-22.04\\n tools:\\n python: '3.12'\\npython:\\n install:\\n - requirements: requirements/docs.txt\\n - method: pip\\n path: .\\nsphinx:\\n builder: dirhtml\\n fail_on_warning: true\\n\\n[end of .readthedocs.yaml]\",\n \"filename\": \".readthedocs.yaml\",\n \"id\": \"8\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile dev.in\\n#\\nalabaster==1.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nbabel==2.16.0\\n # via\\n # -r docs.txt\\n # sphinx\\ncachetools==5.5.0\\n # via tox\\ncertifi==2024.8.30\\n # via\\n # -r docs.txt\\n # requests\\ncfgv==3.4.0\\n # via pre-commit\\nchardet==5.2.0\\n # via tox\\ncharset-normalizer==3.4.0\\n # via\\n # -r docs.txt\\n # requests\\ncolorama==0.4.6\\n # via tox\\ndistlib==0.3.9\\n # via virtualenv\\ndocutils==0.21.2\\n # via\\n # -r docs.txt\\n # sphinx\\nfilelock==3.16.1\\n # via\\n # tox\\n # virtualenv\\nfreezegun==1.5.1\\n # via -r tests.txt\\nidentify==2.6.1\\n # via pre-commit\\nidna==3.10\\n # via\\n # -r docs.txt\\n # requests\\nimagesize==1.4.1\\n # via\\n # -r docs.txt\\n # sphinx\\niniconfig==2.0.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\njinja2==3.1.4\\n # via\\n # -r docs.txt\\n # sphinx\\nmarkupsafe==3.0.2\\n # via\\n # -r docs.txt\\n # jinja2\\nmypy==1.13.0\\n # via -r typing.txt\\nmypy-extensions==1.0.0\\n # via\\n # -r typing.txt\\n # mypy\\nnodeenv==1.9.1\\n # via\\n # -r typing.txt\\n # pre-commit\\n # pyright\\npackaging==24.1\\n # via\\n # -r docs.txt\\n # -r tests.txt\\n # -r typing.txt\\n # pallets-sphinx-themes\\n # pyproject-api\\n # pytest\\n # sphinx\\n # tox\\npallets-sphinx-themes==2.3.0\\n # via -r docs.txt\\nplatformdirs==4.3.6\\n # via\\n # tox\\n # virtualenv\\npluggy==1.5.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\n # tox\\npre-commit==4.0.1\\n # via -r dev.in\\npygments==2.18.0\\n # via\\n # -r docs.txt\\n # sphinx\\npyproject-api==1.8.0\\n # via tox\\npyright==1.1.386\\n # via -r typing.txt\\npytest==8.3.3\\n # via\\n # -r tests.txt\\n # -r typing.txt\\npython-dateutil==2.9.0.post0\\n # via\\n # -r tests.txt\\n # freezegun\\npyyaml==6.0.2\\n # via pre-commit\\nrequests==2.32.3\\n # via\\n # -r docs.txt\\n # sphinx\\nsix==1.16.0\\n # via\\n # -r tests.txt\\n # python-dateutil\\nsnowballstemmer==2.2.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.txt\\nsphinxcontrib-qthelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\ntox==4.23.2\\n # via -r dev.in\\ntyping-extensions==4.12.2\\n # via\\n # -r typing.txt\\n # mypy\\n # pyright\\nurllib3==2.2.3\\n # via\\n # -r docs.txt\\n # requests\\nvirtualenv==20.27.0\\n # via\\n # pre-commit\\n # tox\\n\\n[end of requirements/dev.txt]\",\n \"filename\": \"requirements/dev.txt\",\n \"id\": \"9\"\n },\n {\n \"content\": \"pallets-sphinx-themes\\nsphinx\\nsphinxcontrib-log-cabinet\\n\\n[end of requirements/docs.in]\",\n \"filename\": \"requirements/docs.in\",\n \"id\": \"10\"\n },\n {\n \"content\": \"build\\n\\n[end of requirements/build.in]\",\n \"filename\": \"requirements/build.in\",\n \"id\": \"11\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile typing.in\\n#\\niniconfig==2.0.0\\n # via pytest\\nmypy==1.13.0\\n # via -r typing.in\\nmypy-extensions==1.0.0\\n # via mypy\\nnodeenv==1.9.1\\n # via pyright\\npackaging==24.1\\n # via pytest\\npluggy==1.5.0\\n # via pytest\\npyright==1.1.386\\n # via -r typing.in\\npytest==8.3.3\\n # via -r typing.in\\ntyping-extensions==4.12.2\\n # via\\n # mypy\\n # pyright\\n\\n[end of requirements/typing.txt]\",\n \"filename\": \"requirements/typing.txt\",\n \"id\": \"12\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile build.in\\n#\\nbuild==1.2.2.post1\\n # via -r build.in\\npackaging==24.1\\n # via build\\npyproject-hooks==1.2.0\\n # via build\\n\\n[end of requirements/build.txt]\",\n \"filename\": \"requirements/build.txt\",\n \"id\": \"13\"\n },\n {\n \"content\": \"mypy\\npyright\\npytest\\n\\n[end of requirements/typing.in]\",\n \"filename\": \"requirements/typing.in\",\n \"id\": \"14\"\n },\n {\n \"content\": \"-r docs.txt\\n-r tests.txt\\n-r typing.txt\\npre-commit\\ntox\\n\\n[end of requirements/dev.in]\",\n \"filename\": \"requirements/dev.in\",\n \"id\": \"15\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile docs.in\\n#\\nalabaster==1.0.0\\n # via sphinx\\nbabel==2.16.0\\n # via sphinx\\ncertifi==2024.8.30\\n # via requests\\ncharset-normalizer==3.4.0\\n # via requests\\ndocutils==0.21.2\\n # via sphinx\\nidna==3.10\\n # via requests\\nimagesize==1.4.1\\n # via sphinx\\njinja2==3.1.4\\n # via sphinx\\nmarkupsafe==3.0.2\\n # via jinja2\\npackaging==24.1\\n # via\\n # pallets-sphinx-themes\\n # sphinx\\npallets-sphinx-themes==2.3.0\\n # via -r docs.in\\npygments==2.18.0\\n # via sphinx\\nrequests==2.32.3\\n # via sphinx\\nsnowballstemmer==2.2.0\\n # via sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.in\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.in\\nsphinxcontrib-qthelp==2.0.0\\n # via sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via sphinx\\nurllib3==2.2.3\\n # via requests\\n\\n[end of requirements/docs.txt]\",\n \"filename\": \"requirements/docs.txt\",\n \"id\": \"16\"\n },\n {\n \"content\": \".. rst-class:: hide-header\\n\\nItsDangerous\\n============\\n\\n.. image:: _static/itsdangerous-logo.png\\n :align: center\\n :target: https://palletsprojects.com/p/itsdangerous/\\n\\nSometimes you want to send some data to untrusted environments, then get\\nit back later. To do this safely, the data must be signed to detect\\nchanges.\\n\\nGiven a key only you know, you can cryptographically sign your data and\\nhand it over to someone else. When you get the data back you can ensure\\nthat nobody tampered with it.\\n\\nThe receiver can see the data, but they can not modify it unless they\\nalso have your key. So if you keep the key secret and complex, you will\\nbe fine.\\n\\n\\nInstalling\\n----------\\n\\nInstall and update using `pip`_:\\n\\n.. code-block:: text\\n\\n pip install -U itsdangerous\\n\\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\\n\\n\\nExample Use Cases\\n-----------------\\n\\n- Sign a user ID in a URL and email it to them to unsubscribe from a\\n newsletter. This way you don't need to generate one-time tokens and\\n store them in the database. Same thing with any kind of activation\\n link for accounts and similar things.\\n- Signed objects can be stored in cookies or other untrusted sources\\n which means you don't need to have sessions stored on the server,\\n which reduces the number of necessary database queries.\\n- Signed information can safely do a round trip between server and\\n client in general which makes them useful for passing server-side\\n state to a client and then back.\\n\\n\\nTable of Contents\\n-----------------\\n\\n.. toctree::\\n\\n concepts\\n serializer\\n signer\\n exceptions\\n timed\\n url_safe\\n encoding\\n license\\n changes\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"17\"\n },\n {\n \"content\": \".. module:: itsdangerous.serializer\\n\\nSerialization Interface\\n=======================\\n\\nThe :doc:`/signer` only signs bytes. To sign other types, the\\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\\nsimilar to Python's :mod:`json` module, which serializes the object to a\\nstring then signs that.\\n\\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n s = Serializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\\n\\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\\nthe data.\\n\\n.. code-block:: python\\n\\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\\n [1, 2, 3, 4]\\n\\nBy default, data is serialized to JSON with the built-in :mod:`json`\\nmodule. This internal serializer can be changed by subclassing.\\n\\nTo record and validate the age of the signature, see :doc:`/timed`.\\nTo serialize to a format that is safe to use in URLs, see\\n:doc:`/url_safe`.\\n\\n\\nResponding to Failure\\n---------------------\\n\\nExceptions have helpful attributes which allow you to inspect the\\npayload if the signature check failed. This has to be done with extra\\ncare because at that point you know that someone tampered with your data\\nbut it might be useful for debugging purposes.\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n from itsdangerous.exc import BadSignature, BadData\\n\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n decoded_payload = None\\n\\n try:\\n decoded_payload = s.loads(data)\\n # This payload is decoded and safe\\n except BadSignature as e:\\n if e.payload is not None:\\n try:\\n decoded_payload = s.load_payload(e.payload)\\n except BadData:\\n pass\\n # This payload is decoded but unsafe because someone\\n # tampered with the signature. The decode (load_payload)\\n # step is explicit because it might be unsafe to unserialize\\n # the payload (think pickle instead of json!)\\n\\nIf you don't want to inspect attributes to figure out what exactly went\\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\\n\\n.. code-block:: python\\n\\n sig_okay, payload = s.loads_unsafe(data)\\n\\nThe first item in the returned tuple is a boolean that indicates if the\\nsignature was correct.\\n\\n\\nFallback Signers\\n----------------\\n\\nYou may want to upgrade the signing parameters without invalidating\\nexisting signatures immediately. For example, you may decide that you\\nwant to use a different digest method. New signatures should use the new\\nmethod, but old signatures should still validate.\\n\\nA list of ``fallback_signers`` can be given that will be tried if\\nunsigning with the current signer fails. Each item in the list can be:\\n\\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\\n passed to the serializer.\\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\\n serializer.\\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\\n given class with the given args.\\n\\nFor example, this is a serializer that signs using SHA-512, but will\\nunsign using either SHA-512 or SHA-1:\\n\\n.. code-block:: python\\n\\n s = Serializer(\\n signer_kwargs={\\\"digest_method\\\": hashlib.sha512},\\n fallback_signers=[{\\\"digest_method\\\": hashlib.sha1}]\\n )\\n\\n\\n\\nAPI\\n---\\n\\n.. autoclass:: Serializer\\n :members:\\n\\n[end of docs/serializer.rst]\",\n \"filename\": \"docs/serializer.rst\",\n \"id\": \"18\"\n },\n {\n \"content\": \".. module:: itsdangerous.signer\\n\\nSigning Interface\\n=================\\n\\nThe most basic interface is the signing interface. The :class:`Signer`\\nclass can be used to attach a signature to a specific string:\\n\\n.. code-block:: python\\n\\n from itsdangerous import Signer\\n s = Signer(\\\"secret-key\\\")\\n s.sign(\\\"my string\\\")\\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\\n\\nThe signature is appended to the string, separated by a dot. To validate\\nthe string, use the :meth:`~Signer.unsign` method:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n b'my string'\\n\\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\\nHowever after unsigning you won't be able to tell if it was unicode or\\na bytestring.\\n\\nIf the value is changed, the signature will no longer match, and\\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nTo record and validate the age of a signature, see :doc:`/timed`.\\n\\n.. autoclass:: Signer\\n :members:\\n\\n\\nSigning Algorithms\\n------------------\\n\\n.. autoclass:: NoneAlgorithm\\n\\n.. autoclass:: HMACAlgorithm\\n\\n[end of docs/signer.rst]\",\n \"filename\": \"docs/signer.rst\",\n \"id\": \"19\"\n },\n {\n \"content\": \"General Concepts\\n================\\n\\n\\nSerializer vs Signer\\n--------------------\\n\\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\\nthe basic system that signs a given ``bytes`` value based on the given\\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\\nserializing and signing other data besides ``bytes``.\\n\\nTypically, you'll want to use a serializer, not a signer. You can\\nconfigure the signing parameters through the serializer, and even\\nprovide fallback signers to upgrade old tokens to new parameters.\\n\\n\\nThe Secret Key\\n--------------\\n\\nSignatures are secured by the ``secret_key``. Typically one secret key\\nis used with all signers, and the salt is used to distinguish different\\ncontexts. Changing the secret key will invalidate existing tokens.\\n\\nIt should be a long random string of bytes. This value must be kept\\nsecret and should not be saved in source code or committed to version\\ncontrol. If an attacker learns the secret key, they can change and\\nresign data to look valid. If you suspect this happened, change the\\nsecret key to invalidate existing tokens.\\n\\nOne way to keep the secret key separate is to read it from an\\nenvironment variable. When deploying for the first time, generate a key\\nand set the environment variable when running the application. All\\nprocess managers (like systemd) and hosting services have a way to\\nspecify environment variables.\\n\\n.. code-block:: python\\n\\n import os\\n from itsdangerous.serializer import Serializer\\n SECRET_KEY = os.environ.get(\\\"SECRET_KEY\\\")\\n s = Serializer(SECRET_KEY)\\n\\n.. code-block:: text\\n\\n $ export SECRET_KEY=\\\"base64 encoded random bytes\\\"\\n $ python application.py\\n\\nOne way to generate a key is to use :func:`os.urandom`.\\n\\n.. code-block:: text\\n\\n $ python3 -c 'import os; print(os.urandom(16).hex())'\\n\\n\\nThe Salt\\n--------\\n\\nThe salt is combined with the secret key to derive a unique key for\\ndistinguishing different contexts. Unlike the secret key, the salt\\ndoesn't have to be random, and can be saved in code. It only has to be\\nunique between contexts, not private.\\n\\nFor example, you want to email activation links to activate user\\naccounts, and upgrade links to upgrade users to a paid accounts. If all\\nyou sign is the user id, and you don't use different salts, a user could\\nreuse the token from the activation link to upgrade the account. If you\\nuse different salts, the signatures will be different and will not be\\nvalid in the other context.\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n\\n s1 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"activate\\\")\\n s1.dumps(42)\\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\\n\\n s2 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"upgrade\\\")\\n s2.dumps(42)\\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\\n\\nThe second serializer can't load data dumped with the first because the\\nsalts differ.\\n\\n.. code-block:: python\\n\\n s2.loads(s1.dumps(42))\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nOnly the serializer with the same salt can load the data.\\n\\n.. code-block:: python\\n\\n s2.loads(s2.dumps(42))\\n 42\\n\\n\\nKey Rotation\\n------------\\n\\nKey rotation can provide an extra layer of mitigation against an\\nattacker discovering a secret key. A rotation system will keep a list of\\nvalid keys, generating a new key and removing the oldest key\\nperiodically. If it takes four weeks for an attacker to crack a key, but\\nthe key is rotated out after three weeks, they will not be able to use\\nany keys they crack. However, if a user doesn't refresh their token\\nwithin three weeks it will be invalid too.\\n\\nThe system that generates and maintains this list is outside the scope\\nof ItsDangerous, but ItsDangerous does support validating against a list\\nof keys.\\n\\nInstead of passing a single key, you can pass a list of keys, oldest to\\nnewest. When signing the last (newest) key will be used, and when\\nvalidating each key will be tried from newest to oldest before raising\\na validation error.\\n\\n.. code-block:: python\\n\\n SECRET_KEYS = [\\\"2b9cd98e\\\", \\\"169d7886\\\", \\\"b6af09f5\\\"]\\n\\n # sign some data with the latest key\\n s = Serializer(SECRET_KEYS)\\n t = s.dumps({\\\"id\\\": 42})\\n\\n # rotate a new key in and the oldest key out\\n SECRET_KEYS.append(\\\"cf9b3588\\\")\\n del SECRET_KEYS[0]\\n\\n s = Serializer(SECRET_KEYS)\\n s.loads(t) # valid even though it was signed with a previous key\\n\\n\\nDigest Method Security\\n----------------------\\n\\nA signer is configured with a ``digest_method``, a hash function that\\nis used as an intermediate step when generating the HMAC signature. The\\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\\nconcerned about this default because they have heard about hash\\ncollisions with SHA-1.\\n\\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\\nhash alone doesn't apply when used in HMAC.\\n\\nIf a project considers SHA-1 a risk anyway, they can configure the\\nsigner with a different digest method such as :func:`hashlib.sha512`.\\nA fallback signer for SHA-1 can be configured so that old tokens will be\\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\\nspace, which is relevant in cookies and URLs.\\n\\n[end of docs/concepts.rst]\",\n \"filename\": \"docs/concepts.rst\",\n \"id\": \"20\"\n },\n {\n \"content\": \".. module:: itsdangerous.url_safe\\n\\nURL Safe Serialization\\n======================\\n\\nOften it is helpful if you can pass these trusted strings in places\\nwhere you only have a limited set of characters available. Because of\\nthis, ItsDangerous also provides URL safe serializers:\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\\n s.loads(\\\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\\\")\\n [1, 2, 3, 4]\\n\\n.. autoclass:: URLSafeSerializer\\n\\n.. autoclass:: URLSafeTimedSerializer\\n\\n[end of docs/url_safe.rst]\",\n \"filename\": \"docs/url_safe.rst\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. module:: itsdangerous.encoding\\n\\nEncoding Utilities\\n==================\\n\\n.. autofunction:: base64_encode\\n\\n.. autofunction:: base64_decode\\n\\n[end of docs/encoding.rst]\",\n \"filename\": \"docs/encoding.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"# Minimal makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nSOURCEDIR = .\\nBUILDDIR = _build\\n\\n# Put it first so that \\\"make\\\" without argument is like \\\"make help\\\".\\nhelp:\\n\\t@$(SPHINXBUILD) -M help \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n.PHONY: help Makefile\\n\\n# Catch-all target: route all unknown targets to Sphinx using the new\\n# \\\"make mode\\\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\\n%: Makefile\\n\\t@$(SPHINXBUILD) -M $@ \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"23\"\n },\n {\n \"content\": \"from pallets_sphinx_themes import get_version\\nfrom pallets_sphinx_themes import ProjectLink\\n\\n# Project --------------------------------------------------------------\\n\\nproject = \\\"ItsDangerous\\\"\\ncopyright = \\\"2011 Pallets\\\"\\nauthor = \\\"Pallets\\\"\\nrelease, version = get_version(\\\"itsdangerous\\\")\\n\\n# General --------------------------------------------------------------\\n\\ndefault_role = \\\"code\\\"\\nextensions = [\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"sphinx.ext.extlinks\\\",\\n \\\"sphinx.ext.intersphinx\\\",\\n \\\"sphinxcontrib.log_cabinet\\\",\\n \\\"pallets_sphinx_themes\\\",\\n]\\nautoclass_content = \\\"both\\\"\\nautodoc_member_order = \\\"bysource\\\"\\nautodoc_typehints = \\\"description\\\"\\nautodoc_preserve_defaults = True\\nextlinks = {\\n \\\"issue\\\": (\\\"https://github.com/pallets/itsdangerous/issues/%s\\\", \\\"#%s\\\"),\\n \\\"pr\\\": (\\\"https://github.com/pallets/itsdangerous/pull/%s\\\", \\\"#%s\\\"),\\n}\\nintersphinx_mapping = {\\n \\\"python\\\": (\\\"https://docs.python.org/3/\\\", None),\\n}\\n\\n# HTML -----------------------------------------------------------------\\n\\nhtml_theme = \\\"flask\\\"\\nhtml_theme_options = {\\\"index_sidebar_logo\\\": False}\\nhtml_context = {\\n \\\"project_links\\\": [\\n ProjectLink(\\\"Donate\\\", \\\"https://palletsprojects.com/donate\\\"),\\n ProjectLink(\\\"PyPI Releases\\\", \\\"https://pypi.org/project/itsdangerous/\\\"),\\n ProjectLink(\\\"Source Code\\\", \\\"https://github.com/pallets/itsdangerous/\\\"),\\n ProjectLink(\\\"Issue Tracker\\\", \\\"https://github.com/pallets/itsdangerous/issues/\\\"),\\n ProjectLink(\\\"Chat\\\", \\\"https://discord.gg/pallets\\\"),\\n ]\\n}\\nhtml_sidebars = {\\n \\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n \\\"**\\\": [\\\"localtoc.html\\\", \\\"relations.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n}\\nsinglehtml_sidebars = {\\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"ethicalads.html\\\"]}\\nhtml_static_path = [\\\"_static\\\"]\\nhtml_favicon = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_logo = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_title = f\\\"{project} Documentation ({version})\\\"\\nhtml_show_sourcelink = False\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\npushd %~dp0\\n\\nREM Command file for Sphinx documentation\\n\\nif \\\"%SPHINXBUILD%\\\" == \\\"\\\" (\\n\\tset SPHINXBUILD=sphinx-build\\n)\\nset SOURCEDIR=.\\nset BUILDDIR=_build\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\n%SPHINXBUILD% >NUL 2>NUL\\nif errorlevel 9009 (\\n\\techo.\\n\\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\\n\\techo.installed, then set the SPHINXBUILD environment variable to point\\n\\techo.to the full path of the 'sphinx-build' executable. Alternatively you\\n\\techo.may add the Sphinx directory to PATH.\\n\\techo.\\n\\techo.If you don't have Sphinx installed, grab it from\\n\\techo.http://sphinx-doc.org/\\n\\texit /b 1\\n)\\n\\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\ngoto end\\n\\n:help\\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\n\\n:end\\npopd\\n\\n[end of docs/make.bat]\",\n \"filename\": \"docs/make.bat\",\n \"id\": \"25\"\n },\n {\n \"content\": \".. module:: itsdangerous.timed\\n\\nSigning With Timestamps\\n=======================\\n\\nIf you want to expire signatures you can use the\\n:class:`TimestampSigner` class which adds timestamp information and\\nsigns it. On unsigning you can validate that the timestamp is not older\\nthan a given age.\\n\\n.. code-block:: python\\n\\n from itsdangerous import TimestampSigner\\n s = TimestampSigner('secret-key')\\n string = s.sign('foo')\\n\\n.. code-block:: python\\n\\n s.unsign(string, max_age=5)\\n Traceback (most recent call last):\\n ...\\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\\n\\n.. autoclass:: TimestampSigner\\n :members:\\n\\n.. autoclass:: TimedSerializer\\n :members:\\n\\n[end of docs/timed.rst]\",\n \"filename\": \"docs/timed.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"BSD-3-Clause License\\n====================\\n\\n.. literalinclude:: ../LICENSE.txt\\n :language: text\\n\\n[end of docs/license.rst]\",\n \"filename\": \"docs/license.rst\",\n \"id\": \"27\"\n },\n {\n \"content\": \"Changes\\n=======\\n\\n.. include:: ../CHANGES.rst\\n\\n[end of docs/changes.rst]\",\n \"filename\": \"docs/changes.rst\",\n \"id\": \"28\"\n },\n {\n \"content\": \".. module:: itsdangerous.exc\\n\\nExceptions\\n==========\\n\\n.. autoexception:: BadData\\n :members:\\n\\n.. autoexception:: BadSignature\\n :members:\\n\\n.. autoexception:: BadTimeSignature\\n :members:\\n\\n.. autoexception:: SignatureExpired\\n :members:\\n\\n.. autoexception:: BadHeader\\n :members:\\n\\n.. autoexception:: BadPayload\\n :members:\\n\\n[end of docs/exceptions.rst]\",\n \"filename\": \"docs/exceptions.rst\",\n \"id\": \"29\"\n },\n {\n \"content\": \"#!/bin/bash\\nset -e\\npython3 -m venv --upgrade-deps .venv\\n. .venv/bin/activate\\npip install -r requirements/dev.txt\\npip install -e .\\npre-commit install --install-hooks\\n\\n[end of .devcontainer/on-create-command.sh]\",\n \"filename\": \".devcontainer/on-create-command.sh\",\n \"id\": \"30\"\n },\n {\n \"content\": \"{\\n \\\"name\\\": \\\"pallets/itsdangerous\\\",\\n \\\"image\\\": \\\"mcr.microsoft.com/devcontainers/python:3\\\",\\n \\\"customizations\\\": {\\n \\\"vscode\\\": {\\n \\\"settings\\\": {\\n \\\"python.defaultInterpreterPath\\\": \\\"${workspaceFolder}/.venv\\\",\\n \\\"python.terminal.activateEnvInCurrentTerminal\\\": true,\\n \\\"python.terminal.launchArgs\\\": [\\n \\\"-X\\\",\\n \\\"dev\\\"\\n ]\\n }\\n }\\n },\\n \\\"onCreateCommand\\\": \\\".devcontainer/on-create-command.sh\\\"\\n}\\n\\n[end of .devcontainer/devcontainer.json]\",\n \"filename\": \".devcontainer/devcontainer.json\",\n \"id\": \"31\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo-sidebar.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo-sidebar.png\",\n \"id\": \"32\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo.png\",\n \"id\": \"33\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport json as _json\\nimport typing as t\\n\\n\\nclass _CompactJSON:\\n \\\"\\\"\\\"Wrapper around json module that strips whitespace.\\\"\\\"\\\"\\n\\n @staticmethod\\n def loads(payload: str | bytes) -> t.Any:\\n return _json.loads(payload)\\n\\n @staticmethod\\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\\n kwargs.setdefault(\\\"ensure_ascii\\\", False)\\n kwargs.setdefault(\\\"separators\\\", (\\\",\\\", \\\":\\\"))\\n return _json.dumps(obj, **kwargs)\\n\\n[end of src/itsdangerous/_json.py]\",\n \"filename\": \"src/itsdangerous/_json.py\",\n \"id\": \"34\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport time\\nimport typing as t\\nfrom datetime import datetime\\nfrom datetime import timezone\\n\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import bytes_to_int\\nfrom .encoding import int_to_bytes\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\nfrom .exc import BadTimeSignature\\nfrom .exc import SignatureExpired\\nfrom .serializer import _TSerialized\\nfrom .serializer import Serializer\\nfrom .signer import Signer\\n\\n\\nclass TimestampSigner(Signer):\\n \\\"\\\"\\\"Works like the regular :class:`.Signer` but also records the time\\n of the signing and can be used to expire signatures. The\\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\\n unsigning failed because the signature is expired.\\n \\\"\\\"\\\"\\n\\n def get_timestamp(self) -> int:\\n \\\"\\\"\\\"Returns the current timestamp. The function must return an\\n integer.\\n \\\"\\\"\\\"\\n return int(time.time())\\n\\n def timestamp_to_datetime(self, ts: int) -> datetime:\\n \\\"\\\"\\\"Convert the timestamp from :meth:`get_timestamp` into an\\n aware :class`datetime.datetime` in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n return datetime.fromtimestamp(ts, tz=timezone.utc)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string and also attaches time information.\\\"\\\"\\\"\\n value = want_bytes(value)\\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\\n sep = want_bytes(self.sep)\\n value = value + sep + timestamp\\n return value + sep + self.get_signature(value)\\n\\n # Ignore overlapping signatures check, return_timestamp is the only\\n # parameter that affects the return type.\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[False] = False,\\n ) -> bytes: ...\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[True] = True,\\n ) -> tuple[bytes, datetime]: ...\\n\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n ) -> tuple[bytes, datetime] | bytes:\\n \\\"\\\"\\\"Works like the regular :meth:`.Signer.unsign` but can also\\n validate the time. See the base docstring of the class for\\n the general behavior. If ``return_timestamp`` is ``True`` the\\n timestamp of the signature will be returned as an aware\\n :class:`datetime.datetime` object in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n try:\\n result = super().unsign(signed_value)\\n sig_error = None\\n except BadSignature as e:\\n sig_error = e\\n result = e.payload or b\\\"\\\"\\n\\n sep = want_bytes(self.sep)\\n\\n # If there is no timestamp in the result there is something\\n # seriously wrong. In case there was a signature error, we raise\\n # that one directly, otherwise we have a weird situation in\\n # which we shouldn't have come except someone uses a time-based\\n # serializer on non-timestamp data, so catch that.\\n if sep not in result:\\n if sig_error:\\n raise sig_error\\n\\n raise BadTimeSignature(\\\"timestamp missing\\\", payload=result)\\n\\n value, ts_bytes = result.rsplit(sep, 1)\\n ts_int: int | None = None\\n ts_dt: datetime | None = None\\n\\n try:\\n ts_int = bytes_to_int(base64_decode(ts_bytes))\\n except Exception:\\n pass\\n\\n # Signature is *not* okay. Raise a proper error now that we have\\n # split the value and the timestamp.\\n if sig_error is not None:\\n if ts_int is not None:\\n try:\\n ts_dt = self.timestamp_to_datetime(ts_int)\\n except (ValueError, OSError, OverflowError) as exc:\\n # Windows raises OSError\\n # 32-bit raises OverflowError\\n raise BadTimeSignature(\\n \\\"Malformed timestamp\\\", payload=value\\n ) from exc\\n\\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\\n\\n # Signature was okay but the timestamp is actually not there or\\n # malformed. Should not happen, but we handle it anyway.\\n if ts_int is None:\\n raise BadTimeSignature(\\\"Malformed timestamp\\\", payload=value)\\n\\n # Check timestamp is not older than max_age\\n if max_age is not None:\\n age = self.get_timestamp() - ts_int\\n\\n if age > max_age:\\n raise SignatureExpired(\\n f\\\"Signature age {age} > {max_age} seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if age < 0:\\n raise SignatureExpired(\\n f\\\"Signature age {age} < 0 seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if return_timestamp:\\n return value, self.timestamp_to_datetime(ts_int)\\n\\n return value\\n\\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\\"\\\"\\\"\\n try:\\n self.unsign(signed_value, max_age=max_age)\\n return True\\n except BadSignature:\\n return False\\n\\n\\nclass TimedSerializer(Serializer[_TSerialized]):\\n \\\"\\\"\\\"Uses :class:`TimestampSigner` instead of the default\\n :class:`.Signer`.\\n \\\"\\\"\\\"\\n\\n default_signer: type[TimestampSigner] = TimestampSigner\\n\\n def iter_unsigners(\\n self, salt: str | bytes | None = None\\n ) -> cabc.Iterator[TimestampSigner]:\\n return t.cast(\\\"cabc.Iterator[TimestampSigner]\\\", super().iter_unsigners(salt))\\n\\n # TODO: Signature is incompatible because parameters were added\\n # before salt.\\n\\n def loads( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n salt: str | bytes | None = None,\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\\n signature validation fails. If a ``max_age`` is provided it will\\n ensure the signature is not older than that time in seconds. In\\n case the signature is outdated, :exc:`.SignatureExpired` is\\n raised. All arguments are forwarded to the signer's\\n :meth:`~TimestampSigner.unsign` method.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n base64d, timestamp = signer.unsign(\\n s, max_age=max_age, return_timestamp=True\\n )\\n payload = self.load_payload(base64d)\\n\\n if return_timestamp:\\n return payload, timestamp\\n\\n return payload\\n except SignatureExpired:\\n # The signature was unsigned successfully but was\\n # expired. Do not try the next signer.\\n raise\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def loads_unsafe( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n salt: str | bytes | None = None,\\n ) -> tuple[bool, t.Any]:\\n return self._loads_unsafe_impl(s, salt, load_kwargs={\\\"max_age\\\": max_age})\\n\\n[end of src/itsdangerous/timed.py]\",\n \"filename\": \"src/itsdangerous/timed.py\",\n \"id\": \"35\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport base64\\nimport string\\nimport struct\\nimport typing as t\\n\\nfrom .exc import BadData\\n\\n\\ndef want_bytes(\\n s: str | bytes, encoding: str = \\\"utf-8\\\", errors: str = \\\"strict\\\"\\n) -> bytes:\\n if isinstance(s, str):\\n s = s.encode(encoding, errors)\\n\\n return s\\n\\n\\ndef base64_encode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 encode a string of bytes or text. The resulting bytes are\\n safe to use in URLs.\\n \\\"\\\"\\\"\\n string = want_bytes(string)\\n return base64.urlsafe_b64encode(string).rstrip(b\\\"=\\\")\\n\\n\\ndef base64_decode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 decode a URL-safe string of bytes or text. The result is\\n bytes.\\n \\\"\\\"\\\"\\n string = want_bytes(string, encoding=\\\"ascii\\\", errors=\\\"ignore\\\")\\n string += b\\\"=\\\" * (-len(string) % 4)\\n\\n try:\\n return base64.urlsafe_b64decode(string)\\n except (TypeError, ValueError) as e:\\n raise BadData(\\\"Invalid base64-encoded data\\\") from e\\n\\n\\n# The alphabet used by base64.urlsafe_*\\n_base64_alphabet = f\\\"{string.ascii_letters}{string.digits}-_=\\\".encode(\\\"ascii\\\")\\n\\n_int64_struct = struct.Struct(\\\">Q\\\")\\n_int_to_bytes = _int64_struct.pack\\n_bytes_to_int = t.cast(\\\"t.Callable[[bytes], tuple[int]]\\\", _int64_struct.unpack)\\n\\n\\ndef int_to_bytes(num: int) -> bytes:\\n return _int_to_bytes(num).lstrip(b\\\"\\\\x00\\\")\\n\\n\\ndef bytes_to_int(bytestr: bytes) -> int:\\n return _bytes_to_int(bytestr.rjust(8, b\\\"\\\\x00\\\"))[0]\\n\\n[end of src/itsdangerous/encoding.py]\",\n \"filename\": \"src/itsdangerous/encoding.py\",\n \"id\": \"36\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\n\\nfrom .encoding import base64_decode as base64_decode\\nfrom .encoding import base64_encode as base64_encode\\nfrom .encoding import want_bytes as want_bytes\\nfrom .exc import BadData as BadData\\nfrom .exc import BadHeader as BadHeader\\nfrom .exc import BadPayload as BadPayload\\nfrom .exc import BadSignature as BadSignature\\nfrom .exc import BadTimeSignature as BadTimeSignature\\nfrom .exc import SignatureExpired as SignatureExpired\\nfrom .serializer import Serializer as Serializer\\nfrom .signer import HMACAlgorithm as HMACAlgorithm\\nfrom .signer import NoneAlgorithm as NoneAlgorithm\\nfrom .signer import Signer as Signer\\nfrom .timed import TimedSerializer as TimedSerializer\\nfrom .timed import TimestampSigner as TimestampSigner\\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\\n\\n\\ndef __getattr__(name: str) -> t.Any:\\n if name == \\\"__version__\\\":\\n import importlib.metadata\\n import warnings\\n\\n warnings.warn(\\n \\\"The '__version__' attribute is deprecated and will be removed in\\\"\\n \\\" ItsDangerous 2.3. Use feature detection or\\\"\\n \\\" 'importlib.metadata.version(\\\\\\\"itsdangerous\\\\\\\")' instead.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return importlib.metadata.version(\\\"itsdangerous\\\")\\n\\n raise AttributeError(name)\\n\\n[end of src/itsdangerous/__init__.py]\",\n \"filename\": \"src/itsdangerous/__init__.py\",\n \"id\": \"37\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nimport zlib\\n\\nfrom ._json import _CompactJSON\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .exc import BadPayload\\nfrom .serializer import _PDataSerializer\\nfrom .serializer import Serializer\\nfrom .timed import TimedSerializer\\n\\n\\nclass URLSafeSerializerMixin(Serializer[str]):\\n \\\"\\\"\\\"Mixed in with a regular serializer it will attempt to zlib\\n compress the string to make it shorter if necessary. It will also\\n base64 encode the string so that it can safely be placed in a URL.\\n \\\"\\\"\\\"\\n\\n default_serializer: _PDataSerializer[str] = _CompactJSON\\n\\n def load_payload(\\n self,\\n payload: bytes,\\n *args: t.Any,\\n serializer: t.Any | None = None,\\n **kwargs: t.Any,\\n ) -> t.Any:\\n decompress = False\\n\\n if payload.startswith(b\\\".\\\"):\\n payload = payload[1:]\\n decompress = True\\n\\n try:\\n json = base64_decode(payload)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not base64 decode the payload because of an exception\\\",\\n original_error=e,\\n ) from e\\n\\n if decompress:\\n try:\\n json = zlib.decompress(json)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not zlib decompress the payload before decoding the payload\\\",\\n original_error=e,\\n ) from e\\n\\n return super().load_payload(json, *args, **kwargs)\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n json = super().dump_payload(obj)\\n is_compressed = False\\n compressed = zlib.compress(json)\\n\\n if len(compressed) < (len(json) - 1):\\n json = compressed\\n is_compressed = True\\n\\n base64d = base64_encode(json)\\n\\n if is_compressed:\\n base64d = b\\\".\\\" + base64d\\n\\n return base64d\\n\\n\\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\\n \\\"\\\"\\\"Works like :class:`.Serializer` but dumps and loads into a URL\\n safe string consisting of the upper and lowercase character of the\\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n\\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\\n \\\"\\\"\\\"Works like :class:`.TimedSerializer` but dumps and loads into a\\n URL safe string consisting of the upper and lowercase character of\\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n[end of src/itsdangerous/url_safe.py]\",\n \"filename\": \"src/itsdangerous/url_safe.py\",\n \"id\": \"38\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nfrom datetime import datetime\\n\\n\\nclass BadData(Exception):\\n \\\"\\\"\\\"Raised if bad data of any sort was encountered. This is the base\\n for all exceptions that ItsDangerous defines.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str):\\n super().__init__(message)\\n self.message = message\\n\\n def __str__(self) -> str:\\n return self.message\\n\\n\\nclass BadSignature(BadData):\\n \\\"\\\"\\\"Raised if a signature does not match.\\\"\\\"\\\"\\n\\n def __init__(self, message: str, payload: t.Any | None = None):\\n super().__init__(message)\\n\\n #: The payload that failed the signature test. In some\\n #: situations you might still want to inspect this, even if\\n #: you know it was tampered with.\\n #:\\n #: .. versionadded:: 0.14\\n self.payload: t.Any | None = payload\\n\\n\\nclass BadTimeSignature(BadSignature):\\n \\\"\\\"\\\"Raised if a time-based signature is invalid. This is a subclass\\n of :class:`BadSignature`.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n date_signed: datetime | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the signature expired this exposes the date of when the\\n #: signature was created. This can be helpful in order to\\n #: tell the user how long a link has been gone stale.\\n #:\\n #: .. versionchanged:: 2.0\\n #: The datetime value is timezone-aware rather than naive.\\n #:\\n #: .. versionadded:: 0.14\\n self.date_signed = date_signed\\n\\n\\nclass SignatureExpired(BadTimeSignature):\\n \\\"\\\"\\\"Raised if a signature timestamp is older than ``max_age``. This\\n is a subclass of :exc:`BadTimeSignature`.\\n \\\"\\\"\\\"\\n\\n\\nclass BadHeader(BadSignature):\\n \\\"\\\"\\\"Raised if a signed header is invalid in some form. This only\\n happens for serializers that have a header that goes with the\\n signature.\\n\\n .. versionadded:: 0.24\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n header: t.Any | None = None,\\n original_error: Exception | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the header is actually available but just malformed it\\n #: might be stored here.\\n self.header: t.Any | None = header\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n\\nclass BadPayload(BadData):\\n \\\"\\\"\\\"Raised if a payload is invalid. This could happen if the payload\\n is loaded despite an invalid signature, or if there is a mismatch\\n between the serializer and deserializer. The original exception\\n that occurred during loading is stored on as :attr:`original_error`.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str, original_error: Exception | None = None):\\n super().__init__(message)\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n[end of src/itsdangerous/exc.py]\",\n \"filename\": \"src/itsdangerous/exc.py\",\n \"id\": \"39\"\n },\n {\n \"content\": \"[end of src/itsdangerous/py.typed]\",\n \"filename\": \"src/itsdangerous/py.typed\",\n \"id\": \"40\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport json\\nimport typing as t\\n\\nfrom .encoding import want_bytes\\nfrom .exc import BadPayload\\nfrom .exc import BadSignature\\nfrom .signer import _make_keys_list\\nfrom .signer import Signer\\n\\nif t.TYPE_CHECKING:\\n import typing_extensions as te\\n\\n # This should be either be str or bytes. To avoid having to specify the\\n # bound type, it falls back to a union if structural matching fails.\\n _TSerialized = te.TypeVar(\\n \\\"_TSerialized\\\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\\n )\\nelse:\\n # Still available at runtime on Python < 3.13, but without the default.\\n _TSerialized = t.TypeVar(\\\"_TSerialized\\\", bound=t.Union[str, bytes])\\n\\n\\nclass _PDataSerializer(t.Protocol[_TSerialized]):\\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\\n # A signature with additional arguments is not handled correctly by type\\n # checkers right now, so an overload is used below for serializers that\\n # don't match this strict protocol.\\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\\n\\n\\n# Use TypeIs once it's available in typing_extensions or 3.13.\\ndef is_text_serializer(\\n serializer: _PDataSerializer[t.Any],\\n) -> te.TypeGuard[_PDataSerializer[str]]:\\n \\\"\\\"\\\"Checks whether a serializer generates text or binary.\\\"\\\"\\\"\\n return isinstance(serializer.dumps({}), str)\\n\\n\\nclass Serializer(t.Generic[_TSerialized]):\\n \\\"\\\"\\\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\\n enable serializing and securely signing data other than bytes. It\\n can unsign to verify that the data hasn't been changed.\\n\\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\\n :mod:`json`, and by default uses :mod:`json` internally to serialize\\n the data to bytes.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param serializer: An object that provides ``dumps`` and ``loads``\\n methods for serializing data to a string. Defaults to\\n :attr:`default_serializer`, which defaults to :mod:`json`.\\n :param serializer_kwargs: Keyword arguments to pass when calling\\n ``serializer.dumps``.\\n :param signer: A ``Signer`` class to instantiate when signing data.\\n Defaults to :attr:`default_signer`, which defaults to\\n :class:`~itsdangerous.signer.Signer`.\\n :param signer_kwargs: Keyword arguments to pass when instantiating\\n the ``Signer`` class.\\n :param fallback_signers: List of signer parameters to try when\\n unsigning with the default signer fails. Each item can be a dict\\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\\n ``(signer, signer_kwargs)``. Defaults to\\n :attr:`default_fallback_signers`.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 2.0\\n Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``.\\n\\n .. versionchanged:: 1.1\\n Added support for ``fallback_signers`` and configured a default\\n SHA-512 fallback. This fallback is for users who used the yanked\\n 1.0.0 release which defaulted to SHA-512.\\n\\n .. versionchanged:: 0.14\\n The ``signer`` and ``signer_kwargs`` parameters were added to\\n the constructor.\\n \\\"\\\"\\\"\\n\\n #: The default serialization module to use to serialize data to a\\n #: string internally. The default is :mod:`json`, but can be changed\\n #: to any object that provides ``dumps`` and ``loads`` methods.\\n default_serializer: _PDataSerializer[t.Any] = json\\n\\n #: The default ``Signer`` class to instantiate when signing data.\\n #: The default is :class:`itsdangerous.signer.Signer`.\\n default_signer: type[Signer] = Signer\\n\\n #: The default fallback signers to try when unsigning fails.\\n default_fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = []\\n\\n # Serializer[str] if no data serializer is provided, or if it returns str.\\n @t.overload\\n def __init__(\\n self: Serializer[str],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: None | _PDataSerializer[str] = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer positional argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer keyword argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a positional argument. If the strict signature of\\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\\n # to specify the type.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a keyword argument.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: t.Any | None = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n # if salt is None then the signer's default is used\\n\\n self.salt = salt\\n\\n if serializer is None:\\n serializer = self.default_serializer\\n\\n self.serializer: _PDataSerializer[_TSerialized] = serializer\\n self.is_text_serializer: bool = is_text_serializer(serializer)\\n\\n if signer is None:\\n signer = self.default_signer\\n\\n self.signer: type[Signer] = signer\\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\\n\\n if fallback_signers is None:\\n fallback_signers = list(self.default_fallback_signers)\\n\\n self.fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = fallback_signers\\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def load_payload(\\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\\n ) -> t.Any:\\n \\\"\\\"\\\"Loads the encoded object. This function raises\\n :class:`.BadPayload` if the payload is not valid. The\\n ``serializer`` parameter can be used to override the serializer\\n stored on the class. The encoded ``payload`` should always be\\n bytes.\\n \\\"\\\"\\\"\\n if serializer is None:\\n use_serializer = self.serializer\\n is_text = self.is_text_serializer\\n else:\\n use_serializer = serializer\\n is_text = is_text_serializer(serializer)\\n\\n try:\\n if is_text:\\n return use_serializer.loads(payload.decode(\\\"utf-8\\\")) # type: ignore[arg-type]\\n\\n return use_serializer.loads(payload) # type: ignore[arg-type]\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not load the payload because an exception\\\"\\n \\\" occurred on unserializing the data.\\\",\\n original_error=e,\\n ) from e\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n \\\"\\\"\\\"Dumps the encoded object. The return value is always bytes.\\n If the internal serializer returns text, the value will be\\n encoded as UTF-8.\\n \\\"\\\"\\\"\\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\\n\\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\\n \\\"\\\"\\\"Creates a new instance of the signer to be used. The default\\n implementation uses the :class:`.Signer` base class.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\\n\\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\\n \\\"\\\"\\\"Iterates over all signers to be tried for unsigning. Starts\\n with the configured signer, then constructs each signer\\n specified in ``fallback_signers``.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n yield self.make_signer(salt)\\n\\n for fallback in self.fallback_signers:\\n if isinstance(fallback, dict):\\n kwargs = fallback\\n fallback = self.signer\\n elif isinstance(fallback, tuple):\\n fallback, kwargs = fallback\\n else:\\n kwargs = self.signer_kwargs\\n\\n for secret_key in self.secret_keys:\\n yield fallback(secret_key, salt=salt, **kwargs)\\n\\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\\n \\\"\\\"\\\"Returns a signed string serialized with the internal\\n serializer. The return value can be either a byte or unicode\\n string depending on the format of the internal serializer.\\n \\\"\\\"\\\"\\n payload = want_bytes(self.dump_payload(obj))\\n rv = self.make_signer(salt).sign(payload)\\n\\n if self.is_text_serializer:\\n return rv.decode(\\\"utf-8\\\") # type: ignore[return-value]\\n\\n return rv # type: ignore[return-value]\\n\\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\\n \\\"\\\"\\\"Like :meth:`dumps` but dumps into a file. The file handle has\\n to be compatible with what the internal serializer expects.\\n \\\"\\\"\\\"\\n f.write(self.dumps(obj, salt))\\n\\n def loads(\\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\\n signature validation fails.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n return self.load_payload(signer.unsign(s))\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\\n \\\"\\\"\\\"Like :meth:`loads` but loads from a file.\\\"\\\"\\\"\\n return self.loads(f.read(), salt)\\n\\n def loads_unsafe(\\n self, s: str | bytes, salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads` but without verifying the signature. This\\n is potentially very dangerous to use depending on how your\\n serializer works. The return value is ``(signature_valid,\\n payload)`` instead of just the payload. The first item will be a\\n boolean that indicates if the signature is valid. This function\\n never fails.\\n\\n Use it for debugging only and if you know that your serializer\\n module is not exploitable (for example, do not use it with a\\n pickle serializer).\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self._loads_unsafe_impl(s, salt)\\n\\n def _loads_unsafe_impl(\\n self,\\n s: str | bytes,\\n salt: str | bytes | None,\\n load_kwargs: dict[str, t.Any] | None = None,\\n load_payload_kwargs: dict[str, t.Any] | None = None,\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Low level helper function to implement :meth:`loads_unsafe`\\n in serializer subclasses.\\n \\\"\\\"\\\"\\n if load_kwargs is None:\\n load_kwargs = {}\\n\\n try:\\n return True, self.loads(s, salt=salt, **load_kwargs)\\n except BadSignature as e:\\n if e.payload is None:\\n return False, None\\n\\n if load_payload_kwargs is None:\\n load_payload_kwargs = {}\\n\\n try:\\n return (\\n False,\\n self.load_payload(e.payload, **load_payload_kwargs),\\n )\\n except BadPayload:\\n return False, None\\n\\n def load_unsafe(\\n self, f: t.IO[t.Any], salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads_unsafe` but loads from a file.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self.loads_unsafe(f.read(), salt=salt)\\n\\n[end of src/itsdangerous/serializer.py]\",\n \"filename\": \"src/itsdangerous/serializer.py\",\n \"id\": \"41\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport hashlib\\nimport hmac\\nimport typing as t\\n\\nfrom .encoding import _base64_alphabet\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\n\\n\\nclass SigningAlgorithm:\\n \\\"\\\"\\\"Subclasses must implement :meth:`get_signature` to provide\\n signature generation functionality.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given key and value.\\\"\\\"\\\"\\n raise NotImplementedError()\\n\\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\\n \\\"\\\"\\\"Verifies the given signature matches the expected\\n signature.\\n \\\"\\\"\\\"\\n return hmac.compare_digest(sig, self.get_signature(key, value))\\n\\n\\nclass NoneAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides an algorithm that does not perform any signing and\\n returns an empty signature.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n return b\\\"\\\"\\n\\n\\ndef _lazy_sha1(string: bytes = b\\\"\\\") -> t.Any:\\n \\\"\\\"\\\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\\n SHA-1, in which case the import and use as a default would fail before the\\n developer can configure something else.\\n \\\"\\\"\\\"\\n return hashlib.sha1(string)\\n\\n\\nclass HMACAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides signature generation using HMACs.\\\"\\\"\\\"\\n\\n #: The digest method to use with the MAC algorithm. This defaults to\\n #: SHA1, but can be changed to any other function in the hashlib\\n #: module.\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n def __init__(self, digest_method: t.Any = None):\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\\n return mac.digest()\\n\\n\\ndef _make_keys_list(\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n) -> list[bytes]:\\n if isinstance(secret_key, (str, bytes)):\\n return [want_bytes(secret_key)]\\n\\n return [want_bytes(s) for s in secret_key] # pyright: ignore\\n\\n\\nclass Signer:\\n \\\"\\\"\\\"A signer securely signs bytes, then unsigns them to verify that\\n the value hasn't been changed.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param sep: Separator between the signature and value.\\n :param key_derivation: How to derive the signing key from the secret\\n key and salt. Possible values are ``concat``, ``django-concat``,\\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\\n defaults to ``django-concat``.\\n :param digest_method: Hash function to use when generating the HMAC\\n signature. Defaults to :attr:`default_digest_method`, which\\n defaults to :func:`hashlib.sha1`. Note that the security of the\\n hash alone doesn't apply when used intermediately in HMAC.\\n :param algorithm: A :class:`SigningAlgorithm` instance to use\\n instead of building a default :class:`HMACAlgorithm` with the\\n ``digest_method``.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 0.18\\n ``algorithm`` was added as an argument to the class constructor.\\n\\n .. versionchanged:: 0.14\\n ``key_derivation`` and ``digest_method`` were added as arguments\\n to the class constructor.\\n \\\"\\\"\\\"\\n\\n #: The default digest method to use for the signer. The default is\\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\\n #: compatible object. Note that the security of the hash alone\\n #: doesn't apply when used intermediately in HMAC.\\n #:\\n #: .. versionadded:: 0.14\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n #: The default scheme to use to derive the signing key from the\\n #: secret key and salt. The default is ``django-concat``. Possible\\n #: values are ``concat``, ``django-concat``, and ``hmac``.\\n #:\\n #: .. versionadded:: 0.14\\n default_key_derivation: str = \\\"django-concat\\\"\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous.Signer\\\",\\n sep: str | bytes = b\\\".\\\",\\n key_derivation: str | None = None,\\n digest_method: t.Any | None = None,\\n algorithm: SigningAlgorithm | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n self.sep: bytes = want_bytes(sep)\\n\\n if self.sep in _base64_alphabet:\\n raise ValueError(\\n \\\"The given separator cannot be used because it may be\\\"\\n \\\" contained in the signature itself. ASCII letters,\\\"\\n \\\" digits, and '-_=' must not be used.\\\"\\n )\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n else:\\n salt = b\\\"itsdangerous.Signer\\\"\\n\\n self.salt = salt\\n\\n if key_derivation is None:\\n key_derivation = self.default_key_derivation\\n\\n self.key_derivation: str = key_derivation\\n\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n if algorithm is None:\\n algorithm = HMACAlgorithm(self.digest_method)\\n\\n self.algorithm: SigningAlgorithm = algorithm\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\\n \\\"\\\"\\\"This method is called to derive the key. The default key\\n derivation choices can be overridden here. Key derivation is not\\n intended to be used as a security method to make a complex key\\n out of a short password. Instead you should use large random\\n secret keys.\\n\\n :param secret_key: A specific secret key to derive from.\\n Defaults to the last item in :attr:`secret_keys`.\\n\\n .. versionchanged:: 2.0\\n Added the ``secret_key`` parameter.\\n \\\"\\\"\\\"\\n if secret_key is None:\\n secret_key = self.secret_keys[-1]\\n else:\\n secret_key = want_bytes(secret_key)\\n\\n if self.key_derivation == \\\"concat\\\":\\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\\n elif self.key_derivation == \\\"django-concat\\\":\\n return t.cast(\\n bytes, self.digest_method(self.salt + b\\\"signer\\\" + secret_key).digest()\\n )\\n elif self.key_derivation == \\\"hmac\\\":\\n mac = hmac.new(secret_key, digestmod=self.digest_method)\\n mac.update(self.salt)\\n return mac.digest()\\n elif self.key_derivation == \\\"none\\\":\\n return secret_key\\n else:\\n raise TypeError(\\\"Unknown key derivation method\\\")\\n\\n def get_signature(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given value.\\\"\\\"\\\"\\n value = want_bytes(value)\\n key = self.derive_key()\\n sig = self.algorithm.get_signature(key, value)\\n return base64_encode(sig)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string.\\\"\\\"\\\"\\n value = want_bytes(value)\\n return value + self.sep + self.get_signature(value)\\n\\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\\n \\\"\\\"\\\"Verifies the signature for the given value.\\\"\\\"\\\"\\n try:\\n sig = base64_decode(sig)\\n except Exception:\\n return False\\n\\n value = want_bytes(value)\\n\\n for secret_key in reversed(self.secret_keys):\\n key = self.derive_key(secret_key)\\n\\n if self.algorithm.verify_signature(key, value, sig):\\n return True\\n\\n return False\\n\\n def unsign(self, signed_value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Unsigns the given string.\\\"\\\"\\\"\\n signed_value = want_bytes(signed_value)\\n\\n if self.sep not in signed_value:\\n raise BadSignature(f\\\"No {self.sep!r} found in value\\\")\\n\\n value, sig = signed_value.rsplit(self.sep, 1)\\n\\n if self.verify_signature(value, sig):\\n return value\\n\\n raise BadSignature(f\\\"Signature {sig!r} does not match\\\", payload=value)\\n\\n def validate(self, signed_value: str | bytes) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\n \\\"\\\"\\\"\\n try:\\n self.unsign(signed_value)\\n return True\\n except BadSignature:\\n return False\\n\\n[end of src/itsdangerous/signer.py]\",\n \"filename\": \"src/itsdangerous/signer.py\",\n \"id\": \"42\"\n }\n]","isConversational":false}}},{"rowIdx":76,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 76,\n \"num_files\": 43,\n \"repo_id\": \"repo_0076\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerous itself. Use\none of the following resources for questions about using ItsDangerous or\nissues with your own code:\n\n- The ``#get-help`` channel on our Discord chat:\n https://discord.gg/pallets\n- The mailing list flask@python.org for long term discussion or larger\n issues.\n- Ask on `Stack Overflow`_. Search with Google first using:\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\n\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\n\n\nReporting issues\n----------------\n\nInclude the following information in your post:\n\n- Describe what you expected to happen.\n- If possible, include a `minimal reproducible example`_ to help us\n identify the issue. This also helps check that the issue is not with\n your own code.\n- Describe what actually happened. Include the full traceback if there\n was an exception.\n- List your Python and ItsDangerous versions. If possible, check if\n this issue is already fixed in the latest releases or the latest\n code in the repository.\n\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\n\n\nSubmitting patches\n------------------\n\nIf there is not an open issue for what you want to submit, prefer\nopening one for discussion before working on a PR. You can work on any\nissue that doesn't have an open PR linked to it or a maintainer assigned\nto it. These show up in the sidebar. No need to ask if you can work on\nan issue that interests you.\n\nInclude the following in your patch:\n\n- Use `Black`_ to format your code. This and other tools will run\n automatically if you install `pre-commit`_ using the instructions\n below.\n- Include tests if your patch adds or changes code. Make sure the test\n fails without your patch.\n- Update any relevant docs pages and docstrings. Docs pages and\n docstrings should be wrapped at 72 characters.\n- Add an entry in ``CHANGES.rst``. Use the same style as other\n entries. Also include ``.. versionchanged::`` inline changelogs in\n relevant docstrings.\n\n.. _Black: https://black.readthedocs.io\n.. _pre-commit: https://pre-commit.com\n\n\nFirst time setup\n~~~~~~~~~~~~~~~~\n\n- Download and install the `latest version of git`_.\n- Configure git with your `username`_ and `email`_.\n\n .. code-block:: text\n\n $ git config --global user.name 'your name'\n $ git config --global user.email 'your email'\n\n- Make sure you have a `GitHub account`_.\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\n button.\n- `Clone`_ the main repository locally.\n\n .. code-block:: text\n\n $ git clone https://github.com/pallets/itsdangerous\n $ cd itsdangerous\n\n- Add your fork as a remote to push your work to. Replace\n ``{username}`` with your username. This names the remote \"fork\", the\n default Pallets remote is \"origin\".\n\n .. code-block:: text\n\n $ git remote add fork https://github.com/{username}/itsdangerous\n\n- Create a virtualenv.\n\n .. code-block:: text\n\n $ python3 -m venv env\n $ . env/bin/activate\n\n On Windows, activating is different.\n\n .. code-block:: text\n\n > env\\Scripts\\activate\n\n- Install the development dependencies, then install ItsDangerous in\n editable mode.\n\n .. code-block:: text\n\n $ pip install -r requirements/dev.txt && pip install -e .\n\n- Install the pre-commit hooks.\n\n .. code-block:: text\n\n $ pre-commit install\n\n.. _latest version of git: https://git-scm.com/downloads\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\n.. _GitHub account: https://github.com/join\n.. _Fork: https://github.com/pallets/itsdangerous/fork\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\n\n\nStart coding\n~~~~~~~~~~~~\n\n- Create a branch to identify the issue you would like to work on. If\n you're submitting a bug or documentation fix, branch off of the\n latest \".x\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/2.0.x\n\n If you're submitting a feature addition or change, branch off of the\n \"main\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/main\n\n- Using your favorite editor, make your changes,\n `committing as you go`_.\n- Include tests that cover any code changes you make. Make sure the\n test fails without your patch. Run the tests as described below.\n- Push your commits to your fork on GitHub and\n `create a pull request`_. Link to the issue being addressed with\n ``fixes #123`` in the pull request.\n\n .. code-block:: text\n\n $ git push --set-upstream fork your-branch-name\n\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\n\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nRun the basic test suite with pytest.\n\n.. code-block:: text\n\n $ pytest\n\nThis runs the tests for the current environment, which is usually\nsufficient. CI will run the full suite when you submit your pull\nrequest. You can run the full test suite with tox if you don't want to\nwait.\n\n.. code-block:: text\n\n $ tox\n\n\nRunning test coverage\n~~~~~~~~~~~~~~~~~~~~~\n\nGenerating a report of lines that do not have test coverage can indicate\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\ngenerate a report.\n\n.. code-block:: text\n\n $ pip install coverage\n $ coverage run -m pytest\n $ coverage html\n\nOpen ``htmlcov/index.html`` in your browser to explore the report.\n\nRead more about `coverage <https://coverage.readthedocs.io>`__.\n\n\nBuilding the docs\n~~~~~~~~~~~~~~~~~\n\nBuild the docs in the ``docs`` directory using Sphinx.\n\n.. code-block:: text\n\n $ cd docs\n $ make html\n\nOpen ``_build/html/index.html`` in your browser to view the docs.\n\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\n\n[end of CONTRIBUTING.rst]","filename":"CONTRIBUTING.rst","id":"0"},{"content":"repos:\n - repo: https://github.com/astral-sh/ruff-pre-commit\n rev: v0.7.1\n hooks:\n - id: ruff\n - id: ruff-format\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: check-merge-conflict\n - id: debug-statements\n - id: fix-byte-order-marker\n - id: trailing-whitespace\n - id: end-of-file-fixer\n\n[end of .pre-commit-config.yaml]","filename":".pre-commit-config.yaml","id":"1"},{"content":"[project]\nname = \"itsdangerous\"\nversion = \"2.2.0\"\ndescription = \"Safely pass data to untrusted environments and back.\"\nreadme = \"README.md\"\nlicense = { file = \"LICENSE.txt\" }\nmaintainers = [{ name = \"Pallets\", email = \"contact@palletsprojects.com\" }]\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python\",\n \"Typing :: Typed\",\n]\nrequires-python = \">=3.8\"\n\n[project.urls]\nDonate = \"https://palletsprojects.com/donate\"\nDocumentation = \"https://itsdangerous.palletsprojects.com/\"\nChanges = \"https://itsdangerous.palletsprojects.com/changes/\"\nSource = \"https://github.com/pallets/itsdangerous/\"\nChat = \"https://discord.gg/pallets\"\n\n[build-system]\nrequires = [\"flit_core<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.module]\nname = \"itsdangerous\"\n\n[tool.flit.sdist]\ninclude = [\n \"docs/\",\n \"requirements/\",\n \"tests/\",\n \"CHANGES.rst\",\n \"tox.ini\",\n]\nexclude = [\n \"docs/_build/\",\n]\n\n[tool.pytest.ini_options]\ntestpaths = [\"tests\"]\nfilterwarnings = [\n \"error\",\n]\n\n[tool.coverage.run]\nbranch = true\nsource = [\"itsdangerous\", \"tests\"]\n\n[tool.coverage.paths]\nsource = [\"src\", \"*/site-packages\"]\n\n[tool.mypy]\npython_version = \"3.8\"\nfiles = [\"src/itsdangerous\"]\nshow_error_codes = true\npretty = true\nstrict = true\n\n[tool.pyright]\npythonVersion = \"3.8\"\ninclude = [\"src/itsdangerous\"]\ntypeCheckingMode = \"basic\"\n\n[tool.ruff]\nsrc = [\"src\"]\nfix = true\nshow-fixes = true\noutput-format = \"full\"\n\n[tool.ruff.lint]\nselect = [\n \"B\", # flake8-bugbear\n \"E\", # pycodestyle error\n \"F\", # pyflakes\n \"I\", # isort\n \"UP\", # pyupgrade\n \"W\", # pycodestyle warning\n]\n\n[tool.ruff.lint.isort]\nforce-single-line = true\norder-by-type = false\n\n[tool.gha-update]\ntag-only = [\n \"slsa-framework/slsa-github-generator\",\n]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"root = true\n\n[*]\nindent_style = space\nindent_size = 4\ninsert_final_newline = true\ntrim_trailing_whitespace = true\nend_of_line = lf\ncharset = utf-8\nmax_line_length = 88\n\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"3"},{"content":"# ItsDangerous\n\n... so better sign this\n\nVarious helpers to pass data to untrusted environments and to get it\nback safe and sound. Data is cryptographically signed to ensure that a\ntoken has not been tampered with.\n\nIt's possible to customize how data is serialized. Data is compressed as\nneeded. A timestamp can be added and verified automatically while\nloading a token.\n\n\n## A Simple Example\n\nHere's how you could generate a token for transmitting a user's id and\nname between web requests.\n\n```python\nfrom itsdangerous import URLSafeSerializer\nauth_s = URLSafeSerializer(\"secret key\", \"auth\")\ntoken = auth_s.dumps({\"id\": 5, \"name\": \"itsdangerous\"})\n\nprint(token)\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\n\ndata = auth_s.loads(token)\nprint(data[\"name\"])\n# itsdangerous\n```\n\n\n## Donate\n\nThe Pallets organization develops and supports ItsDangerous and other\npopular packages. In order to grow the community of contributors and\nusers, and allow the maintainers to devote more time to the projects,\n[please donate today][].\n\n[please donate today]: https://palletsprojects.com/donate\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"[tox]\nenvlist =\n py3{13,12,11,10,9,8}\n pypy310\n style\n typing\n docs\nskip_missing_interpreters = true\n\n[testenv]\npackage = wheel\nwheel_build_env = .pkg\nconstrain_package_deps = true\nuse_frozen_constraints = true\ndeps = -r requirements/tests.txt\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\n\n[testenv:style]\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit run --all-files\n\n[testenv:typing]\ndeps = -r requirements/typing.txt\ncommands =\n mypy\n pyright\n pyright --verifytypes itsdangerous --ignoreexternal\n\n[testenv:docs]\ndeps = -r requirements/docs.txt\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\n\n[testenv:update-actions]\nlabels = update\ndeps = gha-update\ncommands = gha-update\n\n[testenv:update-pre_commit]\nlabels = update\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit autoupdate -j4\n\n[testenv:update-requirements]\nlabels = update\ndeps = pip-tools\nskip_install = true\nchange_dir = requirements\ncommands =\n pip-compile build.in -q {posargs:-U}\n pip-compile docs.in -q {posargs:-U}\n pip-compile tests.in -q {posargs:-U}\n pip-compile typing.in -q {posargs:-U}\n pip-compile dev.in -q {posargs:-U}\n\n[end of tox.ini]","filename":"tox.ini","id":"5"},{"content":"Copyright 2011 Pallets\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n1. Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n2. 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\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE.txt]","filename":"LICENSE.txt","id":"6"},{"content":"Version 2.2.0\n-------------\n\nReleased 2024-04-16\n\n- Drop support for Python 3.7. :pr:`372`\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\n :pr:`326`\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\n- Deprecate the ``__version__`` attribute. Use feature detection, or\n ``importlib.metadata.version(\"itsdangerous\")``, instead. :issue:`371`\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\n different ``serializer`` argument is given, it will try to infer the return\n type of its ``dumps`` method. :issue:`347`\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\n access it at import time so the developer has time to change the default.\n :issue:`375`\n\n\nVersion 2.1.2\n-------------\n\nReleased 2022-03-24\n\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\n\n\nVersion 2.1.1\n-------------\n\nReleased 2022-03-09\n\n- Handle date overflow in timed unsign. :pr:`296`\n\n\nVersion 2.1.0\n-------------\n\nReleased 2022-02-17\n\n- Drop support for Python 3.6. :pr:`272`\n- Remove previously deprecated code. :pr:`273`\n\n - JWS functionality: Use a dedicated library such as Authlib\n instead.\n - ``import itsdangerous.json``: Import ``json`` from the standard\n library instead.\n\n\nVersion 2.0.1\n-------------\n\nReleased 2021-05-18\n\n- Mark top-level names as exported so type checking understands\n imports in user projects. :pr:`240`\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\n ``None`` again. :issue:`237`\n\n\nVersion 2.0.0\n-------------\n\nReleased 2021-05-11\n\n- Drop support for Python 2 and 3.5.\n- JWS support (``JSONWebSignatureSerializer``,\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\n JWS/JWT library such as authlib instead. :issue:`129`\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\n ``json`` module instead. :pr:`152`\n- Simplejson is no longer used if it is installed. To use a different\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\n- If a signature has an age less than 0, it will raise\n ``SignatureExpired`` rather than appearing valid. This can happen if\n the timestamp offset is changed. :issue:`126`\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\n rather than an ``int`` in some cases. :issue:`124`\n- Added support for key rotation. A list of keys can be passed as\n ``secret_key``, oldest to newest. The newest key is used for\n signing, all keys are tried for unsigning. :pr:`141`\n- Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``. :issue:`155`\n- Add type information for static typing tools. :pr:`186`\n\n\nVersion 1.1.0\n-------------\n\nReleased 2018-10-26\n\n- Change default signing algorithm back to SHA-1. :pr:`113`\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\n release which defaulted to SHA-512. :pr:`114`\n- Add support for fallback algorithms during deserialization to\n support changing the default in the future without breaking existing\n signatures. :pr:`113`\n- Changed capitalization of packages back to lowercase as the change\n in capitalization broke some tooling. :pr:`113`\n\n\nVersion 1.0.0\n-------------\n\nReleased 2018-10-18\n\nYANKED\n\n*Note*: This release was yanked from PyPI because it changed the default\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\nat SHA1.\n\n- Drop support for Python 2.6 and 3.3.\n- Refactor code from a single module to a package. Any object in the\n API docs is still importable from the top-level ``itsdangerous``\n name, but other imports will need to be changed. A future release\n will remove many of these compatibility imports. :pr:`107`\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\n :pr:`27`\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\n Python 3. :issue:`29`\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\n- More compact JSON dumps for unicode strings. :issue:`38`\n- Use the full timestamp rather than an offset, allowing dates before\n 2011. :issue:`46`\n\n To retain compatibility with signers from previous versions,\n consider using `this shim <https://github.com/pallets/itsdangerous\n /issues/120#issuecomment-456913331>`_ when unsigning.\n- Detect a ``sep`` character that may show up in the signature itself\n and raise a ``ValueError``. :issue:`62`\n- Use a consistent signature for keyword arguments for\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\n- Convert JWS exp header to an int when loading. :pr:`99`\n\n\nVersion 0.24\n------------\n\nReleased 2014-03-28\n\n- Added a ``BadHeader`` exception that is used for bad headers that\n replaces the old ``BadPayload`` exception that was reused in those\n cases.\n\n\nVersion 0.23\n------------\n\nReleased 2013-08-08\n\n- Fixed a packaging mistake that caused the tests and license files to\n not be included.\n\n\nVersion 0.22\n------------\n\nReleased 2013-07-03\n\n- Added support for ``TimedJSONWebSignatureSerializer``.\n- Made it possible to override the signature verification function to\n allow implementing asymmetrical algorithms.\n\n\nVersion 0.21\n------------\n\nReleased 2013-05-26\n\n- Fixed an issue on Python 3 which caused invalid errors to be\n generated.\n\n\nVersion 0.20\n------------\n\nReleased 2013-05-23\n\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\n ItsDangerous on Python 2.6.\n\n\nVersion 0.19\n------------\n\nReleased 2013-05-21\n\n- Dropped support for 2.5 and added support for 3.3.\n\n\nVersion 0.18\n------------\n\nReleased 2013-05-03\n\n- Added support for JSON Web Signatures (JWS).\n\n\nVersion 0.17\n------------\n\nReleased 2012-08-10\n\n- Fixed a name error when overriding the digest method.\n\n\nVersion 0.16\n------------\n\nReleased 2012-07-11\n\n- Made it possible to pass unicode values to ``load_payload`` to make\n it easier to debug certain things.\n\n\nVersion 0.15\n------------\n\nReleased 2012-07-11\n\n- Made standalone ``load_payload`` more robust by raising one specific\n error if something goes wrong.\n- Refactored exceptions to catch more cases individually, added more\n attributes.\n- Fixed an issue that caused ``load_payload`` not work in some\n situations with timestamp based serializers\n- Added an ``loads_unsafe`` method.\n\n\nVersion 0.14\n------------\n\nReleased 2012-06-29\n\n- API refactoring to support different key derivations.\n- Added attributes to exceptions so that you can inspect the data even\n if the signature check failed.\n\n\nVersion 0.13\n------------\n\nReleased 2012-06-10\n\n- Small API change that enables customization of the digest module.\n\n\nVersion 0.12\n------------\n\nReleased 2012-02-22\n\n- Fixed a problem with the local timezone being used for the epoch\n calculation. This might invalidate some of your signatures if you\n were not running in UTC timezone. You can revert to the old behavior\n by monkey patching ``itsdangerous.EPOCH``.\n\n\nVersion 0.11\n------------\n\nReleased 2011-07-07\n\n- Fixed an uncaught value error.\n\n\nVersion 0.10\n------------\n\nReleased 2011-06-25\n\n- Refactored interface that the underlying serializers can be swapped\n by passing in a module instead of having to override the payload\n loaders and dumpers. This makes the interface more compatible with\n Django's recent changes.\n\n[end of CHANGES.rst]","filename":"CHANGES.rst","id":"7"},{"content":"version: 2\nbuild:\n os: ubuntu-22.04\n tools:\n python: '3.12'\npython:\n install:\n - requirements: requirements/docs.txt\n - method: pip\n path: .\nsphinx:\n builder: dirhtml\n fail_on_warning: true\n\n[end of .readthedocs.yaml]","filename":".readthedocs.yaml","id":"8"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile dev.in\n#\nalabaster==1.0.0\n # via\n # -r docs.txt\n # sphinx\nbabel==2.16.0\n # via\n # -r docs.txt\n # sphinx\ncachetools==5.5.0\n # via tox\ncertifi==2024.8.30\n # via\n # -r docs.txt\n # requests\ncfgv==3.4.0\n # via pre-commit\nchardet==5.2.0\n # via tox\ncharset-normalizer==3.4.0\n # via\n # -r docs.txt\n # requests\ncolorama==0.4.6\n # via tox\ndistlib==0.3.9\n # via virtualenv\ndocutils==0.21.2\n # via\n # -r docs.txt\n # sphinx\nfilelock==3.16.1\n # via\n # tox\n # virtualenv\nfreezegun==1.5.1\n # via -r tests.txt\nidentify==2.6.1\n # via pre-commit\nidna==3.10\n # via\n # -r docs.txt\n # requests\nimagesize==1.4.1\n # via\n # -r docs.txt\n # sphinx\niniconfig==2.0.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\njinja2==3.1.4\n # via\n # -r docs.txt\n # sphinx\nmarkupsafe==3.0.2\n # via\n # -r docs.txt\n # jinja2\nmypy==1.13.0\n # via -r typing.txt\nmypy-extensions==1.0.0\n # via\n # -r typing.txt\n # mypy\nnodeenv==1.9.1\n # via\n # -r typing.txt\n # pre-commit\n # pyright\npackaging==24.1\n # via\n # -r docs.txt\n # -r tests.txt\n # -r typing.txt\n # pallets-sphinx-themes\n # pyproject-api\n # pytest\n # sphinx\n # tox\npallets-sphinx-themes==2.3.0\n # via -r docs.txt\nplatformdirs==4.3.6\n # via\n # tox\n # virtualenv\npluggy==1.5.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\n # tox\npre-commit==4.0.1\n # via -r dev.in\npygments==2.18.0\n # via\n # -r docs.txt\n # sphinx\npyproject-api==1.8.0\n # via tox\npyright==1.1.386\n # via -r typing.txt\npytest==8.3.3\n # via\n # -r tests.txt\n # -r typing.txt\npython-dateutil==2.9.0.post0\n # via\n # -r tests.txt\n # freezegun\npyyaml==6.0.2\n # via pre-commit\nrequests==2.32.3\n # via\n # -r docs.txt\n # sphinx\nsix==1.16.0\n # via\n # -r tests.txt\n # python-dateutil\nsnowballstemmer==2.2.0\n # via\n # -r docs.txt\n # sphinx\nsphinx==8.1.3\n # via\n # -r docs.txt\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via\n # -r docs.txt\n # pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-devhelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-jsmath==1.0.1\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.txt\nsphinxcontrib-qthelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via\n # -r docs.txt\n # sphinx\ntox==4.23.2\n # via -r dev.in\ntyping-extensions==4.12.2\n # via\n # -r typing.txt\n # mypy\n # pyright\nurllib3==2.2.3\n # via\n # -r docs.txt\n # requests\nvirtualenv==20.27.0\n # via\n # pre-commit\n # tox\n\n[end of requirements/dev.txt]","filename":"requirements/dev.txt","id":"9"},{"content":"pallets-sphinx-themes\nsphinx\nsphinxcontrib-log-cabinet\n\n[end of requirements/docs.in]","filename":"requirements/docs.in","id":"10"},{"content":"build\n\n[end of requirements/build.in]","filename":"requirements/build.in","id":"11"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile typing.in\n#\niniconfig==2.0.0\n # via pytest\nmypy==1.13.0\n # via -r typing.in\nmypy-extensions==1.0.0\n # via mypy\nnodeenv==1.9.1\n # via pyright\npackaging==24.1\n # via pytest\npluggy==1.5.0\n # via pytest\npyright==1.1.386\n # via -r typing.in\npytest==8.3.3\n # via -r typing.in\ntyping-extensions==4.12.2\n # via\n # mypy\n # pyright\n\n[end of requirements/typing.txt]","filename":"requirements/typing.txt","id":"12"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile build.in\n#\nbuild==1.2.2.post1\n # via -r build.in\npackaging==24.1\n # via build\npyproject-hooks==1.2.0\n # via build\n\n[end of requirements/build.txt]","filename":"requirements/build.txt","id":"13"},{"content":"mypy\npyright\npytest\n\n[end of requirements/typing.in]","filename":"requirements/typing.in","id":"14"},{"content":"-r docs.txt\n-r tests.txt\n-r typing.txt\npre-commit\ntox\n\n[end of requirements/dev.in]","filename":"requirements/dev.in","id":"15"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile docs.in\n#\nalabaster==1.0.0\n # via sphinx\nbabel==2.16.0\n # via sphinx\ncertifi==2024.8.30\n # via requests\ncharset-normalizer==3.4.0\n # via requests\ndocutils==0.21.2\n # via sphinx\nidna==3.10\n # via requests\nimagesize==1.4.1\n # via sphinx\njinja2==3.1.4\n # via sphinx\nmarkupsafe==3.0.2\n # via jinja2\npackaging==24.1\n # via\n # pallets-sphinx-themes\n # sphinx\npallets-sphinx-themes==2.3.0\n # via -r docs.in\npygments==2.18.0\n # via sphinx\nrequests==2.32.3\n # via sphinx\nsnowballstemmer==2.2.0\n # via sphinx\nsphinx==8.1.3\n # via\n # -r docs.in\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via sphinx\nsphinxcontrib-devhelp==2.0.0\n # via sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via sphinx\nsphinxcontrib-jsmath==1.0.1\n # via sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.in\nsphinxcontrib-qthelp==2.0.0\n # via sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via sphinx\nurllib3==2.2.3\n # via requests\n\n[end of requirements/docs.txt]","filename":"requirements/docs.txt","id":"16"},{"content":".. rst-class:: hide-header\n\nItsDangerous\n============\n\n.. image:: _static/itsdangerous-logo.png\n :align: center\n :target: https://palletsprojects.com/p/itsdangerous/\n\nSometimes you want to send some data to untrusted environments, then get\nit back later. To do this safely, the data must be signed to detect\nchanges.\n\nGiven a key only you know, you can cryptographically sign your data and\nhand it over to someone else. When you get the data back you can ensure\nthat nobody tampered with it.\n\nThe receiver can see the data, but they can not modify it unless they\nalso have your key. So if you keep the key secret and complex, you will\nbe fine.\n\n\nInstalling\n----------\n\nInstall and update using `pip`_:\n\n.. code-block:: text\n\n pip install -U itsdangerous\n\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\n\n\nExample Use Cases\n-----------------\n\n- Sign a user ID in a URL and email it to them to unsubscribe from a\n newsletter. This way you don't need to generate one-time tokens and\n store them in the database. Same thing with any kind of activation\n link for accounts and similar things.\n- Signed objects can be stored in cookies or other untrusted sources\n which means you don't need to have sessions stored on the server,\n which reduces the number of necessary database queries.\n- Signed information can safely do a round trip between server and\n client in general which makes them useful for passing server-side\n state to a client and then back.\n\n\nTable of Contents\n-----------------\n\n.. toctree::\n\n concepts\n serializer\n signer\n exceptions\n timed\n url_safe\n encoding\n license\n changes\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"17"},{"content":".. module:: itsdangerous.serializer\n\nSerialization Interface\n=======================\n\nThe :doc:`/signer` only signs bytes. To sign other types, the\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\nsimilar to Python's :mod:`json` module, which serializes the object to a\nstring then signs that.\n\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n s = Serializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\n\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\nthe data.\n\n.. code-block:: python\n\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\n [1, 2, 3, 4]\n\nBy default, data is serialized to JSON with the built-in :mod:`json`\nmodule. This internal serializer can be changed by subclassing.\n\nTo record and validate the age of the signature, see :doc:`/timed`.\nTo serialize to a format that is safe to use in URLs, see\n:doc:`/url_safe`.\n\n\nResponding to Failure\n---------------------\n\nExceptions have helpful attributes which allow you to inspect the\npayload if the signature check failed. This has to be done with extra\ncare because at that point you know that someone tampered with your data\nbut it might be useful for debugging purposes.\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n from itsdangerous.exc import BadSignature, BadData\n\n s = URLSafeSerializer(\"secret-key\")\n decoded_payload = None\n\n try:\n decoded_payload = s.loads(data)\n # This payload is decoded and safe\n except BadSignature as e:\n if e.payload is not None:\n try:\n decoded_payload = s.load_payload(e.payload)\n except BadData:\n pass\n # This payload is decoded but unsafe because someone\n # tampered with the signature. The decode (load_payload)\n # step is explicit because it might be unsafe to unserialize\n # the payload (think pickle instead of json!)\n\nIf you don't want to inspect attributes to figure out what exactly went\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\n\n.. code-block:: python\n\n sig_okay, payload = s.loads_unsafe(data)\n\nThe first item in the returned tuple is a boolean that indicates if the\nsignature was correct.\n\n\nFallback Signers\n----------------\n\nYou may want to upgrade the signing parameters without invalidating\nexisting signatures immediately. For example, you may decide that you\nwant to use a different digest method. New signatures should use the new\nmethod, but old signatures should still validate.\n\nA list of ``fallback_signers`` can be given that will be tried if\nunsigning with the current signer fails. Each item in the list can be:\n\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\n passed to the serializer.\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\n serializer.\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\n given class with the given args.\n\nFor example, this is a serializer that signs using SHA-512, but will\nunsign using either SHA-512 or SHA-1:\n\n.. code-block:: python\n\n s = Serializer(\n signer_kwargs={\"digest_method\": hashlib.sha512},\n fallback_signers=[{\"digest_method\": hashlib.sha1}]\n )\n\n\n\nAPI\n---\n\n.. autoclass:: Serializer\n :members:\n\n[end of docs/serializer.rst]","filename":"docs/serializer.rst","id":"18"},{"content":".. module:: itsdangerous.signer\n\nSigning Interface\n=================\n\nThe most basic interface is the signing interface. The :class:`Signer`\nclass can be used to attach a signature to a specific string:\n\n.. code-block:: python\n\n from itsdangerous import Signer\n s = Signer(\"secret-key\")\n s.sign(\"my string\")\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\n\nThe signature is appended to the string, separated by a dot. To validate\nthe string, use the :meth:`~Signer.unsign` method:\n\n.. code-block:: python\n\n s.unsign(b\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n b'my string'\n\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\nHowever after unsigning you won't be able to tell if it was unicode or\na bytestring.\n\nIf the value is changed, the signature will no longer match, and\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\n\n.. code-block:: python\n\n s.unsign(b\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nTo record and validate the age of a signature, see :doc:`/timed`.\n\n.. autoclass:: Signer\n :members:\n\n\nSigning Algorithms\n------------------\n\n.. autoclass:: NoneAlgorithm\n\n.. autoclass:: HMACAlgorithm\n\n[end of docs/signer.rst]","filename":"docs/signer.rst","id":"19"},{"content":"General Concepts\n================\n\n\nSerializer vs Signer\n--------------------\n\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\nthe basic system that signs a given ``bytes`` value based on the given\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\nserializing and signing other data besides ``bytes``.\n\nTypically, you'll want to use a serializer, not a signer. You can\nconfigure the signing parameters through the serializer, and even\nprovide fallback signers to upgrade old tokens to new parameters.\n\n\nThe Secret Key\n--------------\n\nSignatures are secured by the ``secret_key``. Typically one secret key\nis used with all signers, and the salt is used to distinguish different\ncontexts. Changing the secret key will invalidate existing tokens.\n\nIt should be a long random string of bytes. This value must be kept\nsecret and should not be saved in source code or committed to version\ncontrol. If an attacker learns the secret key, they can change and\nresign data to look valid. If you suspect this happened, change the\nsecret key to invalidate existing tokens.\n\nOne way to keep the secret key separate is to read it from an\nenvironment variable. When deploying for the first time, generate a key\nand set the environment variable when running the application. All\nprocess managers (like systemd) and hosting services have a way to\nspecify environment variables.\n\n.. code-block:: python\n\n import os\n from itsdangerous.serializer import Serializer\n SECRET_KEY = os.environ.get(\"SECRET_KEY\")\n s = Serializer(SECRET_KEY)\n\n.. code-block:: text\n\n $ export SECRET_KEY=\"base64 encoded random bytes\"\n $ python application.py\n\nOne way to generate a key is to use :func:`os.urandom`.\n\n.. code-block:: text\n\n $ python3 -c 'import os; print(os.urandom(16).hex())'\n\n\nThe Salt\n--------\n\nThe salt is combined with the secret key to derive a unique key for\ndistinguishing different contexts. Unlike the secret key, the salt\ndoesn't have to be random, and can be saved in code. It only has to be\nunique between contexts, not private.\n\nFor example, you want to email activation links to activate user\naccounts, and upgrade links to upgrade users to a paid accounts. If all\nyou sign is the user id, and you don't use different salts, a user could\nreuse the token from the activation link to upgrade the account. If you\nuse different salts, the signatures will be different and will not be\nvalid in the other context.\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n\n s1 = URLSafeSerializer(\"secret-key\", salt=\"activate\")\n s1.dumps(42)\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\n\n s2 = URLSafeSerializer(\"secret-key\", salt=\"upgrade\")\n s2.dumps(42)\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\n\nThe second serializer can't load data dumped with the first because the\nsalts differ.\n\n.. code-block:: python\n\n s2.loads(s1.dumps(42))\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nOnly the serializer with the same salt can load the data.\n\n.. code-block:: python\n\n s2.loads(s2.dumps(42))\n 42\n\n\nKey Rotation\n------------\n\nKey rotation can provide an extra layer of mitigation against an\nattacker discovering a secret key. A rotation system will keep a list of\nvalid keys, generating a new key and removing the oldest key\nperiodically. If it takes four weeks for an attacker to crack a key, but\nthe key is rotated out after three weeks, they will not be able to use\nany keys they crack. However, if a user doesn't refresh their token\nwithin three weeks it will be invalid too.\n\nThe system that generates and maintains this list is outside the scope\nof ItsDangerous, but ItsDangerous does support validating against a list\nof keys.\n\nInstead of passing a single key, you can pass a list of keys, oldest to\nnewest. When signing the last (newest) key will be used, and when\nvalidating each key will be tried from newest to oldest before raising\na validation error.\n\n.. code-block:: python\n\n SECRET_KEYS = [\"2b9cd98e\", \"169d7886\", \"b6af09f5\"]\n\n # sign some data with the latest key\n s = Serializer(SECRET_KEYS)\n t = s.dumps({\"id\": 42})\n\n # rotate a new key in and the oldest key out\n SECRET_KEYS.append(\"cf9b3588\")\n del SECRET_KEYS[0]\n\n s = Serializer(SECRET_KEYS)\n s.loads(t) # valid even though it was signed with a previous key\n\n\nDigest Method Security\n----------------------\n\nA signer is configured with a ``digest_method``, a hash function that\nis used as an intermediate step when generating the HMAC signature. The\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\nconcerned about this default because they have heard about hash\ncollisions with SHA-1.\n\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\nhash alone doesn't apply when used in HMAC.\n\nIf a project considers SHA-1 a risk anyway, they can configure the\nsigner with a different digest method such as :func:`hashlib.sha512`.\nA fallback signer for SHA-1 can be configured so that old tokens will be\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\nspace, which is relevant in cookies and URLs.\n\n[end of docs/concepts.rst]","filename":"docs/concepts.rst","id":"20"},{"content":".. module:: itsdangerous.url_safe\n\nURL Safe Serialization\n======================\n\nOften it is helpful if you can pass these trusted strings in places\nwhere you only have a limited set of characters available. Because of\nthis, ItsDangerous also provides URL safe serializers:\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n s = URLSafeSerializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\n s.loads(\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\")\n [1, 2, 3, 4]\n\n.. autoclass:: URLSafeSerializer\n\n.. autoclass:: URLSafeTimedSerializer\n\n[end of docs/url_safe.rst]","filename":"docs/url_safe.rst","id":"21"},{"content":".. module:: itsdangerous.encoding\n\nEncoding Utilities\n==================\n\n.. autofunction:: base64_encode\n\n.. autofunction:: base64_decode\n\n[end of docs/encoding.rst]","filename":"docs/encoding.rst","id":"22"},{"content":"# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSOURCEDIR = .\nBUILDDIR = _build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"23"},{"content":"from pallets_sphinx_themes import get_version\nfrom pallets_sphinx_themes import ProjectLink\n\n# Project --------------------------------------------------------------\n\nproject = \"ItsDangerous\"\ncopyright = \"2011 Pallets\"\nauthor = \"Pallets\"\nrelease, version = get_version(\"itsdangerous\")\n\n# General --------------------------------------------------------------\n\ndefault_role = \"code\"\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.extlinks\",\n \"sphinx.ext.intersphinx\",\n \"sphinxcontrib.log_cabinet\",\n \"pallets_sphinx_themes\",\n]\nautoclass_content = \"both\"\nautodoc_member_order = \"bysource\"\nautodoc_typehints = \"description\"\nautodoc_preserve_defaults = True\nextlinks = {\n \"issue\": (\"https://github.com/pallets/itsdangerous/issues/%s\", \"#%s\"),\n \"pr\": (\"https://github.com/pallets/itsdangerous/pull/%s\", \"#%s\"),\n}\nintersphinx_mapping = {\n \"python\": (\"https://docs.python.org/3/\", None),\n}\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = \"flask\"\nhtml_theme_options = {\"index_sidebar_logo\": False}\nhtml_context = {\n \"project_links\": [\n ProjectLink(\"Donate\", \"https://palletsprojects.com/donate\"),\n ProjectLink(\"PyPI Releases\", \"https://pypi.org/project/itsdangerous/\"),\n ProjectLink(\"Source Code\", \"https://github.com/pallets/itsdangerous/\"),\n ProjectLink(\"Issue Tracker\", \"https://github.com/pallets/itsdangerous/issues/\"),\n ProjectLink(\"Chat\", \"https://discord.gg/pallets\"),\n ]\n}\nhtml_sidebars = {\n \"index\": [\"project.html\", \"localtoc.html\", \"searchbox.html\", \"ethicalads.html\"],\n \"**\": [\"localtoc.html\", \"relations.html\", \"searchbox.html\", \"ethicalads.html\"],\n}\nsinglehtml_sidebars = {\"index\": [\"project.html\", \"localtoc.html\", \"ethicalads.html\"]}\nhtml_static_path = [\"_static\"]\nhtml_favicon = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_logo = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_title = f\"{project} Documentation ({version})\"\nhtml_show_sourcelink = False\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"24"},{"content":"@ECHO OFF\n\npushd %~dp0\n\nREM Command file for Sphinx documentation\n\nif \"%SPHINXBUILD%\" == \"\" (\n\tset SPHINXBUILD=sphinx-build\n)\nset SOURCEDIR=.\nset BUILDDIR=_build\n\nif \"%1\" == \"\" goto help\n\n%SPHINXBUILD% >NUL 2>NUL\nif errorlevel 9009 (\n\techo.\n\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\n\techo.installed, then set the SPHINXBUILD environment variable to point\n\techo.to the full path of the 'sphinx-build' executable. Alternatively you\n\techo.may add the Sphinx directory to PATH.\n\techo.\n\techo.If you don't have Sphinx installed, grab it from\n\techo.http://sphinx-doc.org/\n\texit /b 1\n)\n\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\ngoto end\n\n:help\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\n\n:end\npopd\n\n[end of docs/make.bat]","filename":"docs/make.bat","id":"25"},{"content":".. module:: itsdangerous.timed\n\nSigning With Timestamps\n=======================\n\nIf you want to expire signatures you can use the\n:class:`TimestampSigner` class which adds timestamp information and\nsigns it. On unsigning you can validate that the timestamp is not older\nthan a given age.\n\n.. code-block:: python\n\n from itsdangerous import TimestampSigner\n s = TimestampSigner('secret-key')\n string = s.sign('foo')\n\n.. code-block:: python\n\n s.unsign(string, max_age=5)\n Traceback (most recent call last):\n ...\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\n\n.. autoclass:: TimestampSigner\n :members:\n\n.. autoclass:: TimedSerializer\n :members:\n\n[end of docs/timed.rst]","filename":"docs/timed.rst","id":"26"},{"content":"BSD-3-Clause License\n====================\n\n.. literalinclude:: ../LICENSE.txt\n :language: text\n\n[end of docs/license.rst]","filename":"docs/license.rst","id":"27"},{"content":"Changes\n=======\n\n.. include:: ../CHANGES.rst\n\n[end of docs/changes.rst]","filename":"docs/changes.rst","id":"28"},{"content":".. module:: itsdangerous.exc\n\nExceptions\n==========\n\n.. autoexception:: BadData\n :members:\n\n.. autoexception:: BadSignature\n :members:\n\n.. autoexception:: BadTimeSignature\n :members:\n\n.. autoexception:: SignatureExpired\n :members:\n\n.. autoexception:: BadHeader\n :members:\n\n.. autoexception:: BadPayload\n :members:\n\n[end of docs/exceptions.rst]","filename":"docs/exceptions.rst","id":"29"},{"content":"#!/bin/bash\nset -e\npython3 -m venv --upgrade-deps .venv\n. .venv/bin/activate\npip install -r requirements/dev.txt\npip install -e .\npre-commit install --install-hooks\n\n[end of .devcontainer/on-create-command.sh]","filename":".devcontainer/on-create-command.sh","id":"30"},{"content":"{\n \"name\": \"pallets/itsdangerous\",\n \"image\": \"mcr.microsoft.com/devcontainers/python:3\",\n \"customizations\": {\n \"vscode\": {\n \"settings\": {\n \"python.defaultInterpreterPath\": \"${workspaceFolder}/.venv\",\n \"python.terminal.activateEnvInCurrentTerminal\": true,\n \"python.terminal.launchArgs\": [\n \"-X\",\n \"dev\"\n ]\n }\n }\n },\n \"onCreateCommand\": \".devcontainer/on-create-command.sh\"\n}\n\n[end of .devcontainer/devcontainer.json]","filename":".devcontainer/devcontainer.json","id":"31"},{"content":"None\n[end of docs/_static/itsdangerous-logo-sidebar.png]","filename":"docs/_static/itsdangerous-logo-sidebar.png","id":"32"},{"content":"None\n[end of docs/_static/itsdangerous-logo.png]","filename":"docs/_static/itsdangerous-logo.png","id":"33"},{"content":"from __future__ import annotations\n\nimport json as _json\nimport typing as t\n\n\nclass _CompactJSON:\n \"\"\"Wrapper around json module that strips whitespace.\"\"\"\n\n @staticmethod\n def loads(payload: str | bytes) -> t.Any:\n return _json.loads(payload)\n\n @staticmethod\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\n kwargs.setdefault(\"ensure_ascii\", False)\n kwargs.setdefault(\"separators\", (\",\", \":\"))\n return _json.dumps(obj, **kwargs)\n\n[end of src/itsdangerous/_json.py]","filename":"src/itsdangerous/_json.py","id":"34"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport time\nimport typing as t\nfrom datetime import datetime\nfrom datetime import timezone\n\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import bytes_to_int\nfrom .encoding import int_to_bytes\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\nfrom .exc import BadTimeSignature\nfrom .exc import SignatureExpired\nfrom .serializer import _TSerialized\nfrom .serializer import Serializer\nfrom .signer import Signer\n\n\nclass TimestampSigner(Signer):\n \"\"\"Works like the regular :class:`.Signer` but also records the time\n of the signing and can be used to expire signatures. The\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\n unsigning failed because the signature is expired.\n \"\"\"\n\n def get_timestamp(self) -> int:\n \"\"\"Returns the current timestamp. The function must return an\n integer.\n \"\"\"\n return int(time.time())\n\n def timestamp_to_datetime(self, ts: int) -> datetime:\n \"\"\"Convert the timestamp from :meth:`get_timestamp` into an\n aware :class`datetime.datetime` in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n return datetime.fromtimestamp(ts, tz=timezone.utc)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string and also attaches time information.\"\"\"\n value = want_bytes(value)\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\n sep = want_bytes(self.sep)\n value = value + sep + timestamp\n return value + sep + self.get_signature(value)\n\n # Ignore overlapping signatures check, return_timestamp is the only\n # parameter that affects the return type.\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[False] = False,\n ) -> bytes: ...\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[True] = True,\n ) -> tuple[bytes, datetime]: ...\n\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n ) -> tuple[bytes, datetime] | bytes:\n \"\"\"Works like the regular :meth:`.Signer.unsign` but can also\n validate the time. See the base docstring of the class for\n the general behavior. If ``return_timestamp`` is ``True`` the\n timestamp of the signature will be returned as an aware\n :class:`datetime.datetime` object in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n try:\n result = super().unsign(signed_value)\n sig_error = None\n except BadSignature as e:\n sig_error = e\n result = e.payload or b\"\"\n\n sep = want_bytes(self.sep)\n\n # If there is no timestamp in the result there is something\n # seriously wrong. In case there was a signature error, we raise\n # that one directly, otherwise we have a weird situation in\n # which we shouldn't have come except someone uses a time-based\n # serializer on non-timestamp data, so catch that.\n if sep not in result:\n if sig_error:\n raise sig_error\n\n raise BadTimeSignature(\"timestamp missing\", payload=result)\n\n value, ts_bytes = result.rsplit(sep, 1)\n ts_int: int | None = None\n ts_dt: datetime | None = None\n\n try:\n ts_int = bytes_to_int(base64_decode(ts_bytes))\n except Exception:\n pass\n\n # Signature is *not* okay. Raise a proper error now that we have\n # split the value and the timestamp.\n if sig_error is not None:\n if ts_int is not None:\n try:\n ts_dt = self.timestamp_to_datetime(ts_int)\n except (ValueError, OSError, OverflowError) as exc:\n # Windows raises OSError\n # 32-bit raises OverflowError\n raise BadTimeSignature(\n \"Malformed timestamp\", payload=value\n ) from exc\n\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\n\n # Signature was okay but the timestamp is actually not there or\n # malformed. Should not happen, but we handle it anyway.\n if ts_int is None:\n raise BadTimeSignature(\"Malformed timestamp\", payload=value)\n\n # Check timestamp is not older than max_age\n if max_age is not None:\n age = self.get_timestamp() - ts_int\n\n if age > max_age:\n raise SignatureExpired(\n f\"Signature age {age} > {max_age} seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if age < 0:\n raise SignatureExpired(\n f\"Signature age {age} < 0 seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if return_timestamp:\n return value, self.timestamp_to_datetime(ts_int)\n\n return value\n\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\"\"\"\n try:\n self.unsign(signed_value, max_age=max_age)\n return True\n except BadSignature:\n return False\n\n\nclass TimedSerializer(Serializer[_TSerialized]):\n \"\"\"Uses :class:`TimestampSigner` instead of the default\n :class:`.Signer`.\n \"\"\"\n\n default_signer: type[TimestampSigner] = TimestampSigner\n\n def iter_unsigners(\n self, salt: str | bytes | None = None\n ) -> cabc.Iterator[TimestampSigner]:\n return t.cast(\"cabc.Iterator[TimestampSigner]\", super().iter_unsigners(salt))\n\n # TODO: Signature is incompatible because parameters were added\n # before salt.\n\n def loads( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n salt: str | bytes | None = None,\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\n signature validation fails. If a ``max_age`` is provided it will\n ensure the signature is not older than that time in seconds. In\n case the signature is outdated, :exc:`.SignatureExpired` is\n raised. All arguments are forwarded to the signer's\n :meth:`~TimestampSigner.unsign` method.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n base64d, timestamp = signer.unsign(\n s, max_age=max_age, return_timestamp=True\n )\n payload = self.load_payload(base64d)\n\n if return_timestamp:\n return payload, timestamp\n\n return payload\n except SignatureExpired:\n # The signature was unsigned successfully but was\n # expired. Do not try the next signer.\n raise\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def loads_unsafe( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n salt: str | bytes | None = None,\n ) -> tuple[bool, t.Any]:\n return self._loads_unsafe_impl(s, salt, load_kwargs={\"max_age\": max_age})\n\n[end of src/itsdangerous/timed.py]","filename":"src/itsdangerous/timed.py","id":"35"},{"content":"from __future__ import annotations\n\nimport base64\nimport string\nimport struct\nimport typing as t\n\nfrom .exc import BadData\n\n\ndef want_bytes(\n s: str | bytes, encoding: str = \"utf-8\", errors: str = \"strict\"\n) -> bytes:\n if isinstance(s, str):\n s = s.encode(encoding, errors)\n\n return s\n\n\ndef base64_encode(string: str | bytes) -> bytes:\n \"\"\"Base64 encode a string of bytes or text. The resulting bytes are\n safe to use in URLs.\n \"\"\"\n string = want_bytes(string)\n return base64.urlsafe_b64encode(string).rstrip(b\"=\")\n\n\ndef base64_decode(string: str | bytes) -> bytes:\n \"\"\"Base64 decode a URL-safe string of bytes or text. The result is\n bytes.\n \"\"\"\n string = want_bytes(string, encoding=\"ascii\", errors=\"ignore\")\n string += b\"=\" * (-len(string) % 4)\n\n try:\n return base64.urlsafe_b64decode(string)\n except (TypeError, ValueError) as e:\n raise BadData(\"Invalid base64-encoded data\") from e\n\n\n# The alphabet used by base64.urlsafe_*\n_base64_alphabet = f\"{string.ascii_letters}{string.digits}-_=\".encode(\"ascii\")\n\n_int64_struct = struct.Struct(\">Q\")\n_int_to_bytes = _int64_struct.pack\n_bytes_to_int = t.cast(\"t.Callable[[bytes], tuple[int]]\", _int64_struct.unpack)\n\n\ndef int_to_bytes(num: int) -> bytes:\n return _int_to_bytes(num).lstrip(b\"\\x00\")\n\n\ndef bytes_to_int(bytestr: bytes) -> int:\n return _bytes_to_int(bytestr.rjust(8, b\"\\x00\"))[0]\n\n[end of src/itsdangerous/encoding.py]","filename":"src/itsdangerous/encoding.py","id":"36"},{"content":"from __future__ import annotations\n\nimport typing as t\n\nfrom .encoding import base64_decode as base64_decode\nfrom .encoding import base64_encode as base64_encode\nfrom .encoding import want_bytes as want_bytes\nfrom .exc import BadData as BadData\nfrom .exc import BadHeader as BadHeader\nfrom .exc import BadPayload as BadPayload\nfrom .exc import BadSignature as BadSignature\nfrom .exc import BadTimeSignature as BadTimeSignature\nfrom .exc import SignatureExpired as SignatureExpired\nfrom .serializer import Serializer as Serializer\nfrom .signer import HMACAlgorithm as HMACAlgorithm\nfrom .signer import NoneAlgorithm as NoneAlgorithm\nfrom .signer import Signer as Signer\nfrom .timed import TimedSerializer as TimedSerializer\nfrom .timed import TimestampSigner as TimestampSigner\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\n\n\ndef __getattr__(name: str) -> t.Any:\n if name == \"__version__\":\n import importlib.metadata\n import warnings\n\n warnings.warn(\n \"The '__version__' attribute is deprecated and will be removed in\"\n \" ItsDangerous 2.3. Use feature detection or\"\n \" 'importlib.metadata.version(\\\"itsdangerous\\\")' instead.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return importlib.metadata.version(\"itsdangerous\")\n\n raise AttributeError(name)\n\n[end of src/itsdangerous/__init__.py]","filename":"src/itsdangerous/__init__.py","id":"37"},{"content":"from __future__ import annotations\n\nimport typing as t\nimport zlib\n\nfrom ._json import _CompactJSON\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .exc import BadPayload\nfrom .serializer import _PDataSerializer\nfrom .serializer import Serializer\nfrom .timed import TimedSerializer\n\n\nclass URLSafeSerializerMixin(Serializer[str]):\n \"\"\"Mixed in with a regular serializer it will attempt to zlib\n compress the string to make it shorter if necessary. It will also\n base64 encode the string so that it can safely be placed in a URL.\n \"\"\"\n\n default_serializer: _PDataSerializer[str] = _CompactJSON\n\n def load_payload(\n self,\n payload: bytes,\n *args: t.Any,\n serializer: t.Any | None = None,\n **kwargs: t.Any,\n ) -> t.Any:\n decompress = False\n\n if payload.startswith(b\".\"):\n payload = payload[1:]\n decompress = True\n\n try:\n json = base64_decode(payload)\n except Exception as e:\n raise BadPayload(\n \"Could not base64 decode the payload because of an exception\",\n original_error=e,\n ) from e\n\n if decompress:\n try:\n json = zlib.decompress(json)\n except Exception as e:\n raise BadPayload(\n \"Could not zlib decompress the payload before decoding the payload\",\n original_error=e,\n ) from e\n\n return super().load_payload(json, *args, **kwargs)\n\n def dump_payload(self, obj: t.Any) -> bytes:\n json = super().dump_payload(obj)\n is_compressed = False\n compressed = zlib.compress(json)\n\n if len(compressed) < (len(json) - 1):\n json = compressed\n is_compressed = True\n\n base64d = base64_encode(json)\n\n if is_compressed:\n base64d = b\".\" + base64d\n\n return base64d\n\n\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\n \"\"\"Works like :class:`.Serializer` but dumps and loads into a URL\n safe string consisting of the upper and lowercase character of the\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\n \"\"\"Works like :class:`.TimedSerializer` but dumps and loads into a\n URL safe string consisting of the upper and lowercase character of\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n[end of src/itsdangerous/url_safe.py]","filename":"src/itsdangerous/url_safe.py","id":"38"},{"content":"from __future__ import annotations\n\nimport typing as t\nfrom datetime import datetime\n\n\nclass BadData(Exception):\n \"\"\"Raised if bad data of any sort was encountered. This is the base\n for all exceptions that ItsDangerous defines.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str):\n super().__init__(message)\n self.message = message\n\n def __str__(self) -> str:\n return self.message\n\n\nclass BadSignature(BadData):\n \"\"\"Raised if a signature does not match.\"\"\"\n\n def __init__(self, message: str, payload: t.Any | None = None):\n super().__init__(message)\n\n #: The payload that failed the signature test. In some\n #: situations you might still want to inspect this, even if\n #: you know it was tampered with.\n #:\n #: .. versionadded:: 0.14\n self.payload: t.Any | None = payload\n\n\nclass BadTimeSignature(BadSignature):\n \"\"\"Raised if a time-based signature is invalid. This is a subclass\n of :class:`BadSignature`.\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n date_signed: datetime | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the signature expired this exposes the date of when the\n #: signature was created. This can be helpful in order to\n #: tell the user how long a link has been gone stale.\n #:\n #: .. versionchanged:: 2.0\n #: The datetime value is timezone-aware rather than naive.\n #:\n #: .. versionadded:: 0.14\n self.date_signed = date_signed\n\n\nclass SignatureExpired(BadTimeSignature):\n \"\"\"Raised if a signature timestamp is older than ``max_age``. This\n is a subclass of :exc:`BadTimeSignature`.\n \"\"\"\n\n\nclass BadHeader(BadSignature):\n \"\"\"Raised if a signed header is invalid in some form. This only\n happens for serializers that have a header that goes with the\n signature.\n\n .. versionadded:: 0.24\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n header: t.Any | None = None,\n original_error: Exception | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the header is actually available but just malformed it\n #: might be stored here.\n self.header: t.Any | None = header\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n\nclass BadPayload(BadData):\n \"\"\"Raised if a payload is invalid. This could happen if the payload\n is loaded despite an invalid signature, or if there is a mismatch\n between the serializer and deserializer. The original exception\n that occurred during loading is stored on as :attr:`original_error`.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str, original_error: Exception | None = None):\n super().__init__(message)\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n[end of src/itsdangerous/exc.py]","filename":"src/itsdangerous/exc.py","id":"39"},{"content":"[end of src/itsdangerous/py.typed]","filename":"src/itsdangerous/py.typed","id":"40"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport json\nimport typing as t\n\nfrom .encoding import want_bytes\nfrom .exc import BadPayload\nfrom .exc import BadSignature\nfrom .signer import _make_keys_list\nfrom .signer import Signer\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n # This should be either be str or bytes. To avoid having to specify the\n # bound type, it falls back to a union if structural matching fails.\n _TSerialized = te.TypeVar(\n \"_TSerialized\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\n )\nelse:\n # Still available at runtime on Python < 3.13, but without the default.\n _TSerialized = t.TypeVar(\"_TSerialized\", bound=t.Union[str, bytes])\n\n\nclass _PDataSerializer(t.Protocol[_TSerialized]):\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\n # A signature with additional arguments is not handled correctly by type\n # checkers right now, so an overload is used below for serializers that\n # don't match this strict protocol.\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\n\n\n# Use TypeIs once it's available in typing_extensions or 3.13.\ndef is_text_serializer(\n serializer: _PDataSerializer[t.Any],\n) -> te.TypeGuard[_PDataSerializer[str]]:\n \"\"\"Checks whether a serializer generates text or binary.\"\"\"\n return isinstance(serializer.dumps({}), str)\n\n\nclass Serializer(t.Generic[_TSerialized]):\n \"\"\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\n enable serializing and securely signing data other than bytes. It\n can unsign to verify that the data hasn't been changed.\n\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\n :mod:`json`, and by default uses :mod:`json` internally to serialize\n the data to bytes.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param serializer: An object that provides ``dumps`` and ``loads``\n methods for serializing data to a string. Defaults to\n :attr:`default_serializer`, which defaults to :mod:`json`.\n :param serializer_kwargs: Keyword arguments to pass when calling\n ``serializer.dumps``.\n :param signer: A ``Signer`` class to instantiate when signing data.\n Defaults to :attr:`default_signer`, which defaults to\n :class:`~itsdangerous.signer.Signer`.\n :param signer_kwargs: Keyword arguments to pass when instantiating\n the ``Signer`` class.\n :param fallback_signers: List of signer parameters to try when\n unsigning with the default signer fails. Each item can be a dict\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\n ``(signer, signer_kwargs)``. Defaults to\n :attr:`default_fallback_signers`.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 2.0\n Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``.\n\n .. versionchanged:: 1.1\n Added support for ``fallback_signers`` and configured a default\n SHA-512 fallback. This fallback is for users who used the yanked\n 1.0.0 release which defaulted to SHA-512.\n\n .. versionchanged:: 0.14\n The ``signer`` and ``signer_kwargs`` parameters were added to\n the constructor.\n \"\"\"\n\n #: The default serialization module to use to serialize data to a\n #: string internally. The default is :mod:`json`, but can be changed\n #: to any object that provides ``dumps`` and ``loads`` methods.\n default_serializer: _PDataSerializer[t.Any] = json\n\n #: The default ``Signer`` class to instantiate when signing data.\n #: The default is :class:`itsdangerous.signer.Signer`.\n default_signer: type[Signer] = Signer\n\n #: The default fallback signers to try when unsigning fails.\n default_fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = []\n\n # Serializer[str] if no data serializer is provided, or if it returns str.\n @t.overload\n def __init__(\n self: Serializer[str],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: None | _PDataSerializer[str] = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer positional argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer keyword argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a positional argument. If the strict signature of\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\n # to specify the type.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a keyword argument.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: t.Any | None = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n\n if salt is not None:\n salt = want_bytes(salt)\n # if salt is None then the signer's default is used\n\n self.salt = salt\n\n if serializer is None:\n serializer = self.default_serializer\n\n self.serializer: _PDataSerializer[_TSerialized] = serializer\n self.is_text_serializer: bool = is_text_serializer(serializer)\n\n if signer is None:\n signer = self.default_signer\n\n self.signer: type[Signer] = signer\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\n\n if fallback_signers is None:\n fallback_signers = list(self.default_fallback_signers)\n\n self.fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = fallback_signers\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def load_payload(\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\n ) -> t.Any:\n \"\"\"Loads the encoded object. This function raises\n :class:`.BadPayload` if the payload is not valid. The\n ``serializer`` parameter can be used to override the serializer\n stored on the class. The encoded ``payload`` should always be\n bytes.\n \"\"\"\n if serializer is None:\n use_serializer = self.serializer\n is_text = self.is_text_serializer\n else:\n use_serializer = serializer\n is_text = is_text_serializer(serializer)\n\n try:\n if is_text:\n return use_serializer.loads(payload.decode(\"utf-8\")) # type: ignore[arg-type]\n\n return use_serializer.loads(payload) # type: ignore[arg-type]\n except Exception as e:\n raise BadPayload(\n \"Could not load the payload because an exception\"\n \" occurred on unserializing the data.\",\n original_error=e,\n ) from e\n\n def dump_payload(self, obj: t.Any) -> bytes:\n \"\"\"Dumps the encoded object. The return value is always bytes.\n If the internal serializer returns text, the value will be\n encoded as UTF-8.\n \"\"\"\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\n\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\n \"\"\"Creates a new instance of the signer to be used. The default\n implementation uses the :class:`.Signer` base class.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\n\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\n \"\"\"Iterates over all signers to be tried for unsigning. Starts\n with the configured signer, then constructs each signer\n specified in ``fallback_signers``.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n yield self.make_signer(salt)\n\n for fallback in self.fallback_signers:\n if isinstance(fallback, dict):\n kwargs = fallback\n fallback = self.signer\n elif isinstance(fallback, tuple):\n fallback, kwargs = fallback\n else:\n kwargs = self.signer_kwargs\n\n for secret_key in self.secret_keys:\n yield fallback(secret_key, salt=salt, **kwargs)\n\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\n \"\"\"Returns a signed string serialized with the internal\n serializer. The return value can be either a byte or unicode\n string depending on the format of the internal serializer.\n \"\"\"\n payload = want_bytes(self.dump_payload(obj))\n rv = self.make_signer(salt).sign(payload)\n\n if self.is_text_serializer:\n return rv.decode(\"utf-8\") # type: ignore[return-value]\n\n return rv # type: ignore[return-value]\n\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\n \"\"\"Like :meth:`dumps` but dumps into a file. The file handle has\n to be compatible with what the internal serializer expects.\n \"\"\"\n f.write(self.dumps(obj, salt))\n\n def loads(\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\n signature validation fails.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n return self.load_payload(signer.unsign(s))\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\n \"\"\"Like :meth:`loads` but loads from a file.\"\"\"\n return self.loads(f.read(), salt)\n\n def loads_unsafe(\n self, s: str | bytes, salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads` but without verifying the signature. This\n is potentially very dangerous to use depending on how your\n serializer works. The return value is ``(signature_valid,\n payload)`` instead of just the payload. The first item will be a\n boolean that indicates if the signature is valid. This function\n never fails.\n\n Use it for debugging only and if you know that your serializer\n module is not exploitable (for example, do not use it with a\n pickle serializer).\n\n .. versionadded:: 0.15\n \"\"\"\n return self._loads_unsafe_impl(s, salt)\n\n def _loads_unsafe_impl(\n self,\n s: str | bytes,\n salt: str | bytes | None,\n load_kwargs: dict[str, t.Any] | None = None,\n load_payload_kwargs: dict[str, t.Any] | None = None,\n ) -> tuple[bool, t.Any]:\n \"\"\"Low level helper function to implement :meth:`loads_unsafe`\n in serializer subclasses.\n \"\"\"\n if load_kwargs is None:\n load_kwargs = {}\n\n try:\n return True, self.loads(s, salt=salt, **load_kwargs)\n except BadSignature as e:\n if e.payload is None:\n return False, None\n\n if load_payload_kwargs is None:\n load_payload_kwargs = {}\n\n try:\n return (\n False,\n self.load_payload(e.payload, **load_payload_kwargs),\n )\n except BadPayload:\n return False, None\n\n def load_unsafe(\n self, f: t.IO[t.Any], salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads_unsafe` but loads from a file.\n\n .. versionadded:: 0.15\n \"\"\"\n return self.loads_unsafe(f.read(), salt=salt)\n\n[end of src/itsdangerous/serializer.py]","filename":"src/itsdangerous/serializer.py","id":"41"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport hashlib\nimport hmac\nimport typing as t\n\nfrom .encoding import _base64_alphabet\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\n\n\nclass SigningAlgorithm:\n \"\"\"Subclasses must implement :meth:`get_signature` to provide\n signature generation functionality.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n \"\"\"Returns the signature for the given key and value.\"\"\"\n raise NotImplementedError()\n\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\n \"\"\"Verifies the given signature matches the expected\n signature.\n \"\"\"\n return hmac.compare_digest(sig, self.get_signature(key, value))\n\n\nclass NoneAlgorithm(SigningAlgorithm):\n \"\"\"Provides an algorithm that does not perform any signing and\n returns an empty signature.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n return b\"\"\n\n\ndef _lazy_sha1(string: bytes = b\"\") -> t.Any:\n \"\"\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\n SHA-1, in which case the import and use as a default would fail before the\n developer can configure something else.\n \"\"\"\n return hashlib.sha1(string)\n\n\nclass HMACAlgorithm(SigningAlgorithm):\n \"\"\"Provides signature generation using HMACs.\"\"\"\n\n #: The digest method to use with the MAC algorithm. This defaults to\n #: SHA1, but can be changed to any other function in the hashlib\n #: module.\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n def __init__(self, digest_method: t.Any = None):\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\n return mac.digest()\n\n\ndef _make_keys_list(\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n) -> list[bytes]:\n if isinstance(secret_key, (str, bytes)):\n return [want_bytes(secret_key)]\n\n return [want_bytes(s) for s in secret_key] # pyright: ignore\n\n\nclass Signer:\n \"\"\"A signer securely signs bytes, then unsigns them to verify that\n the value hasn't been changed.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param sep: Separator between the signature and value.\n :param key_derivation: How to derive the signing key from the secret\n key and salt. Possible values are ``concat``, ``django-concat``,\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\n defaults to ``django-concat``.\n :param digest_method: Hash function to use when generating the HMAC\n signature. Defaults to :attr:`default_digest_method`, which\n defaults to :func:`hashlib.sha1`. Note that the security of the\n hash alone doesn't apply when used intermediately in HMAC.\n :param algorithm: A :class:`SigningAlgorithm` instance to use\n instead of building a default :class:`HMACAlgorithm` with the\n ``digest_method``.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 0.18\n ``algorithm`` was added as an argument to the class constructor.\n\n .. versionchanged:: 0.14\n ``key_derivation`` and ``digest_method`` were added as arguments\n to the class constructor.\n \"\"\"\n\n #: The default digest method to use for the signer. The default is\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\n #: compatible object. Note that the security of the hash alone\n #: doesn't apply when used intermediately in HMAC.\n #:\n #: .. versionadded:: 0.14\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n #: The default scheme to use to derive the signing key from the\n #: secret key and salt. The default is ``django-concat``. Possible\n #: values are ``concat``, ``django-concat``, and ``hmac``.\n #:\n #: .. versionadded:: 0.14\n default_key_derivation: str = \"django-concat\"\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous.Signer\",\n sep: str | bytes = b\".\",\n key_derivation: str | None = None,\n digest_method: t.Any | None = None,\n algorithm: SigningAlgorithm | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n self.sep: bytes = want_bytes(sep)\n\n if self.sep in _base64_alphabet:\n raise ValueError(\n \"The given separator cannot be used because it may be\"\n \" contained in the signature itself. ASCII letters,\"\n \" digits, and '-_=' must not be used.\"\n )\n\n if salt is not None:\n salt = want_bytes(salt)\n else:\n salt = b\"itsdangerous.Signer\"\n\n self.salt = salt\n\n if key_derivation is None:\n key_derivation = self.default_key_derivation\n\n self.key_derivation: str = key_derivation\n\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n if algorithm is None:\n algorithm = HMACAlgorithm(self.digest_method)\n\n self.algorithm: SigningAlgorithm = algorithm\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\n \"\"\"This method is called to derive the key. The default key\n derivation choices can be overridden here. Key derivation is not\n intended to be used as a security method to make a complex key\n out of a short password. Instead you should use large random\n secret keys.\n\n :param secret_key: A specific secret key to derive from.\n Defaults to the last item in :attr:`secret_keys`.\n\n .. versionchanged:: 2.0\n Added the ``secret_key`` parameter.\n \"\"\"\n if secret_key is None:\n secret_key = self.secret_keys[-1]\n else:\n secret_key = want_bytes(secret_key)\n\n if self.key_derivation == \"concat\":\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\n elif self.key_derivation == \"django-concat\":\n return t.cast(\n bytes, self.digest_method(self.salt + b\"signer\" + secret_key).digest()\n )\n elif self.key_derivation == \"hmac\":\n mac = hmac.new(secret_key, digestmod=self.digest_method)\n mac.update(self.salt)\n return mac.digest()\n elif self.key_derivation == \"none\":\n return secret_key\n else:\n raise TypeError(\"Unknown key derivation method\")\n\n def get_signature(self, value: str | bytes) -> bytes:\n \"\"\"Returns the signature for the given value.\"\"\"\n value = want_bytes(value)\n key = self.derive_key()\n sig = self.algorithm.get_signature(key, value)\n return base64_encode(sig)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string.\"\"\"\n value = want_bytes(value)\n return value + self.sep + self.get_signature(value)\n\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\n \"\"\"Verifies the signature for the given value.\"\"\"\n try:\n sig = base64_decode(sig)\n except Exception:\n return False\n\n value = want_bytes(value)\n\n for secret_key in reversed(self.secret_keys):\n key = self.derive_key(secret_key)\n\n if self.algorithm.verify_signature(key, value, sig):\n return True\n\n return False\n\n def unsign(self, signed_value: str | bytes) -> bytes:\n \"\"\"Unsigns the given string.\"\"\"\n signed_value = want_bytes(signed_value)\n\n if self.sep not in signed_value:\n raise BadSignature(f\"No {self.sep!r} found in value\")\n\n value, sig = signed_value.rsplit(self.sep, 1)\n\n if self.verify_signature(value, sig):\n return value\n\n raise BadSignature(f\"Signature {sig!r} does not match\", payload=value)\n\n def validate(self, signed_value: str | bytes) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\n \"\"\"\n try:\n self.unsign(signed_value)\n return True\n except BadSignature:\n return False\n\n[end of src/itsdangerous/signer.py]","filename":"src/itsdangerous/signer.py","id":"42"}],"string":"[\n {\n \"content\": \"How to contribute to ItsDangerous\\n=================================\\n\\nThank you for considering contributing to ItsDangerous!\\n\\n\\nSupport questions\\n-----------------\\n\\nPlease don't use the issue tracker for this. The issue tracker is a\\ntool to address bugs and feature requests in ItsDangerous itself. Use\\none of the following resources for questions about using ItsDangerous or\\nissues with your own code:\\n\\n- The ``#get-help`` channel on our Discord chat:\\n https://discord.gg/pallets\\n- The mailing list flask@python.org for long term discussion or larger\\n issues.\\n- Ask on `Stack Overflow`_. Search with Google first using:\\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\\n\\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\\n\\n\\nReporting issues\\n----------------\\n\\nInclude the following information in your post:\\n\\n- Describe what you expected to happen.\\n- If possible, include a `minimal reproducible example`_ to help us\\n identify the issue. This also helps check that the issue is not with\\n your own code.\\n- Describe what actually happened. Include the full traceback if there\\n was an exception.\\n- List your Python and ItsDangerous versions. If possible, check if\\n this issue is already fixed in the latest releases or the latest\\n code in the repository.\\n\\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\\n\\n\\nSubmitting patches\\n------------------\\n\\nIf there is not an open issue for what you want to submit, prefer\\nopening one for discussion before working on a PR. You can work on any\\nissue that doesn't have an open PR linked to it or a maintainer assigned\\nto it. These show up in the sidebar. No need to ask if you can work on\\nan issue that interests you.\\n\\nInclude the following in your patch:\\n\\n- Use `Black`_ to format your code. This and other tools will run\\n automatically if you install `pre-commit`_ using the instructions\\n below.\\n- Include tests if your patch adds or changes code. Make sure the test\\n fails without your patch.\\n- Update any relevant docs pages and docstrings. Docs pages and\\n docstrings should be wrapped at 72 characters.\\n- Add an entry in ``CHANGES.rst``. Use the same style as other\\n entries. Also include ``.. versionchanged::`` inline changelogs in\\n relevant docstrings.\\n\\n.. _Black: https://black.readthedocs.io\\n.. _pre-commit: https://pre-commit.com\\n\\n\\nFirst time setup\\n~~~~~~~~~~~~~~~~\\n\\n- Download and install the `latest version of git`_.\\n- Configure git with your `username`_ and `email`_.\\n\\n .. code-block:: text\\n\\n $ git config --global user.name 'your name'\\n $ git config --global user.email 'your email'\\n\\n- Make sure you have a `GitHub account`_.\\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\\n button.\\n- `Clone`_ the main repository locally.\\n\\n .. code-block:: text\\n\\n $ git clone https://github.com/pallets/itsdangerous\\n $ cd itsdangerous\\n\\n- Add your fork as a remote to push your work to. Replace\\n ``{username}`` with your username. This names the remote \\\"fork\\\", the\\n default Pallets remote is \\\"origin\\\".\\n\\n .. code-block:: text\\n\\n $ git remote add fork https://github.com/{username}/itsdangerous\\n\\n- Create a virtualenv.\\n\\n .. code-block:: text\\n\\n $ python3 -m venv env\\n $ . env/bin/activate\\n\\n On Windows, activating is different.\\n\\n .. code-block:: text\\n\\n > env\\\\Scripts\\\\activate\\n\\n- Install the development dependencies, then install ItsDangerous in\\n editable mode.\\n\\n .. code-block:: text\\n\\n $ pip install -r requirements/dev.txt && pip install -e .\\n\\n- Install the pre-commit hooks.\\n\\n .. code-block:: text\\n\\n $ pre-commit install\\n\\n.. _latest version of git: https://git-scm.com/downloads\\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\\n.. _GitHub account: https://github.com/join\\n.. _Fork: https://github.com/pallets/itsdangerous/fork\\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\\n\\n\\nStart coding\\n~~~~~~~~~~~~\\n\\n- Create a branch to identify the issue you would like to work on. If\\n you're submitting a bug or documentation fix, branch off of the\\n latest \\\".x\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/2.0.x\\n\\n If you're submitting a feature addition or change, branch off of the\\n \\\"main\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/main\\n\\n- Using your favorite editor, make your changes,\\n `committing as you go`_.\\n- Include tests that cover any code changes you make. Make sure the\\n test fails without your patch. Run the tests as described below.\\n- Push your commits to your fork on GitHub and\\n `create a pull request`_. Link to the issue being addressed with\\n ``fixes #123`` in the pull request.\\n\\n .. code-block:: text\\n\\n $ git push --set-upstream fork your-branch-name\\n\\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\\n\\n\\nRunning the tests\\n~~~~~~~~~~~~~~~~~\\n\\nRun the basic test suite with pytest.\\n\\n.. code-block:: text\\n\\n $ pytest\\n\\nThis runs the tests for the current environment, which is usually\\nsufficient. CI will run the full suite when you submit your pull\\nrequest. You can run the full test suite with tox if you don't want to\\nwait.\\n\\n.. code-block:: text\\n\\n $ tox\\n\\n\\nRunning test coverage\\n~~~~~~~~~~~~~~~~~~~~~\\n\\nGenerating a report of lines that do not have test coverage can indicate\\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\\ngenerate a report.\\n\\n.. code-block:: text\\n\\n $ pip install coverage\\n $ coverage run -m pytest\\n $ coverage html\\n\\nOpen ``htmlcov/index.html`` in your browser to explore the report.\\n\\nRead more about `coverage <https://coverage.readthedocs.io>`__.\\n\\n\\nBuilding the docs\\n~~~~~~~~~~~~~~~~~\\n\\nBuild the docs in the ``docs`` directory using Sphinx.\\n\\n.. code-block:: text\\n\\n $ cd docs\\n $ make html\\n\\nOpen ``_build/html/index.html`` in your browser to view the docs.\\n\\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\\n\\n[end of CONTRIBUTING.rst]\",\n \"filename\": \"CONTRIBUTING.rst\",\n \"id\": \"0\"\n },\n {\n \"content\": \"repos:\\n - repo: https://github.com/astral-sh/ruff-pre-commit\\n rev: v0.7.1\\n hooks:\\n - id: ruff\\n - id: ruff-format\\n - repo: https://github.com/pre-commit/pre-commit-hooks\\n rev: v5.0.0\\n hooks:\\n - id: check-merge-conflict\\n - id: debug-statements\\n - id: fix-byte-order-marker\\n - id: trailing-whitespace\\n - id: end-of-file-fixer\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[project]\\nname = \\\"itsdangerous\\\"\\nversion = \\\"2.2.0\\\"\\ndescription = \\\"Safely pass data to untrusted environments and back.\\\"\\nreadme = \\\"README.md\\\"\\nlicense = { file = \\\"LICENSE.txt\\\" }\\nmaintainers = [{ name = \\\"Pallets\\\", email = \\\"contact@palletsprojects.com\\\" }]\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Typing :: Typed\\\",\\n]\\nrequires-python = \\\">=3.8\\\"\\n\\n[project.urls]\\nDonate = \\\"https://palletsprojects.com/donate\\\"\\nDocumentation = \\\"https://itsdangerous.palletsprojects.com/\\\"\\nChanges = \\\"https://itsdangerous.palletsprojects.com/changes/\\\"\\nSource = \\\"https://github.com/pallets/itsdangerous/\\\"\\nChat = \\\"https://discord.gg/pallets\\\"\\n\\n[build-system]\\nrequires = [\\\"flit_core<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.module]\\nname = \\\"itsdangerous\\\"\\n\\n[tool.flit.sdist]\\ninclude = [\\n \\\"docs/\\\",\\n \\\"requirements/\\\",\\n \\\"tests/\\\",\\n \\\"CHANGES.rst\\\",\\n \\\"tox.ini\\\",\\n]\\nexclude = [\\n \\\"docs/_build/\\\",\\n]\\n\\n[tool.pytest.ini_options]\\ntestpaths = [\\\"tests\\\"]\\nfilterwarnings = [\\n \\\"error\\\",\\n]\\n\\n[tool.coverage.run]\\nbranch = true\\nsource = [\\\"itsdangerous\\\", \\\"tests\\\"]\\n\\n[tool.coverage.paths]\\nsource = [\\\"src\\\", \\\"*/site-packages\\\"]\\n\\n[tool.mypy]\\npython_version = \\\"3.8\\\"\\nfiles = [\\\"src/itsdangerous\\\"]\\nshow_error_codes = true\\npretty = true\\nstrict = true\\n\\n[tool.pyright]\\npythonVersion = \\\"3.8\\\"\\ninclude = [\\\"src/itsdangerous\\\"]\\ntypeCheckingMode = \\\"basic\\\"\\n\\n[tool.ruff]\\nsrc = [\\\"src\\\"]\\nfix = true\\nshow-fixes = true\\noutput-format = \\\"full\\\"\\n\\n[tool.ruff.lint]\\nselect = [\\n \\\"B\\\", # flake8-bugbear\\n \\\"E\\\", # pycodestyle error\\n \\\"F\\\", # pyflakes\\n \\\"I\\\", # isort\\n \\\"UP\\\", # pyupgrade\\n \\\"W\\\", # pycodestyle warning\\n]\\n\\n[tool.ruff.lint.isort]\\nforce-single-line = true\\norder-by-type = false\\n\\n[tool.gha-update]\\ntag-only = [\\n \\\"slsa-framework/slsa-github-generator\\\",\\n]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\nindent_style = space\\nindent_size = 4\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\nend_of_line = lf\\ncharset = utf-8\\nmax_line_length = 88\\n\\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"3\"\n },\n {\n \"content\": \"# ItsDangerous\\n\\n... so better sign this\\n\\nVarious helpers to pass data to untrusted environments and to get it\\nback safe and sound. Data is cryptographically signed to ensure that a\\ntoken has not been tampered with.\\n\\nIt's possible to customize how data is serialized. Data is compressed as\\nneeded. A timestamp can be added and verified automatically while\\nloading a token.\\n\\n\\n## A Simple Example\\n\\nHere's how you could generate a token for transmitting a user's id and\\nname between web requests.\\n\\n```python\\nfrom itsdangerous import URLSafeSerializer\\nauth_s = URLSafeSerializer(\\\"secret key\\\", \\\"auth\\\")\\ntoken = auth_s.dumps({\\\"id\\\": 5, \\\"name\\\": \\\"itsdangerous\\\"})\\n\\nprint(token)\\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\\n\\ndata = auth_s.loads(token)\\nprint(data[\\\"name\\\"])\\n# itsdangerous\\n```\\n\\n\\n## Donate\\n\\nThe Pallets organization develops and supports ItsDangerous and other\\npopular packages. In order to grow the community of contributors and\\nusers, and allow the maintainers to devote more time to the projects,\\n[please donate today][].\\n\\n[please donate today]: https://palletsprojects.com/donate\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"[tox]\\nenvlist =\\n py3{13,12,11,10,9,8}\\n pypy310\\n style\\n typing\\n docs\\nskip_missing_interpreters = true\\n\\n[testenv]\\npackage = wheel\\nwheel_build_env = .pkg\\nconstrain_package_deps = true\\nuse_frozen_constraints = true\\ndeps = -r requirements/tests.txt\\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\\n\\n[testenv:style]\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit run --all-files\\n\\n[testenv:typing]\\ndeps = -r requirements/typing.txt\\ncommands =\\n mypy\\n pyright\\n pyright --verifytypes itsdangerous --ignoreexternal\\n\\n[testenv:docs]\\ndeps = -r requirements/docs.txt\\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\\n\\n[testenv:update-actions]\\nlabels = update\\ndeps = gha-update\\ncommands = gha-update\\n\\n[testenv:update-pre_commit]\\nlabels = update\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit autoupdate -j4\\n\\n[testenv:update-requirements]\\nlabels = update\\ndeps = pip-tools\\nskip_install = true\\nchange_dir = requirements\\ncommands =\\n pip-compile build.in -q {posargs:-U}\\n pip-compile docs.in -q {posargs:-U}\\n pip-compile tests.in -q {posargs:-U}\\n pip-compile typing.in -q {posargs:-U}\\n pip-compile dev.in -q {posargs:-U}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"5\"\n },\n {\n \"content\": \"Copyright 2011 Pallets\\n\\nRedistribution and use in source and binary forms, with or without\\nmodification, are permitted provided that the following conditions are\\nmet:\\n\\n1. Redistributions of source code must retain the above copyright\\n notice, this list of conditions and the following disclaimer.\\n\\n2. 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\\n3. Neither the name of the copyright holder nor the names of its\\n contributors may be used to endorse or promote products derived from\\n this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE.txt]\",\n \"filename\": \"LICENSE.txt\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Version 2.2.0\\n-------------\\n\\nReleased 2024-04-16\\n\\n- Drop support for Python 3.7. :pr:`372`\\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\\n :pr:`326`\\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\\n- Deprecate the ``__version__`` attribute. Use feature detection, or\\n ``importlib.metadata.version(\\\"itsdangerous\\\")``, instead. :issue:`371`\\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\\n different ``serializer`` argument is given, it will try to infer the return\\n type of its ``dumps`` method. :issue:`347`\\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\\n access it at import time so the developer has time to change the default.\\n :issue:`375`\\n\\n\\nVersion 2.1.2\\n-------------\\n\\nReleased 2022-03-24\\n\\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\\n\\n\\nVersion 2.1.1\\n-------------\\n\\nReleased 2022-03-09\\n\\n- Handle date overflow in timed unsign. :pr:`296`\\n\\n\\nVersion 2.1.0\\n-------------\\n\\nReleased 2022-02-17\\n\\n- Drop support for Python 3.6. :pr:`272`\\n- Remove previously deprecated code. :pr:`273`\\n\\n - JWS functionality: Use a dedicated library such as Authlib\\n instead.\\n - ``import itsdangerous.json``: Import ``json`` from the standard\\n library instead.\\n\\n\\nVersion 2.0.1\\n-------------\\n\\nReleased 2021-05-18\\n\\n- Mark top-level names as exported so type checking understands\\n imports in user projects. :pr:`240`\\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\\n ``None`` again. :issue:`237`\\n\\n\\nVersion 2.0.0\\n-------------\\n\\nReleased 2021-05-11\\n\\n- Drop support for Python 2 and 3.5.\\n- JWS support (``JSONWebSignatureSerializer``,\\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\\n JWS/JWT library such as authlib instead. :issue:`129`\\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\\n ``json`` module instead. :pr:`152`\\n- Simplejson is no longer used if it is installed. To use a different\\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\\n- If a signature has an age less than 0, it will raise\\n ``SignatureExpired`` rather than appearing valid. This can happen if\\n the timestamp offset is changed. :issue:`126`\\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\\n rather than an ``int`` in some cases. :issue:`124`\\n- Added support for key rotation. A list of keys can be passed as\\n ``secret_key``, oldest to newest. The newest key is used for\\n signing, all keys are tried for unsigning. :pr:`141`\\n- Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``. :issue:`155`\\n- Add type information for static typing tools. :pr:`186`\\n\\n\\nVersion 1.1.0\\n-------------\\n\\nReleased 2018-10-26\\n\\n- Change default signing algorithm back to SHA-1. :pr:`113`\\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\\n release which defaulted to SHA-512. :pr:`114`\\n- Add support for fallback algorithms during deserialization to\\n support changing the default in the future without breaking existing\\n signatures. :pr:`113`\\n- Changed capitalization of packages back to lowercase as the change\\n in capitalization broke some tooling. :pr:`113`\\n\\n\\nVersion 1.0.0\\n-------------\\n\\nReleased 2018-10-18\\n\\nYANKED\\n\\n*Note*: This release was yanked from PyPI because it changed the default\\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\\nat SHA1.\\n\\n- Drop support for Python 2.6 and 3.3.\\n- Refactor code from a single module to a package. Any object in the\\n API docs is still importable from the top-level ``itsdangerous``\\n name, but other imports will need to be changed. A future release\\n will remove many of these compatibility imports. :pr:`107`\\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\\n :pr:`27`\\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\\n Python 3. :issue:`29`\\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\\n- More compact JSON dumps for unicode strings. :issue:`38`\\n- Use the full timestamp rather than an offset, allowing dates before\\n 2011. :issue:`46`\\n\\n To retain compatibility with signers from previous versions,\\n consider using `this shim <https://github.com/pallets/itsdangerous\\n /issues/120#issuecomment-456913331>`_ when unsigning.\\n- Detect a ``sep`` character that may show up in the signature itself\\n and raise a ``ValueError``. :issue:`62`\\n- Use a consistent signature for keyword arguments for\\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\\n- Convert JWS exp header to an int when loading. :pr:`99`\\n\\n\\nVersion 0.24\\n------------\\n\\nReleased 2014-03-28\\n\\n- Added a ``BadHeader`` exception that is used for bad headers that\\n replaces the old ``BadPayload`` exception that was reused in those\\n cases.\\n\\n\\nVersion 0.23\\n------------\\n\\nReleased 2013-08-08\\n\\n- Fixed a packaging mistake that caused the tests and license files to\\n not be included.\\n\\n\\nVersion 0.22\\n------------\\n\\nReleased 2013-07-03\\n\\n- Added support for ``TimedJSONWebSignatureSerializer``.\\n- Made it possible to override the signature verification function to\\n allow implementing asymmetrical algorithms.\\n\\n\\nVersion 0.21\\n------------\\n\\nReleased 2013-05-26\\n\\n- Fixed an issue on Python 3 which caused invalid errors to be\\n generated.\\n\\n\\nVersion 0.20\\n------------\\n\\nReleased 2013-05-23\\n\\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\\n ItsDangerous on Python 2.6.\\n\\n\\nVersion 0.19\\n------------\\n\\nReleased 2013-05-21\\n\\n- Dropped support for 2.5 and added support for 3.3.\\n\\n\\nVersion 0.18\\n------------\\n\\nReleased 2013-05-03\\n\\n- Added support for JSON Web Signatures (JWS).\\n\\n\\nVersion 0.17\\n------------\\n\\nReleased 2012-08-10\\n\\n- Fixed a name error when overriding the digest method.\\n\\n\\nVersion 0.16\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made it possible to pass unicode values to ``load_payload`` to make\\n it easier to debug certain things.\\n\\n\\nVersion 0.15\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made standalone ``load_payload`` more robust by raising one specific\\n error if something goes wrong.\\n- Refactored exceptions to catch more cases individually, added more\\n attributes.\\n- Fixed an issue that caused ``load_payload`` not work in some\\n situations with timestamp based serializers\\n- Added an ``loads_unsafe`` method.\\n\\n\\nVersion 0.14\\n------------\\n\\nReleased 2012-06-29\\n\\n- API refactoring to support different key derivations.\\n- Added attributes to exceptions so that you can inspect the data even\\n if the signature check failed.\\n\\n\\nVersion 0.13\\n------------\\n\\nReleased 2012-06-10\\n\\n- Small API change that enables customization of the digest module.\\n\\n\\nVersion 0.12\\n------------\\n\\nReleased 2012-02-22\\n\\n- Fixed a problem with the local timezone being used for the epoch\\n calculation. This might invalidate some of your signatures if you\\n were not running in UTC timezone. You can revert to the old behavior\\n by monkey patching ``itsdangerous.EPOCH``.\\n\\n\\nVersion 0.11\\n------------\\n\\nReleased 2011-07-07\\n\\n- Fixed an uncaught value error.\\n\\n\\nVersion 0.10\\n------------\\n\\nReleased 2011-06-25\\n\\n- Refactored interface that the underlying serializers can be swapped\\n by passing in a module instead of having to override the payload\\n loaders and dumpers. This makes the interface more compatible with\\n Django's recent changes.\\n\\n[end of CHANGES.rst]\",\n \"filename\": \"CHANGES.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"version: 2\\nbuild:\\n os: ubuntu-22.04\\n tools:\\n python: '3.12'\\npython:\\n install:\\n - requirements: requirements/docs.txt\\n - method: pip\\n path: .\\nsphinx:\\n builder: dirhtml\\n fail_on_warning: true\\n\\n[end of .readthedocs.yaml]\",\n \"filename\": \".readthedocs.yaml\",\n \"id\": \"8\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile dev.in\\n#\\nalabaster==1.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nbabel==2.16.0\\n # via\\n # -r docs.txt\\n # sphinx\\ncachetools==5.5.0\\n # via tox\\ncertifi==2024.8.30\\n # via\\n # -r docs.txt\\n # requests\\ncfgv==3.4.0\\n # via pre-commit\\nchardet==5.2.0\\n # via tox\\ncharset-normalizer==3.4.0\\n # via\\n # -r docs.txt\\n # requests\\ncolorama==0.4.6\\n # via tox\\ndistlib==0.3.9\\n # via virtualenv\\ndocutils==0.21.2\\n # via\\n # -r docs.txt\\n # sphinx\\nfilelock==3.16.1\\n # via\\n # tox\\n # virtualenv\\nfreezegun==1.5.1\\n # via -r tests.txt\\nidentify==2.6.1\\n # via pre-commit\\nidna==3.10\\n # via\\n # -r docs.txt\\n # requests\\nimagesize==1.4.1\\n # via\\n # -r docs.txt\\n # sphinx\\niniconfig==2.0.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\njinja2==3.1.4\\n # via\\n # -r docs.txt\\n # sphinx\\nmarkupsafe==3.0.2\\n # via\\n # -r docs.txt\\n # jinja2\\nmypy==1.13.0\\n # via -r typing.txt\\nmypy-extensions==1.0.0\\n # via\\n # -r typing.txt\\n # mypy\\nnodeenv==1.9.1\\n # via\\n # -r typing.txt\\n # pre-commit\\n # pyright\\npackaging==24.1\\n # via\\n # -r docs.txt\\n # -r tests.txt\\n # -r typing.txt\\n # pallets-sphinx-themes\\n # pyproject-api\\n # pytest\\n # sphinx\\n # tox\\npallets-sphinx-themes==2.3.0\\n # via -r docs.txt\\nplatformdirs==4.3.6\\n # via\\n # tox\\n # virtualenv\\npluggy==1.5.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\n # tox\\npre-commit==4.0.1\\n # via -r dev.in\\npygments==2.18.0\\n # via\\n # -r docs.txt\\n # sphinx\\npyproject-api==1.8.0\\n # via tox\\npyright==1.1.386\\n # via -r typing.txt\\npytest==8.3.3\\n # via\\n # -r tests.txt\\n # -r typing.txt\\npython-dateutil==2.9.0.post0\\n # via\\n # -r tests.txt\\n # freezegun\\npyyaml==6.0.2\\n # via pre-commit\\nrequests==2.32.3\\n # via\\n # -r docs.txt\\n # sphinx\\nsix==1.16.0\\n # via\\n # -r tests.txt\\n # python-dateutil\\nsnowballstemmer==2.2.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.txt\\nsphinxcontrib-qthelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\ntox==4.23.2\\n # via -r dev.in\\ntyping-extensions==4.12.2\\n # via\\n # -r typing.txt\\n # mypy\\n # pyright\\nurllib3==2.2.3\\n # via\\n # -r docs.txt\\n # requests\\nvirtualenv==20.27.0\\n # via\\n # pre-commit\\n # tox\\n\\n[end of requirements/dev.txt]\",\n \"filename\": \"requirements/dev.txt\",\n \"id\": \"9\"\n },\n {\n \"content\": \"pallets-sphinx-themes\\nsphinx\\nsphinxcontrib-log-cabinet\\n\\n[end of requirements/docs.in]\",\n \"filename\": \"requirements/docs.in\",\n \"id\": \"10\"\n },\n {\n \"content\": \"build\\n\\n[end of requirements/build.in]\",\n \"filename\": \"requirements/build.in\",\n \"id\": \"11\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile typing.in\\n#\\niniconfig==2.0.0\\n # via pytest\\nmypy==1.13.0\\n # via -r typing.in\\nmypy-extensions==1.0.0\\n # via mypy\\nnodeenv==1.9.1\\n # via pyright\\npackaging==24.1\\n # via pytest\\npluggy==1.5.0\\n # via pytest\\npyright==1.1.386\\n # via -r typing.in\\npytest==8.3.3\\n # via -r typing.in\\ntyping-extensions==4.12.2\\n # via\\n # mypy\\n # pyright\\n\\n[end of requirements/typing.txt]\",\n \"filename\": \"requirements/typing.txt\",\n \"id\": \"12\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile build.in\\n#\\nbuild==1.2.2.post1\\n # via -r build.in\\npackaging==24.1\\n # via build\\npyproject-hooks==1.2.0\\n # via build\\n\\n[end of requirements/build.txt]\",\n \"filename\": \"requirements/build.txt\",\n \"id\": \"13\"\n },\n {\n \"content\": \"mypy\\npyright\\npytest\\n\\n[end of requirements/typing.in]\",\n \"filename\": \"requirements/typing.in\",\n \"id\": \"14\"\n },\n {\n \"content\": \"-r docs.txt\\n-r tests.txt\\n-r typing.txt\\npre-commit\\ntox\\n\\n[end of requirements/dev.in]\",\n \"filename\": \"requirements/dev.in\",\n \"id\": \"15\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile docs.in\\n#\\nalabaster==1.0.0\\n # via sphinx\\nbabel==2.16.0\\n # via sphinx\\ncertifi==2024.8.30\\n # via requests\\ncharset-normalizer==3.4.0\\n # via requests\\ndocutils==0.21.2\\n # via sphinx\\nidna==3.10\\n # via requests\\nimagesize==1.4.1\\n # via sphinx\\njinja2==3.1.4\\n # via sphinx\\nmarkupsafe==3.0.2\\n # via jinja2\\npackaging==24.1\\n # via\\n # pallets-sphinx-themes\\n # sphinx\\npallets-sphinx-themes==2.3.0\\n # via -r docs.in\\npygments==2.18.0\\n # via sphinx\\nrequests==2.32.3\\n # via sphinx\\nsnowballstemmer==2.2.0\\n # via sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.in\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.in\\nsphinxcontrib-qthelp==2.0.0\\n # via sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via sphinx\\nurllib3==2.2.3\\n # via requests\\n\\n[end of requirements/docs.txt]\",\n \"filename\": \"requirements/docs.txt\",\n \"id\": \"16\"\n },\n {\n \"content\": \".. rst-class:: hide-header\\n\\nItsDangerous\\n============\\n\\n.. image:: _static/itsdangerous-logo.png\\n :align: center\\n :target: https://palletsprojects.com/p/itsdangerous/\\n\\nSometimes you want to send some data to untrusted environments, then get\\nit back later. To do this safely, the data must be signed to detect\\nchanges.\\n\\nGiven a key only you know, you can cryptographically sign your data and\\nhand it over to someone else. When you get the data back you can ensure\\nthat nobody tampered with it.\\n\\nThe receiver can see the data, but they can not modify it unless they\\nalso have your key. So if you keep the key secret and complex, you will\\nbe fine.\\n\\n\\nInstalling\\n----------\\n\\nInstall and update using `pip`_:\\n\\n.. code-block:: text\\n\\n pip install -U itsdangerous\\n\\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\\n\\n\\nExample Use Cases\\n-----------------\\n\\n- Sign a user ID in a URL and email it to them to unsubscribe from a\\n newsletter. This way you don't need to generate one-time tokens and\\n store them in the database. Same thing with any kind of activation\\n link for accounts and similar things.\\n- Signed objects can be stored in cookies or other untrusted sources\\n which means you don't need to have sessions stored on the server,\\n which reduces the number of necessary database queries.\\n- Signed information can safely do a round trip between server and\\n client in general which makes them useful for passing server-side\\n state to a client and then back.\\n\\n\\nTable of Contents\\n-----------------\\n\\n.. toctree::\\n\\n concepts\\n serializer\\n signer\\n exceptions\\n timed\\n url_safe\\n encoding\\n license\\n changes\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"17\"\n },\n {\n \"content\": \".. module:: itsdangerous.serializer\\n\\nSerialization Interface\\n=======================\\n\\nThe :doc:`/signer` only signs bytes. To sign other types, the\\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\\nsimilar to Python's :mod:`json` module, which serializes the object to a\\nstring then signs that.\\n\\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n s = Serializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\\n\\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\\nthe data.\\n\\n.. code-block:: python\\n\\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\\n [1, 2, 3, 4]\\n\\nBy default, data is serialized to JSON with the built-in :mod:`json`\\nmodule. This internal serializer can be changed by subclassing.\\n\\nTo record and validate the age of the signature, see :doc:`/timed`.\\nTo serialize to a format that is safe to use in URLs, see\\n:doc:`/url_safe`.\\n\\n\\nResponding to Failure\\n---------------------\\n\\nExceptions have helpful attributes which allow you to inspect the\\npayload if the signature check failed. This has to be done with extra\\ncare because at that point you know that someone tampered with your data\\nbut it might be useful for debugging purposes.\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n from itsdangerous.exc import BadSignature, BadData\\n\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n decoded_payload = None\\n\\n try:\\n decoded_payload = s.loads(data)\\n # This payload is decoded and safe\\n except BadSignature as e:\\n if e.payload is not None:\\n try:\\n decoded_payload = s.load_payload(e.payload)\\n except BadData:\\n pass\\n # This payload is decoded but unsafe because someone\\n # tampered with the signature. The decode (load_payload)\\n # step is explicit because it might be unsafe to unserialize\\n # the payload (think pickle instead of json!)\\n\\nIf you don't want to inspect attributes to figure out what exactly went\\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\\n\\n.. code-block:: python\\n\\n sig_okay, payload = s.loads_unsafe(data)\\n\\nThe first item in the returned tuple is a boolean that indicates if the\\nsignature was correct.\\n\\n\\nFallback Signers\\n----------------\\n\\nYou may want to upgrade the signing parameters without invalidating\\nexisting signatures immediately. For example, you may decide that you\\nwant to use a different digest method. New signatures should use the new\\nmethod, but old signatures should still validate.\\n\\nA list of ``fallback_signers`` can be given that will be tried if\\nunsigning with the current signer fails. Each item in the list can be:\\n\\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\\n passed to the serializer.\\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\\n serializer.\\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\\n given class with the given args.\\n\\nFor example, this is a serializer that signs using SHA-512, but will\\nunsign using either SHA-512 or SHA-1:\\n\\n.. code-block:: python\\n\\n s = Serializer(\\n signer_kwargs={\\\"digest_method\\\": hashlib.sha512},\\n fallback_signers=[{\\\"digest_method\\\": hashlib.sha1}]\\n )\\n\\n\\n\\nAPI\\n---\\n\\n.. autoclass:: Serializer\\n :members:\\n\\n[end of docs/serializer.rst]\",\n \"filename\": \"docs/serializer.rst\",\n \"id\": \"18\"\n },\n {\n \"content\": \".. module:: itsdangerous.signer\\n\\nSigning Interface\\n=================\\n\\nThe most basic interface is the signing interface. The :class:`Signer`\\nclass can be used to attach a signature to a specific string:\\n\\n.. code-block:: python\\n\\n from itsdangerous import Signer\\n s = Signer(\\\"secret-key\\\")\\n s.sign(\\\"my string\\\")\\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\\n\\nThe signature is appended to the string, separated by a dot. To validate\\nthe string, use the :meth:`~Signer.unsign` method:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n b'my string'\\n\\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\\nHowever after unsigning you won't be able to tell if it was unicode or\\na bytestring.\\n\\nIf the value is changed, the signature will no longer match, and\\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nTo record and validate the age of a signature, see :doc:`/timed`.\\n\\n.. autoclass:: Signer\\n :members:\\n\\n\\nSigning Algorithms\\n------------------\\n\\n.. autoclass:: NoneAlgorithm\\n\\n.. autoclass:: HMACAlgorithm\\n\\n[end of docs/signer.rst]\",\n \"filename\": \"docs/signer.rst\",\n \"id\": \"19\"\n },\n {\n \"content\": \"General Concepts\\n================\\n\\n\\nSerializer vs Signer\\n--------------------\\n\\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\\nthe basic system that signs a given ``bytes`` value based on the given\\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\\nserializing and signing other data besides ``bytes``.\\n\\nTypically, you'll want to use a serializer, not a signer. You can\\nconfigure the signing parameters through the serializer, and even\\nprovide fallback signers to upgrade old tokens to new parameters.\\n\\n\\nThe Secret Key\\n--------------\\n\\nSignatures are secured by the ``secret_key``. Typically one secret key\\nis used with all signers, and the salt is used to distinguish different\\ncontexts. Changing the secret key will invalidate existing tokens.\\n\\nIt should be a long random string of bytes. This value must be kept\\nsecret and should not be saved in source code or committed to version\\ncontrol. If an attacker learns the secret key, they can change and\\nresign data to look valid. If you suspect this happened, change the\\nsecret key to invalidate existing tokens.\\n\\nOne way to keep the secret key separate is to read it from an\\nenvironment variable. When deploying for the first time, generate a key\\nand set the environment variable when running the application. All\\nprocess managers (like systemd) and hosting services have a way to\\nspecify environment variables.\\n\\n.. code-block:: python\\n\\n import os\\n from itsdangerous.serializer import Serializer\\n SECRET_KEY = os.environ.get(\\\"SECRET_KEY\\\")\\n s = Serializer(SECRET_KEY)\\n\\n.. code-block:: text\\n\\n $ export SECRET_KEY=\\\"base64 encoded random bytes\\\"\\n $ python application.py\\n\\nOne way to generate a key is to use :func:`os.urandom`.\\n\\n.. code-block:: text\\n\\n $ python3 -c 'import os; print(os.urandom(16).hex())'\\n\\n\\nThe Salt\\n--------\\n\\nThe salt is combined with the secret key to derive a unique key for\\ndistinguishing different contexts. Unlike the secret key, the salt\\ndoesn't have to be random, and can be saved in code. It only has to be\\nunique between contexts, not private.\\n\\nFor example, you want to email activation links to activate user\\naccounts, and upgrade links to upgrade users to a paid accounts. If all\\nyou sign is the user id, and you don't use different salts, a user could\\nreuse the token from the activation link to upgrade the account. If you\\nuse different salts, the signatures will be different and will not be\\nvalid in the other context.\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n\\n s1 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"activate\\\")\\n s1.dumps(42)\\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\\n\\n s2 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"upgrade\\\")\\n s2.dumps(42)\\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\\n\\nThe second serializer can't load data dumped with the first because the\\nsalts differ.\\n\\n.. code-block:: python\\n\\n s2.loads(s1.dumps(42))\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nOnly the serializer with the same salt can load the data.\\n\\n.. code-block:: python\\n\\n s2.loads(s2.dumps(42))\\n 42\\n\\n\\nKey Rotation\\n------------\\n\\nKey rotation can provide an extra layer of mitigation against an\\nattacker discovering a secret key. A rotation system will keep a list of\\nvalid keys, generating a new key and removing the oldest key\\nperiodically. If it takes four weeks for an attacker to crack a key, but\\nthe key is rotated out after three weeks, they will not be able to use\\nany keys they crack. However, if a user doesn't refresh their token\\nwithin three weeks it will be invalid too.\\n\\nThe system that generates and maintains this list is outside the scope\\nof ItsDangerous, but ItsDangerous does support validating against a list\\nof keys.\\n\\nInstead of passing a single key, you can pass a list of keys, oldest to\\nnewest. When signing the last (newest) key will be used, and when\\nvalidating each key will be tried from newest to oldest before raising\\na validation error.\\n\\n.. code-block:: python\\n\\n SECRET_KEYS = [\\\"2b9cd98e\\\", \\\"169d7886\\\", \\\"b6af09f5\\\"]\\n\\n # sign some data with the latest key\\n s = Serializer(SECRET_KEYS)\\n t = s.dumps({\\\"id\\\": 42})\\n\\n # rotate a new key in and the oldest key out\\n SECRET_KEYS.append(\\\"cf9b3588\\\")\\n del SECRET_KEYS[0]\\n\\n s = Serializer(SECRET_KEYS)\\n s.loads(t) # valid even though it was signed with a previous key\\n\\n\\nDigest Method Security\\n----------------------\\n\\nA signer is configured with a ``digest_method``, a hash function that\\nis used as an intermediate step when generating the HMAC signature. The\\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\\nconcerned about this default because they have heard about hash\\ncollisions with SHA-1.\\n\\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\\nhash alone doesn't apply when used in HMAC.\\n\\nIf a project considers SHA-1 a risk anyway, they can configure the\\nsigner with a different digest method such as :func:`hashlib.sha512`.\\nA fallback signer for SHA-1 can be configured so that old tokens will be\\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\\nspace, which is relevant in cookies and URLs.\\n\\n[end of docs/concepts.rst]\",\n \"filename\": \"docs/concepts.rst\",\n \"id\": \"20\"\n },\n {\n \"content\": \".. module:: itsdangerous.url_safe\\n\\nURL Safe Serialization\\n======================\\n\\nOften it is helpful if you can pass these trusted strings in places\\nwhere you only have a limited set of characters available. Because of\\nthis, ItsDangerous also provides URL safe serializers:\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\\n s.loads(\\\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\\\")\\n [1, 2, 3, 4]\\n\\n.. autoclass:: URLSafeSerializer\\n\\n.. autoclass:: URLSafeTimedSerializer\\n\\n[end of docs/url_safe.rst]\",\n \"filename\": \"docs/url_safe.rst\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. module:: itsdangerous.encoding\\n\\nEncoding Utilities\\n==================\\n\\n.. autofunction:: base64_encode\\n\\n.. autofunction:: base64_decode\\n\\n[end of docs/encoding.rst]\",\n \"filename\": \"docs/encoding.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"# Minimal makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nSOURCEDIR = .\\nBUILDDIR = _build\\n\\n# Put it first so that \\\"make\\\" without argument is like \\\"make help\\\".\\nhelp:\\n\\t@$(SPHINXBUILD) -M help \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n.PHONY: help Makefile\\n\\n# Catch-all target: route all unknown targets to Sphinx using the new\\n# \\\"make mode\\\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\\n%: Makefile\\n\\t@$(SPHINXBUILD) -M $@ \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"23\"\n },\n {\n \"content\": \"from pallets_sphinx_themes import get_version\\nfrom pallets_sphinx_themes import ProjectLink\\n\\n# Project --------------------------------------------------------------\\n\\nproject = \\\"ItsDangerous\\\"\\ncopyright = \\\"2011 Pallets\\\"\\nauthor = \\\"Pallets\\\"\\nrelease, version = get_version(\\\"itsdangerous\\\")\\n\\n# General --------------------------------------------------------------\\n\\ndefault_role = \\\"code\\\"\\nextensions = [\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"sphinx.ext.extlinks\\\",\\n \\\"sphinx.ext.intersphinx\\\",\\n \\\"sphinxcontrib.log_cabinet\\\",\\n \\\"pallets_sphinx_themes\\\",\\n]\\nautoclass_content = \\\"both\\\"\\nautodoc_member_order = \\\"bysource\\\"\\nautodoc_typehints = \\\"description\\\"\\nautodoc_preserve_defaults = True\\nextlinks = {\\n \\\"issue\\\": (\\\"https://github.com/pallets/itsdangerous/issues/%s\\\", \\\"#%s\\\"),\\n \\\"pr\\\": (\\\"https://github.com/pallets/itsdangerous/pull/%s\\\", \\\"#%s\\\"),\\n}\\nintersphinx_mapping = {\\n \\\"python\\\": (\\\"https://docs.python.org/3/\\\", None),\\n}\\n\\n# HTML -----------------------------------------------------------------\\n\\nhtml_theme = \\\"flask\\\"\\nhtml_theme_options = {\\\"index_sidebar_logo\\\": False}\\nhtml_context = {\\n \\\"project_links\\\": [\\n ProjectLink(\\\"Donate\\\", \\\"https://palletsprojects.com/donate\\\"),\\n ProjectLink(\\\"PyPI Releases\\\", \\\"https://pypi.org/project/itsdangerous/\\\"),\\n ProjectLink(\\\"Source Code\\\", \\\"https://github.com/pallets/itsdangerous/\\\"),\\n ProjectLink(\\\"Issue Tracker\\\", \\\"https://github.com/pallets/itsdangerous/issues/\\\"),\\n ProjectLink(\\\"Chat\\\", \\\"https://discord.gg/pallets\\\"),\\n ]\\n}\\nhtml_sidebars = {\\n \\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n \\\"**\\\": [\\\"localtoc.html\\\", \\\"relations.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n}\\nsinglehtml_sidebars = {\\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"ethicalads.html\\\"]}\\nhtml_static_path = [\\\"_static\\\"]\\nhtml_favicon = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_logo = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_title = f\\\"{project} Documentation ({version})\\\"\\nhtml_show_sourcelink = False\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\npushd %~dp0\\n\\nREM Command file for Sphinx documentation\\n\\nif \\\"%SPHINXBUILD%\\\" == \\\"\\\" (\\n\\tset SPHINXBUILD=sphinx-build\\n)\\nset SOURCEDIR=.\\nset BUILDDIR=_build\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\n%SPHINXBUILD% >NUL 2>NUL\\nif errorlevel 9009 (\\n\\techo.\\n\\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\\n\\techo.installed, then set the SPHINXBUILD environment variable to point\\n\\techo.to the full path of the 'sphinx-build' executable. Alternatively you\\n\\techo.may add the Sphinx directory to PATH.\\n\\techo.\\n\\techo.If you don't have Sphinx installed, grab it from\\n\\techo.http://sphinx-doc.org/\\n\\texit /b 1\\n)\\n\\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\ngoto end\\n\\n:help\\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\n\\n:end\\npopd\\n\\n[end of docs/make.bat]\",\n \"filename\": \"docs/make.bat\",\n \"id\": \"25\"\n },\n {\n \"content\": \".. module:: itsdangerous.timed\\n\\nSigning With Timestamps\\n=======================\\n\\nIf you want to expire signatures you can use the\\n:class:`TimestampSigner` class which adds timestamp information and\\nsigns it. On unsigning you can validate that the timestamp is not older\\nthan a given age.\\n\\n.. code-block:: python\\n\\n from itsdangerous import TimestampSigner\\n s = TimestampSigner('secret-key')\\n string = s.sign('foo')\\n\\n.. code-block:: python\\n\\n s.unsign(string, max_age=5)\\n Traceback (most recent call last):\\n ...\\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\\n\\n.. autoclass:: TimestampSigner\\n :members:\\n\\n.. autoclass:: TimedSerializer\\n :members:\\n\\n[end of docs/timed.rst]\",\n \"filename\": \"docs/timed.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"BSD-3-Clause License\\n====================\\n\\n.. literalinclude:: ../LICENSE.txt\\n :language: text\\n\\n[end of docs/license.rst]\",\n \"filename\": \"docs/license.rst\",\n \"id\": \"27\"\n },\n {\n \"content\": \"Changes\\n=======\\n\\n.. include:: ../CHANGES.rst\\n\\n[end of docs/changes.rst]\",\n \"filename\": \"docs/changes.rst\",\n \"id\": \"28\"\n },\n {\n \"content\": \".. module:: itsdangerous.exc\\n\\nExceptions\\n==========\\n\\n.. autoexception:: BadData\\n :members:\\n\\n.. autoexception:: BadSignature\\n :members:\\n\\n.. autoexception:: BadTimeSignature\\n :members:\\n\\n.. autoexception:: SignatureExpired\\n :members:\\n\\n.. autoexception:: BadHeader\\n :members:\\n\\n.. autoexception:: BadPayload\\n :members:\\n\\n[end of docs/exceptions.rst]\",\n \"filename\": \"docs/exceptions.rst\",\n \"id\": \"29\"\n },\n {\n \"content\": \"#!/bin/bash\\nset -e\\npython3 -m venv --upgrade-deps .venv\\n. .venv/bin/activate\\npip install -r requirements/dev.txt\\npip install -e .\\npre-commit install --install-hooks\\n\\n[end of .devcontainer/on-create-command.sh]\",\n \"filename\": \".devcontainer/on-create-command.sh\",\n \"id\": \"30\"\n },\n {\n \"content\": \"{\\n \\\"name\\\": \\\"pallets/itsdangerous\\\",\\n \\\"image\\\": \\\"mcr.microsoft.com/devcontainers/python:3\\\",\\n \\\"customizations\\\": {\\n \\\"vscode\\\": {\\n \\\"settings\\\": {\\n \\\"python.defaultInterpreterPath\\\": \\\"${workspaceFolder}/.venv\\\",\\n \\\"python.terminal.activateEnvInCurrentTerminal\\\": true,\\n \\\"python.terminal.launchArgs\\\": [\\n \\\"-X\\\",\\n \\\"dev\\\"\\n ]\\n }\\n }\\n },\\n \\\"onCreateCommand\\\": \\\".devcontainer/on-create-command.sh\\\"\\n}\\n\\n[end of .devcontainer/devcontainer.json]\",\n \"filename\": \".devcontainer/devcontainer.json\",\n \"id\": \"31\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo-sidebar.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo-sidebar.png\",\n \"id\": \"32\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo.png\",\n \"id\": \"33\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport json as _json\\nimport typing as t\\n\\n\\nclass _CompactJSON:\\n \\\"\\\"\\\"Wrapper around json module that strips whitespace.\\\"\\\"\\\"\\n\\n @staticmethod\\n def loads(payload: str | bytes) -> t.Any:\\n return _json.loads(payload)\\n\\n @staticmethod\\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\\n kwargs.setdefault(\\\"ensure_ascii\\\", False)\\n kwargs.setdefault(\\\"separators\\\", (\\\",\\\", \\\":\\\"))\\n return _json.dumps(obj, **kwargs)\\n\\n[end of src/itsdangerous/_json.py]\",\n \"filename\": \"src/itsdangerous/_json.py\",\n \"id\": \"34\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport time\\nimport typing as t\\nfrom datetime import datetime\\nfrom datetime import timezone\\n\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import bytes_to_int\\nfrom .encoding import int_to_bytes\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\nfrom .exc import BadTimeSignature\\nfrom .exc import SignatureExpired\\nfrom .serializer import _TSerialized\\nfrom .serializer import Serializer\\nfrom .signer import Signer\\n\\n\\nclass TimestampSigner(Signer):\\n \\\"\\\"\\\"Works like the regular :class:`.Signer` but also records the time\\n of the signing and can be used to expire signatures. The\\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\\n unsigning failed because the signature is expired.\\n \\\"\\\"\\\"\\n\\n def get_timestamp(self) -> int:\\n \\\"\\\"\\\"Returns the current timestamp. The function must return an\\n integer.\\n \\\"\\\"\\\"\\n return int(time.time())\\n\\n def timestamp_to_datetime(self, ts: int) -> datetime:\\n \\\"\\\"\\\"Convert the timestamp from :meth:`get_timestamp` into an\\n aware :class`datetime.datetime` in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n return datetime.fromtimestamp(ts, tz=timezone.utc)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string and also attaches time information.\\\"\\\"\\\"\\n value = want_bytes(value)\\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\\n sep = want_bytes(self.sep)\\n value = value + sep + timestamp\\n return value + sep + self.get_signature(value)\\n\\n # Ignore overlapping signatures check, return_timestamp is the only\\n # parameter that affects the return type.\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[False] = False,\\n ) -> bytes: ...\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[True] = True,\\n ) -> tuple[bytes, datetime]: ...\\n\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n ) -> tuple[bytes, datetime] | bytes:\\n \\\"\\\"\\\"Works like the regular :meth:`.Signer.unsign` but can also\\n validate the time. See the base docstring of the class for\\n the general behavior. If ``return_timestamp`` is ``True`` the\\n timestamp of the signature will be returned as an aware\\n :class:`datetime.datetime` object in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n try:\\n result = super().unsign(signed_value)\\n sig_error = None\\n except BadSignature as e:\\n sig_error = e\\n result = e.payload or b\\\"\\\"\\n\\n sep = want_bytes(self.sep)\\n\\n # If there is no timestamp in the result there is something\\n # seriously wrong. In case there was a signature error, we raise\\n # that one directly, otherwise we have a weird situation in\\n # which we shouldn't have come except someone uses a time-based\\n # serializer on non-timestamp data, so catch that.\\n if sep not in result:\\n if sig_error:\\n raise sig_error\\n\\n raise BadTimeSignature(\\\"timestamp missing\\\", payload=result)\\n\\n value, ts_bytes = result.rsplit(sep, 1)\\n ts_int: int | None = None\\n ts_dt: datetime | None = None\\n\\n try:\\n ts_int = bytes_to_int(base64_decode(ts_bytes))\\n except Exception:\\n pass\\n\\n # Signature is *not* okay. Raise a proper error now that we have\\n # split the value and the timestamp.\\n if sig_error is not None:\\n if ts_int is not None:\\n try:\\n ts_dt = self.timestamp_to_datetime(ts_int)\\n except (ValueError, OSError, OverflowError) as exc:\\n # Windows raises OSError\\n # 32-bit raises OverflowError\\n raise BadTimeSignature(\\n \\\"Malformed timestamp\\\", payload=value\\n ) from exc\\n\\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\\n\\n # Signature was okay but the timestamp is actually not there or\\n # malformed. Should not happen, but we handle it anyway.\\n if ts_int is None:\\n raise BadTimeSignature(\\\"Malformed timestamp\\\", payload=value)\\n\\n # Check timestamp is not older than max_age\\n if max_age is not None:\\n age = self.get_timestamp() - ts_int\\n\\n if age > max_age:\\n raise SignatureExpired(\\n f\\\"Signature age {age} > {max_age} seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if age < 0:\\n raise SignatureExpired(\\n f\\\"Signature age {age} < 0 seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if return_timestamp:\\n return value, self.timestamp_to_datetime(ts_int)\\n\\n return value\\n\\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\\"\\\"\\\"\\n try:\\n self.unsign(signed_value, max_age=max_age)\\n return True\\n except BadSignature:\\n return False\\n\\n\\nclass TimedSerializer(Serializer[_TSerialized]):\\n \\\"\\\"\\\"Uses :class:`TimestampSigner` instead of the default\\n :class:`.Signer`.\\n \\\"\\\"\\\"\\n\\n default_signer: type[TimestampSigner] = TimestampSigner\\n\\n def iter_unsigners(\\n self, salt: str | bytes | None = None\\n ) -> cabc.Iterator[TimestampSigner]:\\n return t.cast(\\\"cabc.Iterator[TimestampSigner]\\\", super().iter_unsigners(salt))\\n\\n # TODO: Signature is incompatible because parameters were added\\n # before salt.\\n\\n def loads( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n salt: str | bytes | None = None,\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\\n signature validation fails. If a ``max_age`` is provided it will\\n ensure the signature is not older than that time in seconds. In\\n case the signature is outdated, :exc:`.SignatureExpired` is\\n raised. All arguments are forwarded to the signer's\\n :meth:`~TimestampSigner.unsign` method.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n base64d, timestamp = signer.unsign(\\n s, max_age=max_age, return_timestamp=True\\n )\\n payload = self.load_payload(base64d)\\n\\n if return_timestamp:\\n return payload, timestamp\\n\\n return payload\\n except SignatureExpired:\\n # The signature was unsigned successfully but was\\n # expired. Do not try the next signer.\\n raise\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def loads_unsafe( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n salt: str | bytes | None = None,\\n ) -> tuple[bool, t.Any]:\\n return self._loads_unsafe_impl(s, salt, load_kwargs={\\\"max_age\\\": max_age})\\n\\n[end of src/itsdangerous/timed.py]\",\n \"filename\": \"src/itsdangerous/timed.py\",\n \"id\": \"35\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport base64\\nimport string\\nimport struct\\nimport typing as t\\n\\nfrom .exc import BadData\\n\\n\\ndef want_bytes(\\n s: str | bytes, encoding: str = \\\"utf-8\\\", errors: str = \\\"strict\\\"\\n) -> bytes:\\n if isinstance(s, str):\\n s = s.encode(encoding, errors)\\n\\n return s\\n\\n\\ndef base64_encode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 encode a string of bytes or text. The resulting bytes are\\n safe to use in URLs.\\n \\\"\\\"\\\"\\n string = want_bytes(string)\\n return base64.urlsafe_b64encode(string).rstrip(b\\\"=\\\")\\n\\n\\ndef base64_decode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 decode a URL-safe string of bytes or text. The result is\\n bytes.\\n \\\"\\\"\\\"\\n string = want_bytes(string, encoding=\\\"ascii\\\", errors=\\\"ignore\\\")\\n string += b\\\"=\\\" * (-len(string) % 4)\\n\\n try:\\n return base64.urlsafe_b64decode(string)\\n except (TypeError, ValueError) as e:\\n raise BadData(\\\"Invalid base64-encoded data\\\") from e\\n\\n\\n# The alphabet used by base64.urlsafe_*\\n_base64_alphabet = f\\\"{string.ascii_letters}{string.digits}-_=\\\".encode(\\\"ascii\\\")\\n\\n_int64_struct = struct.Struct(\\\">Q\\\")\\n_int_to_bytes = _int64_struct.pack\\n_bytes_to_int = t.cast(\\\"t.Callable[[bytes], tuple[int]]\\\", _int64_struct.unpack)\\n\\n\\ndef int_to_bytes(num: int) -> bytes:\\n return _int_to_bytes(num).lstrip(b\\\"\\\\x00\\\")\\n\\n\\ndef bytes_to_int(bytestr: bytes) -> int:\\n return _bytes_to_int(bytestr.rjust(8, b\\\"\\\\x00\\\"))[0]\\n\\n[end of src/itsdangerous/encoding.py]\",\n \"filename\": \"src/itsdangerous/encoding.py\",\n \"id\": \"36\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\n\\nfrom .encoding import base64_decode as base64_decode\\nfrom .encoding import base64_encode as base64_encode\\nfrom .encoding import want_bytes as want_bytes\\nfrom .exc import BadData as BadData\\nfrom .exc import BadHeader as BadHeader\\nfrom .exc import BadPayload as BadPayload\\nfrom .exc import BadSignature as BadSignature\\nfrom .exc import BadTimeSignature as BadTimeSignature\\nfrom .exc import SignatureExpired as SignatureExpired\\nfrom .serializer import Serializer as Serializer\\nfrom .signer import HMACAlgorithm as HMACAlgorithm\\nfrom .signer import NoneAlgorithm as NoneAlgorithm\\nfrom .signer import Signer as Signer\\nfrom .timed import TimedSerializer as TimedSerializer\\nfrom .timed import TimestampSigner as TimestampSigner\\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\\n\\n\\ndef __getattr__(name: str) -> t.Any:\\n if name == \\\"__version__\\\":\\n import importlib.metadata\\n import warnings\\n\\n warnings.warn(\\n \\\"The '__version__' attribute is deprecated and will be removed in\\\"\\n \\\" ItsDangerous 2.3. Use feature detection or\\\"\\n \\\" 'importlib.metadata.version(\\\\\\\"itsdangerous\\\\\\\")' instead.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return importlib.metadata.version(\\\"itsdangerous\\\")\\n\\n raise AttributeError(name)\\n\\n[end of src/itsdangerous/__init__.py]\",\n \"filename\": \"src/itsdangerous/__init__.py\",\n \"id\": \"37\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nimport zlib\\n\\nfrom ._json import _CompactJSON\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .exc import BadPayload\\nfrom .serializer import _PDataSerializer\\nfrom .serializer import Serializer\\nfrom .timed import TimedSerializer\\n\\n\\nclass URLSafeSerializerMixin(Serializer[str]):\\n \\\"\\\"\\\"Mixed in with a regular serializer it will attempt to zlib\\n compress the string to make it shorter if necessary. It will also\\n base64 encode the string so that it can safely be placed in a URL.\\n \\\"\\\"\\\"\\n\\n default_serializer: _PDataSerializer[str] = _CompactJSON\\n\\n def load_payload(\\n self,\\n payload: bytes,\\n *args: t.Any,\\n serializer: t.Any | None = None,\\n **kwargs: t.Any,\\n ) -> t.Any:\\n decompress = False\\n\\n if payload.startswith(b\\\".\\\"):\\n payload = payload[1:]\\n decompress = True\\n\\n try:\\n json = base64_decode(payload)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not base64 decode the payload because of an exception\\\",\\n original_error=e,\\n ) from e\\n\\n if decompress:\\n try:\\n json = zlib.decompress(json)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not zlib decompress the payload before decoding the payload\\\",\\n original_error=e,\\n ) from e\\n\\n return super().load_payload(json, *args, **kwargs)\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n json = super().dump_payload(obj)\\n is_compressed = False\\n compressed = zlib.compress(json)\\n\\n if len(compressed) < (len(json) - 1):\\n json = compressed\\n is_compressed = True\\n\\n base64d = base64_encode(json)\\n\\n if is_compressed:\\n base64d = b\\\".\\\" + base64d\\n\\n return base64d\\n\\n\\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\\n \\\"\\\"\\\"Works like :class:`.Serializer` but dumps and loads into a URL\\n safe string consisting of the upper and lowercase character of the\\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n\\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\\n \\\"\\\"\\\"Works like :class:`.TimedSerializer` but dumps and loads into a\\n URL safe string consisting of the upper and lowercase character of\\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n[end of src/itsdangerous/url_safe.py]\",\n \"filename\": \"src/itsdangerous/url_safe.py\",\n \"id\": \"38\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nfrom datetime import datetime\\n\\n\\nclass BadData(Exception):\\n \\\"\\\"\\\"Raised if bad data of any sort was encountered. This is the base\\n for all exceptions that ItsDangerous defines.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str):\\n super().__init__(message)\\n self.message = message\\n\\n def __str__(self) -> str:\\n return self.message\\n\\n\\nclass BadSignature(BadData):\\n \\\"\\\"\\\"Raised if a signature does not match.\\\"\\\"\\\"\\n\\n def __init__(self, message: str, payload: t.Any | None = None):\\n super().__init__(message)\\n\\n #: The payload that failed the signature test. In some\\n #: situations you might still want to inspect this, even if\\n #: you know it was tampered with.\\n #:\\n #: .. versionadded:: 0.14\\n self.payload: t.Any | None = payload\\n\\n\\nclass BadTimeSignature(BadSignature):\\n \\\"\\\"\\\"Raised if a time-based signature is invalid. This is a subclass\\n of :class:`BadSignature`.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n date_signed: datetime | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the signature expired this exposes the date of when the\\n #: signature was created. This can be helpful in order to\\n #: tell the user how long a link has been gone stale.\\n #:\\n #: .. versionchanged:: 2.0\\n #: The datetime value is timezone-aware rather than naive.\\n #:\\n #: .. versionadded:: 0.14\\n self.date_signed = date_signed\\n\\n\\nclass SignatureExpired(BadTimeSignature):\\n \\\"\\\"\\\"Raised if a signature timestamp is older than ``max_age``. This\\n is a subclass of :exc:`BadTimeSignature`.\\n \\\"\\\"\\\"\\n\\n\\nclass BadHeader(BadSignature):\\n \\\"\\\"\\\"Raised if a signed header is invalid in some form. This only\\n happens for serializers that have a header that goes with the\\n signature.\\n\\n .. versionadded:: 0.24\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n header: t.Any | None = None,\\n original_error: Exception | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the header is actually available but just malformed it\\n #: might be stored here.\\n self.header: t.Any | None = header\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n\\nclass BadPayload(BadData):\\n \\\"\\\"\\\"Raised if a payload is invalid. This could happen if the payload\\n is loaded despite an invalid signature, or if there is a mismatch\\n between the serializer and deserializer. The original exception\\n that occurred during loading is stored on as :attr:`original_error`.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str, original_error: Exception | None = None):\\n super().__init__(message)\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n[end of src/itsdangerous/exc.py]\",\n \"filename\": \"src/itsdangerous/exc.py\",\n \"id\": \"39\"\n },\n {\n \"content\": \"[end of src/itsdangerous/py.typed]\",\n \"filename\": \"src/itsdangerous/py.typed\",\n \"id\": \"40\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport json\\nimport typing as t\\n\\nfrom .encoding import want_bytes\\nfrom .exc import BadPayload\\nfrom .exc import BadSignature\\nfrom .signer import _make_keys_list\\nfrom .signer import Signer\\n\\nif t.TYPE_CHECKING:\\n import typing_extensions as te\\n\\n # This should be either be str or bytes. To avoid having to specify the\\n # bound type, it falls back to a union if structural matching fails.\\n _TSerialized = te.TypeVar(\\n \\\"_TSerialized\\\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\\n )\\nelse:\\n # Still available at runtime on Python < 3.13, but without the default.\\n _TSerialized = t.TypeVar(\\\"_TSerialized\\\", bound=t.Union[str, bytes])\\n\\n\\nclass _PDataSerializer(t.Protocol[_TSerialized]):\\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\\n # A signature with additional arguments is not handled correctly by type\\n # checkers right now, so an overload is used below for serializers that\\n # don't match this strict protocol.\\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\\n\\n\\n# Use TypeIs once it's available in typing_extensions or 3.13.\\ndef is_text_serializer(\\n serializer: _PDataSerializer[t.Any],\\n) -> te.TypeGuard[_PDataSerializer[str]]:\\n \\\"\\\"\\\"Checks whether a serializer generates text or binary.\\\"\\\"\\\"\\n return isinstance(serializer.dumps({}), str)\\n\\n\\nclass Serializer(t.Generic[_TSerialized]):\\n \\\"\\\"\\\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\\n enable serializing and securely signing data other than bytes. It\\n can unsign to verify that the data hasn't been changed.\\n\\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\\n :mod:`json`, and by default uses :mod:`json` internally to serialize\\n the data to bytes.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param serializer: An object that provides ``dumps`` and ``loads``\\n methods for serializing data to a string. Defaults to\\n :attr:`default_serializer`, which defaults to :mod:`json`.\\n :param serializer_kwargs: Keyword arguments to pass when calling\\n ``serializer.dumps``.\\n :param signer: A ``Signer`` class to instantiate when signing data.\\n Defaults to :attr:`default_signer`, which defaults to\\n :class:`~itsdangerous.signer.Signer`.\\n :param signer_kwargs: Keyword arguments to pass when instantiating\\n the ``Signer`` class.\\n :param fallback_signers: List of signer parameters to try when\\n unsigning with the default signer fails. Each item can be a dict\\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\\n ``(signer, signer_kwargs)``. Defaults to\\n :attr:`default_fallback_signers`.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 2.0\\n Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``.\\n\\n .. versionchanged:: 1.1\\n Added support for ``fallback_signers`` and configured a default\\n SHA-512 fallback. This fallback is for users who used the yanked\\n 1.0.0 release which defaulted to SHA-512.\\n\\n .. versionchanged:: 0.14\\n The ``signer`` and ``signer_kwargs`` parameters were added to\\n the constructor.\\n \\\"\\\"\\\"\\n\\n #: The default serialization module to use to serialize data to a\\n #: string internally. The default is :mod:`json`, but can be changed\\n #: to any object that provides ``dumps`` and ``loads`` methods.\\n default_serializer: _PDataSerializer[t.Any] = json\\n\\n #: The default ``Signer`` class to instantiate when signing data.\\n #: The default is :class:`itsdangerous.signer.Signer`.\\n default_signer: type[Signer] = Signer\\n\\n #: The default fallback signers to try when unsigning fails.\\n default_fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = []\\n\\n # Serializer[str] if no data serializer is provided, or if it returns str.\\n @t.overload\\n def __init__(\\n self: Serializer[str],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: None | _PDataSerializer[str] = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer positional argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer keyword argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a positional argument. If the strict signature of\\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\\n # to specify the type.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a keyword argument.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: t.Any | None = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n # if salt is None then the signer's default is used\\n\\n self.salt = salt\\n\\n if serializer is None:\\n serializer = self.default_serializer\\n\\n self.serializer: _PDataSerializer[_TSerialized] = serializer\\n self.is_text_serializer: bool = is_text_serializer(serializer)\\n\\n if signer is None:\\n signer = self.default_signer\\n\\n self.signer: type[Signer] = signer\\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\\n\\n if fallback_signers is None:\\n fallback_signers = list(self.default_fallback_signers)\\n\\n self.fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = fallback_signers\\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def load_payload(\\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\\n ) -> t.Any:\\n \\\"\\\"\\\"Loads the encoded object. This function raises\\n :class:`.BadPayload` if the payload is not valid. The\\n ``serializer`` parameter can be used to override the serializer\\n stored on the class. The encoded ``payload`` should always be\\n bytes.\\n \\\"\\\"\\\"\\n if serializer is None:\\n use_serializer = self.serializer\\n is_text = self.is_text_serializer\\n else:\\n use_serializer = serializer\\n is_text = is_text_serializer(serializer)\\n\\n try:\\n if is_text:\\n return use_serializer.loads(payload.decode(\\\"utf-8\\\")) # type: ignore[arg-type]\\n\\n return use_serializer.loads(payload) # type: ignore[arg-type]\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not load the payload because an exception\\\"\\n \\\" occurred on unserializing the data.\\\",\\n original_error=e,\\n ) from e\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n \\\"\\\"\\\"Dumps the encoded object. The return value is always bytes.\\n If the internal serializer returns text, the value will be\\n encoded as UTF-8.\\n \\\"\\\"\\\"\\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\\n\\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\\n \\\"\\\"\\\"Creates a new instance of the signer to be used. The default\\n implementation uses the :class:`.Signer` base class.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\\n\\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\\n \\\"\\\"\\\"Iterates over all signers to be tried for unsigning. Starts\\n with the configured signer, then constructs each signer\\n specified in ``fallback_signers``.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n yield self.make_signer(salt)\\n\\n for fallback in self.fallback_signers:\\n if isinstance(fallback, dict):\\n kwargs = fallback\\n fallback = self.signer\\n elif isinstance(fallback, tuple):\\n fallback, kwargs = fallback\\n else:\\n kwargs = self.signer_kwargs\\n\\n for secret_key in self.secret_keys:\\n yield fallback(secret_key, salt=salt, **kwargs)\\n\\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\\n \\\"\\\"\\\"Returns a signed string serialized with the internal\\n serializer. The return value can be either a byte or unicode\\n string depending on the format of the internal serializer.\\n \\\"\\\"\\\"\\n payload = want_bytes(self.dump_payload(obj))\\n rv = self.make_signer(salt).sign(payload)\\n\\n if self.is_text_serializer:\\n return rv.decode(\\\"utf-8\\\") # type: ignore[return-value]\\n\\n return rv # type: ignore[return-value]\\n\\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\\n \\\"\\\"\\\"Like :meth:`dumps` but dumps into a file. The file handle has\\n to be compatible with what the internal serializer expects.\\n \\\"\\\"\\\"\\n f.write(self.dumps(obj, salt))\\n\\n def loads(\\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\\n signature validation fails.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n return self.load_payload(signer.unsign(s))\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\\n \\\"\\\"\\\"Like :meth:`loads` but loads from a file.\\\"\\\"\\\"\\n return self.loads(f.read(), salt)\\n\\n def loads_unsafe(\\n self, s: str | bytes, salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads` but without verifying the signature. This\\n is potentially very dangerous to use depending on how your\\n serializer works. The return value is ``(signature_valid,\\n payload)`` instead of just the payload. The first item will be a\\n boolean that indicates if the signature is valid. This function\\n never fails.\\n\\n Use it for debugging only and if you know that your serializer\\n module is not exploitable (for example, do not use it with a\\n pickle serializer).\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self._loads_unsafe_impl(s, salt)\\n\\n def _loads_unsafe_impl(\\n self,\\n s: str | bytes,\\n salt: str | bytes | None,\\n load_kwargs: dict[str, t.Any] | None = None,\\n load_payload_kwargs: dict[str, t.Any] | None = None,\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Low level helper function to implement :meth:`loads_unsafe`\\n in serializer subclasses.\\n \\\"\\\"\\\"\\n if load_kwargs is None:\\n load_kwargs = {}\\n\\n try:\\n return True, self.loads(s, salt=salt, **load_kwargs)\\n except BadSignature as e:\\n if e.payload is None:\\n return False, None\\n\\n if load_payload_kwargs is None:\\n load_payload_kwargs = {}\\n\\n try:\\n return (\\n False,\\n self.load_payload(e.payload, **load_payload_kwargs),\\n )\\n except BadPayload:\\n return False, None\\n\\n def load_unsafe(\\n self, f: t.IO[t.Any], salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads_unsafe` but loads from a file.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self.loads_unsafe(f.read(), salt=salt)\\n\\n[end of src/itsdangerous/serializer.py]\",\n \"filename\": \"src/itsdangerous/serializer.py\",\n \"id\": \"41\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport hashlib\\nimport hmac\\nimport typing as t\\n\\nfrom .encoding import _base64_alphabet\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\n\\n\\nclass SigningAlgorithm:\\n \\\"\\\"\\\"Subclasses must implement :meth:`get_signature` to provide\\n signature generation functionality.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given key and value.\\\"\\\"\\\"\\n raise NotImplementedError()\\n\\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\\n \\\"\\\"\\\"Verifies the given signature matches the expected\\n signature.\\n \\\"\\\"\\\"\\n return hmac.compare_digest(sig, self.get_signature(key, value))\\n\\n\\nclass NoneAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides an algorithm that does not perform any signing and\\n returns an empty signature.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n return b\\\"\\\"\\n\\n\\ndef _lazy_sha1(string: bytes = b\\\"\\\") -> t.Any:\\n \\\"\\\"\\\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\\n SHA-1, in which case the import and use as a default would fail before the\\n developer can configure something else.\\n \\\"\\\"\\\"\\n return hashlib.sha1(string)\\n\\n\\nclass HMACAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides signature generation using HMACs.\\\"\\\"\\\"\\n\\n #: The digest method to use with the MAC algorithm. This defaults to\\n #: SHA1, but can be changed to any other function in the hashlib\\n #: module.\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n def __init__(self, digest_method: t.Any = None):\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\\n return mac.digest()\\n\\n\\ndef _make_keys_list(\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n) -> list[bytes]:\\n if isinstance(secret_key, (str, bytes)):\\n return [want_bytes(secret_key)]\\n\\n return [want_bytes(s) for s in secret_key] # pyright: ignore\\n\\n\\nclass Signer:\\n \\\"\\\"\\\"A signer securely signs bytes, then unsigns them to verify that\\n the value hasn't been changed.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param sep: Separator between the signature and value.\\n :param key_derivation: How to derive the signing key from the secret\\n key and salt. Possible values are ``concat``, ``django-concat``,\\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\\n defaults to ``django-concat``.\\n :param digest_method: Hash function to use when generating the HMAC\\n signature. Defaults to :attr:`default_digest_method`, which\\n defaults to :func:`hashlib.sha1`. Note that the security of the\\n hash alone doesn't apply when used intermediately in HMAC.\\n :param algorithm: A :class:`SigningAlgorithm` instance to use\\n instead of building a default :class:`HMACAlgorithm` with the\\n ``digest_method``.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 0.18\\n ``algorithm`` was added as an argument to the class constructor.\\n\\n .. versionchanged:: 0.14\\n ``key_derivation`` and ``digest_method`` were added as arguments\\n to the class constructor.\\n \\\"\\\"\\\"\\n\\n #: The default digest method to use for the signer. The default is\\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\\n #: compatible object. Note that the security of the hash alone\\n #: doesn't apply when used intermediately in HMAC.\\n #:\\n #: .. versionadded:: 0.14\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n #: The default scheme to use to derive the signing key from the\\n #: secret key and salt. The default is ``django-concat``. Possible\\n #: values are ``concat``, ``django-concat``, and ``hmac``.\\n #:\\n #: .. versionadded:: 0.14\\n default_key_derivation: str = \\\"django-concat\\\"\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous.Signer\\\",\\n sep: str | bytes = b\\\".\\\",\\n key_derivation: str | None = None,\\n digest_method: t.Any | None = None,\\n algorithm: SigningAlgorithm | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n self.sep: bytes = want_bytes(sep)\\n\\n if self.sep in _base64_alphabet:\\n raise ValueError(\\n \\\"The given separator cannot be used because it may be\\\"\\n \\\" contained in the signature itself. ASCII letters,\\\"\\n \\\" digits, and '-_=' must not be used.\\\"\\n )\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n else:\\n salt = b\\\"itsdangerous.Signer\\\"\\n\\n self.salt = salt\\n\\n if key_derivation is None:\\n key_derivation = self.default_key_derivation\\n\\n self.key_derivation: str = key_derivation\\n\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n if algorithm is None:\\n algorithm = HMACAlgorithm(self.digest_method)\\n\\n self.algorithm: SigningAlgorithm = algorithm\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\\n \\\"\\\"\\\"This method is called to derive the key. The default key\\n derivation choices can be overridden here. Key derivation is not\\n intended to be used as a security method to make a complex key\\n out of a short password. Instead you should use large random\\n secret keys.\\n\\n :param secret_key: A specific secret key to derive from.\\n Defaults to the last item in :attr:`secret_keys`.\\n\\n .. versionchanged:: 2.0\\n Added the ``secret_key`` parameter.\\n \\\"\\\"\\\"\\n if secret_key is None:\\n secret_key = self.secret_keys[-1]\\n else:\\n secret_key = want_bytes(secret_key)\\n\\n if self.key_derivation == \\\"concat\\\":\\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\\n elif self.key_derivation == \\\"django-concat\\\":\\n return t.cast(\\n bytes, self.digest_method(self.salt + b\\\"signer\\\" + secret_key).digest()\\n )\\n elif self.key_derivation == \\\"hmac\\\":\\n mac = hmac.new(secret_key, digestmod=self.digest_method)\\n mac.update(self.salt)\\n return mac.digest()\\n elif self.key_derivation == \\\"none\\\":\\n return secret_key\\n else:\\n raise TypeError(\\\"Unknown key derivation method\\\")\\n\\n def get_signature(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given value.\\\"\\\"\\\"\\n value = want_bytes(value)\\n key = self.derive_key()\\n sig = self.algorithm.get_signature(key, value)\\n return base64_encode(sig)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string.\\\"\\\"\\\"\\n value = want_bytes(value)\\n return value + self.sep + self.get_signature(value)\\n\\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\\n \\\"\\\"\\\"Verifies the signature for the given value.\\\"\\\"\\\"\\n try:\\n sig = base64_decode(sig)\\n except Exception:\\n return False\\n\\n value = want_bytes(value)\\n\\n for secret_key in reversed(self.secret_keys):\\n key = self.derive_key(secret_key)\\n\\n if self.algorithm.verify_signature(key, value, sig):\\n return True\\n\\n return False\\n\\n def unsign(self, signed_value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Unsigns the given string.\\\"\\\"\\\"\\n signed_value = want_bytes(signed_value)\\n\\n if self.sep not in signed_value:\\n raise BadSignature(f\\\"No {self.sep!r} found in value\\\")\\n\\n value, sig = signed_value.rsplit(self.sep, 1)\\n\\n if self.verify_signature(value, sig):\\n return value\\n\\n raise BadSignature(f\\\"Signature {sig!r} does not match\\\", payload=value)\\n\\n def validate(self, signed_value: str | bytes) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\n \\\"\\\"\\\"\\n try:\\n self.unsign(signed_value)\\n return True\\n except BadSignature:\\n return False\\n\\n[end of src/itsdangerous/signer.py]\",\n \"filename\": \"src/itsdangerous/signer.py\",\n \"id\": \"42\"\n }\n]","isConversational":false}}},{"rowIdx":77,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 77,\n \"num_files\": 43,\n \"repo_id\": \"repo_0077\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerous itself. Use\none of the following resources for questions about using ItsDangerous or\nissues with your own code:\n\n- The ``#get-help`` channel on our Discord chat:\n https://discord.gg/pallets\n- The mailing list flask@python.org for long term discussion or larger\n issues.\n- Ask on `Stack Overflow`_. Search with Google first using:\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\n\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\n\n\nReporting issues\n----------------\n\nInclude the following information in your post:\n\n- Describe what you expected to happen.\n- If possible, include a `minimal reproducible example`_ to help us\n identify the issue. This also helps check that the issue is not with\n your own code.\n- Describe what actually happened. Include the full traceback if there\n was an exception.\n- List your Python and ItsDangerous versions. If possible, check if\n this issue is already fixed in the latest releases or the latest\n code in the repository.\n\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\n\n\nSubmitting patches\n------------------\n\nIf there is not an open issue for what you want to submit, prefer\nopening one for discussion before working on a PR. You can work on any\nissue that doesn't have an open PR linked to it or a maintainer assigned\nto it. These show up in the sidebar. No need to ask if you can work on\nan issue that interests you.\n\nInclude the following in your patch:\n\n- Use `Black`_ to format your code. This and other tools will run\n automatically if you install `pre-commit`_ using the instructions\n below.\n- Include tests if your patch adds or changes code. Make sure the test\n fails without your patch.\n- Update any relevant docs pages and docstrings. Docs pages and\n docstrings should be wrapped at 72 characters.\n- Add an entry in ``CHANGES.rst``. Use the same style as other\n entries. Also include ``.. versionchanged::`` inline changelogs in\n relevant docstrings.\n\n.. _Black: https://black.readthedocs.io\n.. _pre-commit: https://pre-commit.com\n\n\nFirst time setup\n~~~~~~~~~~~~~~~~\n\n- Download and install the `latest version of git`_.\n- Configure git with your `username`_ and `email`_.\n\n .. code-block:: text\n\n $ git config --global user.name 'your name'\n $ git config --global user.email 'your email'\n\n- Make sure you have a `GitHub account`_.\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\n button.\n- `Clone`_ the main repository locally.\n\n .. code-block:: text\n\n $ git clone https://github.com/pallets/itsdangerous\n $ cd itsdangerous\n\n- Add your fork as a remote to push your work to. Replace\n ``{username}`` with your username. This names the remote \"fork\", the\n default Pallets remote is \"origin\".\n\n .. code-block:: text\n\n $ git remote add fork https://github.com/{username}/itsdangerous\n\n- Create a virtualenv.\n\n .. code-block:: text\n\n $ python3 -m venv env\n $ . env/bin/activate\n\n On Windows, activating is different.\n\n .. code-block:: text\n\n > env\\Scripts\\activate\n\n- Install the development dependencies, then install ItsDangerous in\n editable mode.\n\n .. code-block:: text\n\n $ pip install -r requirements/dev.txt && pip install -e .\n\n- Install the pre-commit hooks.\n\n .. code-block:: text\n\n $ pre-commit install\n\n.. _latest version of git: https://git-scm.com/downloads\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\n.. _GitHub account: https://github.com/join\n.. _Fork: https://github.com/pallets/itsdangerous/fork\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\n\n\nStart coding\n~~~~~~~~~~~~\n\n- Create a branch to identify the issue you would like to work on. If\n you're submitting a bug or documentation fix, branch off of the\n latest \".x\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/2.0.x\n\n If you're submitting a feature addition or change, branch off of the\n \"main\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/main\n\n- Using your favorite editor, make your changes,\n `committing as you go`_.\n- Include tests that cover any code changes you make. Make sure the\n test fails without your patch. Run the tests as described below.\n- Push your commits to your fork on GitHub and\n `create a pull request`_. Link to the issue being addressed with\n ``fixes #123`` in the pull request.\n\n .. code-block:: text\n\n $ git push --set-upstream fork your-branch-name\n\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\n\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nRun the basic test suite with pytest.\n\n.. code-block:: text\n\n $ pytest\n\nThis runs the tests for the current environment, which is usually\nsufficient. CI will run the full suite when you submit your pull\nrequest. You can run the full test suite with tox if you don't want to\nwait.\n\n.. code-block:: text\n\n $ tox\n\n\nRunning test coverage\n~~~~~~~~~~~~~~~~~~~~~\n\nGenerating a report of lines that do not have test coverage can indicate\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\ngenerate a report.\n\n.. code-block:: text\n\n $ pip install coverage\n $ coverage run -m pytest\n $ coverage html\n\nOpen ``htmlcov/index.html`` in your browser to explore the report.\n\nRead more about `coverage <https://coverage.readthedocs.io>`__.\n\n\nBuilding the docs\n~~~~~~~~~~~~~~~~~\n\nBuild the docs in the ``docs`` directory using Sphinx.\n\n.. code-block:: text\n\n $ cd docs\n $ make html\n\nOpen ``_build/html/index.html`` in your browser to view the docs.\n\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\n\n[end of CONTRIBUTING.rst]","filename":"CONTRIBUTING.rst","id":"0"},{"content":"repos:\n - repo: https://github.com/astral-sh/ruff-pre-commit\n rev: v0.7.1\n hooks:\n - id: ruff\n - id: ruff-format\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: check-merge-conflict\n - id: debug-statements\n - id: fix-byte-order-marker\n - id: trailing-whitespace\n - id: end-of-file-fixer\n\n[end of .pre-commit-config.yaml]","filename":".pre-commit-config.yaml","id":"1"},{"content":"[project]\nname = \"itsdangerous\"\nversion = \"2.2.0\"\ndescription = \"Safely pass data to untrusted environments and back.\"\nreadme = \"README.md\"\nlicense = { file = \"LICENSE.txt\" }\nmaintainers = [{ name = \"Pallets\", email = \"contact@palletsprojects.com\" }]\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python\",\n \"Typing :: Typed\",\n]\nrequires-python = \">=3.8\"\n\n[project.urls]\nDonate = \"https://palletsprojects.com/donate\"\nDocumentation = \"https://itsdangerous.palletsprojects.com/\"\nChanges = \"https://itsdangerous.palletsprojects.com/changes/\"\nSource = \"https://github.com/pallets/itsdangerous/\"\nChat = \"https://discord.gg/pallets\"\n\n[build-system]\nrequires = [\"flit_core<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.module]\nname = \"itsdangerous\"\n\n[tool.flit.sdist]\ninclude = [\n \"docs/\",\n \"requirements/\",\n \"tests/\",\n \"CHANGES.rst\",\n \"tox.ini\",\n]\nexclude = [\n \"docs/_build/\",\n]\n\n[tool.pytest.ini_options]\ntestpaths = [\"tests\"]\nfilterwarnings = [\n \"error\",\n]\n\n[tool.coverage.run]\nbranch = true\nsource = [\"itsdangerous\", \"tests\"]\n\n[tool.coverage.paths]\nsource = [\"src\", \"*/site-packages\"]\n\n[tool.mypy]\npython_version = \"3.8\"\nfiles = [\"src/itsdangerous\"]\nshow_error_codes = true\npretty = true\nstrict = true\n\n[tool.pyright]\npythonVersion = \"3.8\"\ninclude = [\"src/itsdangerous\"]\ntypeCheckingMode = \"basic\"\n\n[tool.ruff]\nsrc = [\"src\"]\nfix = true\nshow-fixes = true\noutput-format = \"full\"\n\n[tool.ruff.lint]\nselect = [\n \"B\", # flake8-bugbear\n \"E\", # pycodestyle error\n \"F\", # pyflakes\n \"I\", # isort\n \"UP\", # pyupgrade\n \"W\", # pycodestyle warning\n]\n\n[tool.ruff.lint.isort]\nforce-single-line = true\norder-by-type = false\n\n[tool.gha-update]\ntag-only = [\n \"slsa-framework/slsa-github-generator\",\n]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"root = true\n\n[*]\nindent_style = space\nindent_size = 4\ninsert_final_newline = true\ntrim_trailing_whitespace = true\nend_of_line = lf\ncharset = utf-8\nmax_line_length = 88\n\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"3"},{"content":"# ItsDangerous\n\n... so better sign this\n\nVarious helpers to pass data to untrusted environments and to get it\nback safe and sound. Data is cryptographically signed to ensure that a\ntoken has not been tampered with.\n\nIt's possible to customize how data is serialized. Data is compressed as\nneeded. A timestamp can be added and verified automatically while\nloading a token.\n\n\n## A Simple Example\n\nHere's how you could generate a token for transmitting a user's id and\nname between web requests.\n\n```python\nfrom itsdangerous import URLSafeSerializer\nauth_s = URLSafeSerializer(\"secret key\", \"auth\")\ntoken = auth_s.dumps({\"id\": 5, \"name\": \"itsdangerous\"})\n\nprint(token)\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\n\ndata = auth_s.loads(token)\nprint(data[\"name\"])\n# itsdangerous\n```\n\n\n## Donate\n\nThe Pallets organization develops and supports ItsDangerous and other\npopular packages. In order to grow the community of contributors and\nusers, and allow the maintainers to devote more time to the projects,\n[please donate today][].\n\n[please donate today]: https://palletsprojects.com/donate\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"[tox]\nenvlist =\n py3{13,12,11,10,9,8}\n pypy310\n style\n typing\n docs\nskip_missing_interpreters = true\n\n[testenv]\npackage = wheel\nwheel_build_env = .pkg\nconstrain_package_deps = true\nuse_frozen_constraints = true\ndeps = -r requirements/tests.txt\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\n\n[testenv:style]\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit run --all-files\n\n[testenv:typing]\ndeps = -r requirements/typing.txt\ncommands =\n mypy\n pyright\n pyright --verifytypes itsdangerous --ignoreexternal\n\n[testenv:docs]\ndeps = -r requirements/docs.txt\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\n\n[testenv:update-actions]\nlabels = update\ndeps = gha-update\ncommands = gha-update\n\n[testenv:update-pre_commit]\nlabels = update\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit autoupdate -j4\n\n[testenv:update-requirements]\nlabels = update\ndeps = pip-tools\nskip_install = true\nchange_dir = requirements\ncommands =\n pip-compile build.in -q {posargs:-U}\n pip-compile docs.in -q {posargs:-U}\n pip-compile tests.in -q {posargs:-U}\n pip-compile typing.in -q {posargs:-U}\n pip-compile dev.in -q {posargs:-U}\n\n[end of tox.ini]","filename":"tox.ini","id":"5"},{"content":"Copyright 2011 Pallets\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n1. Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n2. 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\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE.txt]","filename":"LICENSE.txt","id":"6"},{"content":"Version 2.2.0\n-------------\n\nReleased 2024-04-16\n\n- Drop support for Python 3.7. :pr:`372`\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\n :pr:`326`\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\n- Deprecate the ``__version__`` attribute. Use feature detection, or\n ``importlib.metadata.version(\"itsdangerous\")``, instead. :issue:`371`\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\n different ``serializer`` argument is given, it will try to infer the return\n type of its ``dumps`` method. :issue:`347`\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\n access it at import time so the developer has time to change the default.\n :issue:`375`\n\n\nVersion 2.1.2\n-------------\n\nReleased 2022-03-24\n\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\n\n\nVersion 2.1.1\n-------------\n\nReleased 2022-03-09\n\n- Handle date overflow in timed unsign. :pr:`296`\n\n\nVersion 2.1.0\n-------------\n\nReleased 2022-02-17\n\n- Drop support for Python 3.6. :pr:`272`\n- Remove previously deprecated code. :pr:`273`\n\n - JWS functionality: Use a dedicated library such as Authlib\n instead.\n - ``import itsdangerous.json``: Import ``json`` from the standard\n library instead.\n\n\nVersion 2.0.1\n-------------\n\nReleased 2021-05-18\n\n- Mark top-level names as exported so type checking understands\n imports in user projects. :pr:`240`\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\n ``None`` again. :issue:`237`\n\n\nVersion 2.0.0\n-------------\n\nReleased 2021-05-11\n\n- Drop support for Python 2 and 3.5.\n- JWS support (``JSONWebSignatureSerializer``,\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\n JWS/JWT library such as authlib instead. :issue:`129`\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\n ``json`` module instead. :pr:`152`\n- Simplejson is no longer used if it is installed. To use a different\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\n- If a signature has an age less than 0, it will raise\n ``SignatureExpired`` rather than appearing valid. This can happen if\n the timestamp offset is changed. :issue:`126`\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\n rather than an ``int`` in some cases. :issue:`124`\n- Added support for key rotation. A list of keys can be passed as\n ``secret_key``, oldest to newest. The newest key is used for\n signing, all keys are tried for unsigning. :pr:`141`\n- Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``. :issue:`155`\n- Add type information for static typing tools. :pr:`186`\n\n\nVersion 1.1.0\n-------------\n\nReleased 2018-10-26\n\n- Change default signing algorithm back to SHA-1. :pr:`113`\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\n release which defaulted to SHA-512. :pr:`114`\n- Add support for fallback algorithms during deserialization to\n support changing the default in the future without breaking existing\n signatures. :pr:`113`\n- Changed capitalization of packages back to lowercase as the change\n in capitalization broke some tooling. :pr:`113`\n\n\nVersion 1.0.0\n-------------\n\nReleased 2018-10-18\n\nYANKED\n\n*Note*: This release was yanked from PyPI because it changed the default\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\nat SHA1.\n\n- Drop support for Python 2.6 and 3.3.\n- Refactor code from a single module to a package. Any object in the\n API docs is still importable from the top-level ``itsdangerous``\n name, but other imports will need to be changed. A future release\n will remove many of these compatibility imports. :pr:`107`\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\n :pr:`27`\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\n Python 3. :issue:`29`\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\n- More compact JSON dumps for unicode strings. :issue:`38`\n- Use the full timestamp rather than an offset, allowing dates before\n 2011. :issue:`46`\n\n To retain compatibility with signers from previous versions,\n consider using `this shim <https://github.com/pallets/itsdangerous\n /issues/120#issuecomment-456913331>`_ when unsigning.\n- Detect a ``sep`` character that may show up in the signature itself\n and raise a ``ValueError``. :issue:`62`\n- Use a consistent signature for keyword arguments for\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\n- Convert JWS exp header to an int when loading. :pr:`99`\n\n\nVersion 0.24\n------------\n\nReleased 2014-03-28\n\n- Added a ``BadHeader`` exception that is used for bad headers that\n replaces the old ``BadPayload`` exception that was reused in those\n cases.\n\n\nVersion 0.23\n------------\n\nReleased 2013-08-08\n\n- Fixed a packaging mistake that caused the tests and license files to\n not be included.\n\n\nVersion 0.22\n------------\n\nReleased 2013-07-03\n\n- Added support for ``TimedJSONWebSignatureSerializer``.\n- Made it possible to override the signature verification function to\n allow implementing asymmetrical algorithms.\n\n\nVersion 0.21\n------------\n\nReleased 2013-05-26\n\n- Fixed an issue on Python 3 which caused invalid errors to be\n generated.\n\n\nVersion 0.20\n------------\n\nReleased 2013-05-23\n\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\n ItsDangerous on Python 2.6.\n\n\nVersion 0.19\n------------\n\nReleased 2013-05-21\n\n- Dropped support for 2.5 and added support for 3.3.\n\n\nVersion 0.18\n------------\n\nReleased 2013-05-03\n\n- Added support for JSON Web Signatures (JWS).\n\n\nVersion 0.17\n------------\n\nReleased 2012-08-10\n\n- Fixed a name error when overriding the digest method.\n\n\nVersion 0.16\n------------\n\nReleased 2012-07-11\n\n- Made it possible to pass unicode values to ``load_payload`` to make\n it easier to debug certain things.\n\n\nVersion 0.15\n------------\n\nReleased 2012-07-11\n\n- Made standalone ``load_payload`` more robust by raising one specific\n error if something goes wrong.\n- Refactored exceptions to catch more cases individually, added more\n attributes.\n- Fixed an issue that caused ``load_payload`` not work in some\n situations with timestamp based serializers\n- Added an ``loads_unsafe`` method.\n\n\nVersion 0.14\n------------\n\nReleased 2012-06-29\n\n- API refactoring to support different key derivations.\n- Added attributes to exceptions so that you can inspect the data even\n if the signature check failed.\n\n\nVersion 0.13\n------------\n\nReleased 2012-06-10\n\n- Small API change that enables customization of the digest module.\n\n\nVersion 0.12\n------------\n\nReleased 2012-02-22\n\n- Fixed a problem with the local timezone being used for the epoch\n calculation. This might invalidate some of your signatures if you\n were not running in UTC timezone. You can revert to the old behavior\n by monkey patching ``itsdangerous.EPOCH``.\n\n\nVersion 0.11\n------------\n\nReleased 2011-07-07\n\n- Fixed an uncaught value error.\n\n\nVersion 0.10\n------------\n\nReleased 2011-06-25\n\n- Refactored interface that the underlying serializers can be swapped\n by passing in a module instead of having to override the payload\n loaders and dumpers. This makes the interface more compatible with\n Django's recent changes.\n\n[end of CHANGES.rst]","filename":"CHANGES.rst","id":"7"},{"content":"version: 2\nbuild:\n os: ubuntu-22.04\n tools:\n python: '3.12'\npython:\n install:\n - requirements: requirements/docs.txt\n - method: pip\n path: .\nsphinx:\n builder: dirhtml\n fail_on_warning: true\n\n[end of .readthedocs.yaml]","filename":".readthedocs.yaml","id":"8"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile dev.in\n#\nalabaster==1.0.0\n # via\n # -r docs.txt\n # sphinx\nbabel==2.16.0\n # via\n # -r docs.txt\n # sphinx\ncachetools==5.5.0\n # via tox\ncertifi==2024.8.30\n # via\n # -r docs.txt\n # requests\ncfgv==3.4.0\n # via pre-commit\nchardet==5.2.0\n # via tox\ncharset-normalizer==3.4.0\n # via\n # -r docs.txt\n # requests\ncolorama==0.4.6\n # via tox\ndistlib==0.3.9\n # via virtualenv\ndocutils==0.21.2\n # via\n # -r docs.txt\n # sphinx\nfilelock==3.16.1\n # via\n # tox\n # virtualenv\nfreezegun==1.5.1\n # via -r tests.txt\nidentify==2.6.1\n # via pre-commit\nidna==3.10\n # via\n # -r docs.txt\n # requests\nimagesize==1.4.1\n # via\n # -r docs.txt\n # sphinx\niniconfig==2.0.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\njinja2==3.1.4\n # via\n # -r docs.txt\n # sphinx\nmarkupsafe==3.0.2\n # via\n # -r docs.txt\n # jinja2\nmypy==1.13.0\n # via -r typing.txt\nmypy-extensions==1.0.0\n # via\n # -r typing.txt\n # mypy\nnodeenv==1.9.1\n # via\n # -r typing.txt\n # pre-commit\n # pyright\npackaging==24.1\n # via\n # -r docs.txt\n # -r tests.txt\n # -r typing.txt\n # pallets-sphinx-themes\n # pyproject-api\n # pytest\n # sphinx\n # tox\npallets-sphinx-themes==2.3.0\n # via -r docs.txt\nplatformdirs==4.3.6\n # via\n # tox\n # virtualenv\npluggy==1.5.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\n # tox\npre-commit==4.0.1\n # via -r dev.in\npygments==2.18.0\n # via\n # -r docs.txt\n # sphinx\npyproject-api==1.8.0\n # via tox\npyright==1.1.386\n # via -r typing.txt\npytest==8.3.3\n # via\n # -r tests.txt\n # -r typing.txt\npython-dateutil==2.9.0.post0\n # via\n # -r tests.txt\n # freezegun\npyyaml==6.0.2\n # via pre-commit\nrequests==2.32.3\n # via\n # -r docs.txt\n # sphinx\nsix==1.16.0\n # via\n # -r tests.txt\n # python-dateutil\nsnowballstemmer==2.2.0\n # via\n # -r docs.txt\n # sphinx\nsphinx==8.1.3\n # via\n # -r docs.txt\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via\n # -r docs.txt\n # pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-devhelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-jsmath==1.0.1\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.txt\nsphinxcontrib-qthelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via\n # -r docs.txt\n # sphinx\ntox==4.23.2\n # via -r dev.in\ntyping-extensions==4.12.2\n # via\n # -r typing.txt\n # mypy\n # pyright\nurllib3==2.2.3\n # via\n # -r docs.txt\n # requests\nvirtualenv==20.27.0\n # via\n # pre-commit\n # tox\n\n[end of requirements/dev.txt]","filename":"requirements/dev.txt","id":"9"},{"content":"pallets-sphinx-themes\nsphinx\nsphinxcontrib-log-cabinet\n\n[end of requirements/docs.in]","filename":"requirements/docs.in","id":"10"},{"content":"build\n\n[end of requirements/build.in]","filename":"requirements/build.in","id":"11"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile typing.in\n#\niniconfig==2.0.0\n # via pytest\nmypy==1.13.0\n # via -r typing.in\nmypy-extensions==1.0.0\n # via mypy\nnodeenv==1.9.1\n # via pyright\npackaging==24.1\n # via pytest\npluggy==1.5.0\n # via pytest\npyright==1.1.386\n # via -r typing.in\npytest==8.3.3\n # via -r typing.in\ntyping-extensions==4.12.2\n # via\n # mypy\n # pyright\n\n[end of requirements/typing.txt]","filename":"requirements/typing.txt","id":"12"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile build.in\n#\nbuild==1.2.2.post1\n # via -r build.in\npackaging==24.1\n # via build\npyproject-hooks==1.2.0\n # via build\n\n[end of requirements/build.txt]","filename":"requirements/build.txt","id":"13"},{"content":"mypy\npyright\npytest\n\n[end of requirements/typing.in]","filename":"requirements/typing.in","id":"14"},{"content":"-r docs.txt\n-r tests.txt\n-r typing.txt\npre-commit\ntox\n\n[end of requirements/dev.in]","filename":"requirements/dev.in","id":"15"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile docs.in\n#\nalabaster==1.0.0\n # via sphinx\nbabel==2.16.0\n # via sphinx\ncertifi==2024.8.30\n # via requests\ncharset-normalizer==3.4.0\n # via requests\ndocutils==0.21.2\n # via sphinx\nidna==3.10\n # via requests\nimagesize==1.4.1\n # via sphinx\njinja2==3.1.4\n # via sphinx\nmarkupsafe==3.0.2\n # via jinja2\npackaging==24.1\n # via\n # pallets-sphinx-themes\n # sphinx\npallets-sphinx-themes==2.3.0\n # via -r docs.in\npygments==2.18.0\n # via sphinx\nrequests==2.32.3\n # via sphinx\nsnowballstemmer==2.2.0\n # via sphinx\nsphinx==8.1.3\n # via\n # -r docs.in\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via sphinx\nsphinxcontrib-devhelp==2.0.0\n # via sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via sphinx\nsphinxcontrib-jsmath==1.0.1\n # via sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.in\nsphinxcontrib-qthelp==2.0.0\n # via sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via sphinx\nurllib3==2.2.3\n # via requests\n\n[end of requirements/docs.txt]","filename":"requirements/docs.txt","id":"16"},{"content":".. rst-class:: hide-header\n\nItsDangerous\n============\n\n.. image:: _static/itsdangerous-logo.png\n :align: center\n :target: https://palletsprojects.com/p/itsdangerous/\n\nSometimes you want to send some data to untrusted environments, then get\nit back later. To do this safely, the data must be signed to detect\nchanges.\n\nGiven a key only you know, you can cryptographically sign your data and\nhand it over to someone else. When you get the data back you can ensure\nthat nobody tampered with it.\n\nThe receiver can see the data, but they can not modify it unless they\nalso have your key. So if you keep the key secret and complex, you will\nbe fine.\n\n\nInstalling\n----------\n\nInstall and update using `pip`_:\n\n.. code-block:: text\n\n pip install -U itsdangerous\n\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\n\n\nExample Use Cases\n-----------------\n\n- Sign a user ID in a URL and email it to them to unsubscribe from a\n newsletter. This way you don't need to generate one-time tokens and\n store them in the database. Same thing with any kind of activation\n link for accounts and similar things.\n- Signed objects can be stored in cookies or other untrusted sources\n which means you don't need to have sessions stored on the server,\n which reduces the number of necessary database queries.\n- Signed information can safely do a round trip between server and\n client in general which makes them useful for passing server-side\n state to a client and then back.\n\n\nTable of Contents\n-----------------\n\n.. toctree::\n\n concepts\n serializer\n signer\n exceptions\n timed\n url_safe\n encoding\n license\n changes\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"17"},{"content":".. module:: itsdangerous.serializer\n\nSerialization Interface\n=======================\n\nThe :doc:`/signer` only signs bytes. To sign other types, the\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\nsimilar to Python's :mod:`json` module, which serializes the object to a\nstring then signs that.\n\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n s = Serializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\n\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\nthe data.\n\n.. code-block:: python\n\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\n [1, 2, 3, 4]\n\nBy default, data is serialized to JSON with the built-in :mod:`json`\nmodule. This internal serializer can be changed by subclassing.\n\nTo record and validate the age of the signature, see :doc:`/timed`.\nTo serialize to a format that is safe to use in URLs, see\n:doc:`/url_safe`.\n\n\nResponding to Failure\n---------------------\n\nExceptions have helpful attributes which allow you to inspect the\npayload if the signature check failed. This has to be done with extra\ncare because at that point you know that someone tampered with your data\nbut it might be useful for debugging purposes.\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n from itsdangerous.exc import BadSignature, BadData\n\n s = URLSafeSerializer(\"secret-key\")\n decoded_payload = None\n\n try:\n decoded_payload = s.loads(data)\n # This payload is decoded and safe\n except BadSignature as e:\n if e.payload is not None:\n try:\n decoded_payload = s.load_payload(e.payload)\n except BadData:\n pass\n # This payload is decoded but unsafe because someone\n # tampered with the signature. The decode (load_payload)\n # step is explicit because it might be unsafe to unserialize\n # the payload (think pickle instead of json!)\n\nIf you don't want to inspect attributes to figure out what exactly went\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\n\n.. code-block:: python\n\n sig_okay, payload = s.loads_unsafe(data)\n\nThe first item in the returned tuple is a boolean that indicates if the\nsignature was correct.\n\n\nFallback Signers\n----------------\n\nYou may want to upgrade the signing parameters without invalidating\nexisting signatures immediately. For example, you may decide that you\nwant to use a different digest method. New signatures should use the new\nmethod, but old signatures should still validate.\n\nA list of ``fallback_signers`` can be given that will be tried if\nunsigning with the current signer fails. Each item in the list can be:\n\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\n passed to the serializer.\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\n serializer.\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\n given class with the given args.\n\nFor example, this is a serializer that signs using SHA-512, but will\nunsign using either SHA-512 or SHA-1:\n\n.. code-block:: python\n\n s = Serializer(\n signer_kwargs={\"digest_method\": hashlib.sha512},\n fallback_signers=[{\"digest_method\": hashlib.sha1}]\n )\n\n\n\nAPI\n---\n\n.. autoclass:: Serializer\n :members:\n\n[end of docs/serializer.rst]","filename":"docs/serializer.rst","id":"18"},{"content":".. module:: itsdangerous.signer\n\nSigning Interface\n=================\n\nThe most basic interface is the signing interface. The :class:`Signer`\nclass can be used to attach a signature to a specific string:\n\n.. code-block:: python\n\n from itsdangerous import Signer\n s = Signer(\"secret-key\")\n s.sign(\"my string\")\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\n\nThe signature is appended to the string, separated by a dot. To validate\nthe string, use the :meth:`~Signer.unsign` method:\n\n.. code-block:: python\n\n s.unsign(b\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n b'my string'\n\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\nHowever after unsigning you won't be able to tell if it was unicode or\na bytestring.\n\nIf the value is changed, the signature will no longer match, and\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\n\n.. code-block:: python\n\n s.unsign(b\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nTo record and validate the age of a signature, see :doc:`/timed`.\n\n.. autoclass:: Signer\n :members:\n\n\nSigning Algorithms\n------------------\n\n.. autoclass:: NoneAlgorithm\n\n.. autoclass:: HMACAlgorithm\n\n[end of docs/signer.rst]","filename":"docs/signer.rst","id":"19"},{"content":"General Concepts\n================\n\n\nSerializer vs Signer\n--------------------\n\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\nthe basic system that signs a given ``bytes`` value based on the given\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\nserializing and signing other data besides ``bytes``.\n\nTypically, you'll want to use a serializer, not a signer. You can\nconfigure the signing parameters through the serializer, and even\nprovide fallback signers to upgrade old tokens to new parameters.\n\n\nThe Secret Key\n--------------\n\nSignatures are secured by the ``secret_key``. Typically one secret key\nis used with all signers, and the salt is used to distinguish different\ncontexts. Changing the secret key will invalidate existing tokens.\n\nIt should be a long random string of bytes. This value must be kept\nsecret and should not be saved in source code or committed to version\ncontrol. If an attacker learns the secret key, they can change and\nresign data to look valid. If you suspect this happened, change the\nsecret key to invalidate existing tokens.\n\nOne way to keep the secret key separate is to read it from an\nenvironment variable. When deploying for the first time, generate a key\nand set the environment variable when running the application. All\nprocess managers (like systemd) and hosting services have a way to\nspecify environment variables.\n\n.. code-block:: python\n\n import os\n from itsdangerous.serializer import Serializer\n SECRET_KEY = os.environ.get(\"SECRET_KEY\")\n s = Serializer(SECRET_KEY)\n\n.. code-block:: text\n\n $ export SECRET_KEY=\"base64 encoded random bytes\"\n $ python application.py\n\nOne way to generate a key is to use :func:`os.urandom`.\n\n.. code-block:: text\n\n $ python3 -c 'import os; print(os.urandom(16).hex())'\n\n\nThe Salt\n--------\n\nThe salt is combined with the secret key to derive a unique key for\ndistinguishing different contexts. Unlike the secret key, the salt\ndoesn't have to be random, and can be saved in code. It only has to be\nunique between contexts, not private.\n\nFor example, you want to email activation links to activate user\naccounts, and upgrade links to upgrade users to a paid accounts. If all\nyou sign is the user id, and you don't use different salts, a user could\nreuse the token from the activation link to upgrade the account. If you\nuse different salts, the signatures will be different and will not be\nvalid in the other context.\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n\n s1 = URLSafeSerializer(\"secret-key\", salt=\"activate\")\n s1.dumps(42)\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\n\n s2 = URLSafeSerializer(\"secret-key\", salt=\"upgrade\")\n s2.dumps(42)\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\n\nThe second serializer can't load data dumped with the first because the\nsalts differ.\n\n.. code-block:: python\n\n s2.loads(s1.dumps(42))\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nOnly the serializer with the same salt can load the data.\n\n.. code-block:: python\n\n s2.loads(s2.dumps(42))\n 42\n\n\nKey Rotation\n------------\n\nKey rotation can provide an extra layer of mitigation against an\nattacker discovering a secret key. A rotation system will keep a list of\nvalid keys, generating a new key and removing the oldest key\nperiodically. If it takes four weeks for an attacker to crack a key, but\nthe key is rotated out after three weeks, they will not be able to use\nany keys they crack. However, if a user doesn't refresh their token\nwithin three weeks it will be invalid too.\n\nThe system that generates and maintains this list is outside the scope\nof ItsDangerous, but ItsDangerous does support validating against a list\nof keys.\n\nInstead of passing a single key, you can pass a list of keys, oldest to\nnewest. When signing the last (newest) key will be used, and when\nvalidating each key will be tried from newest to oldest before raising\na validation error.\n\n.. code-block:: python\n\n SECRET_KEYS = [\"2b9cd98e\", \"169d7886\", \"b6af09f5\"]\n\n # sign some data with the latest key\n s = Serializer(SECRET_KEYS)\n t = s.dumps({\"id\": 42})\n\n # rotate a new key in and the oldest key out\n SECRET_KEYS.append(\"cf9b3588\")\n del SECRET_KEYS[0]\n\n s = Serializer(SECRET_KEYS)\n s.loads(t) # valid even though it was signed with a previous key\n\n\nDigest Method Security\n----------------------\n\nA signer is configured with a ``digest_method``, a hash function that\nis used as an intermediate step when generating the HMAC signature. The\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\nconcerned about this default because they have heard about hash\ncollisions with SHA-1.\n\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\nhash alone doesn't apply when used in HMAC.\n\nIf a project considers SHA-1 a risk anyway, they can configure the\nsigner with a different digest method such as :func:`hashlib.sha512`.\nA fallback signer for SHA-1 can be configured so that old tokens will be\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\nspace, which is relevant in cookies and URLs.\n\n[end of docs/concepts.rst]","filename":"docs/concepts.rst","id":"20"},{"content":".. module:: itsdangerous.url_safe\n\nURL Safe Serialization\n======================\n\nOften it is helpful if you can pass these trusted strings in places\nwhere you only have a limited set of characters available. Because of\nthis, ItsDangerous also provides URL safe serializers:\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n s = URLSafeSerializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\n s.loads(\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\")\n [1, 2, 3, 4]\n\n.. autoclass:: URLSafeSerializer\n\n.. autoclass:: URLSafeTimedSerializer\n\n[end of docs/url_safe.rst]","filename":"docs/url_safe.rst","id":"21"},{"content":".. module:: itsdangerous.encoding\n\nEncoding Utilities\n==================\n\n.. autofunction:: base64_encode\n\n.. autofunction:: base64_decode\n\n[end of docs/encoding.rst]","filename":"docs/encoding.rst","id":"22"},{"content":"# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSOURCEDIR = .\nBUILDDIR = _build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"23"},{"content":"from pallets_sphinx_themes import get_version\nfrom pallets_sphinx_themes import ProjectLink\n\n# Project --------------------------------------------------------------\n\nproject = \"ItsDangerous\"\ncopyright = \"2011 Pallets\"\nauthor = \"Pallets\"\nrelease, version = get_version(\"itsdangerous\")\n\n# General --------------------------------------------------------------\n\ndefault_role = \"code\"\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.extlinks\",\n \"sphinx.ext.intersphinx\",\n \"sphinxcontrib.log_cabinet\",\n \"pallets_sphinx_themes\",\n]\nautoclass_content = \"both\"\nautodoc_member_order = \"bysource\"\nautodoc_typehints = \"description\"\nautodoc_preserve_defaults = True\nextlinks = {\n \"issue\": (\"https://github.com/pallets/itsdangerous/issues/%s\", \"#%s\"),\n \"pr\": (\"https://github.com/pallets/itsdangerous/pull/%s\", \"#%s\"),\n}\nintersphinx_mapping = {\n \"python\": (\"https://docs.python.org/3/\", None),\n}\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = \"flask\"\nhtml_theme_options = {\"index_sidebar_logo\": False}\nhtml_context = {\n \"project_links\": [\n ProjectLink(\"Donate\", \"https://palletsprojects.com/donate\"),\n ProjectLink(\"PyPI Releases\", \"https://pypi.org/project/itsdangerous/\"),\n ProjectLink(\"Source Code\", \"https://github.com/pallets/itsdangerous/\"),\n ProjectLink(\"Issue Tracker\", \"https://github.com/pallets/itsdangerous/issues/\"),\n ProjectLink(\"Chat\", \"https://discord.gg/pallets\"),\n ]\n}\nhtml_sidebars = {\n \"index\": [\"project.html\", \"localtoc.html\", \"searchbox.html\", \"ethicalads.html\"],\n \"**\": [\"localtoc.html\", \"relations.html\", \"searchbox.html\", \"ethicalads.html\"],\n}\nsinglehtml_sidebars = {\"index\": [\"project.html\", \"localtoc.html\", \"ethicalads.html\"]}\nhtml_static_path = [\"_static\"]\nhtml_favicon = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_logo = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_title = f\"{project} Documentation ({version})\"\nhtml_show_sourcelink = False\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"24"},{"content":"@ECHO OFF\n\npushd %~dp0\n\nREM Command file for Sphinx documentation\n\nif \"%SPHINXBUILD%\" == \"\" (\n\tset SPHINXBUILD=sphinx-build\n)\nset SOURCEDIR=.\nset BUILDDIR=_build\n\nif \"%1\" == \"\" goto help\n\n%SPHINXBUILD% >NUL 2>NUL\nif errorlevel 9009 (\n\techo.\n\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\n\techo.installed, then set the SPHINXBUILD environment variable to point\n\techo.to the full path of the 'sphinx-build' executable. Alternatively you\n\techo.may add the Sphinx directory to PATH.\n\techo.\n\techo.If you don't have Sphinx installed, grab it from\n\techo.http://sphinx-doc.org/\n\texit /b 1\n)\n\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\ngoto end\n\n:help\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\n\n:end\npopd\n\n[end of docs/make.bat]","filename":"docs/make.bat","id":"25"},{"content":".. module:: itsdangerous.timed\n\nSigning With Timestamps\n=======================\n\nIf you want to expire signatures you can use the\n:class:`TimestampSigner` class which adds timestamp information and\nsigns it. On unsigning you can validate that the timestamp is not older\nthan a given age.\n\n.. code-block:: python\n\n from itsdangerous import TimestampSigner\n s = TimestampSigner('secret-key')\n string = s.sign('foo')\n\n.. code-block:: python\n\n s.unsign(string, max_age=5)\n Traceback (most recent call last):\n ...\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\n\n.. autoclass:: TimestampSigner\n :members:\n\n.. autoclass:: TimedSerializer\n :members:\n\n[end of docs/timed.rst]","filename":"docs/timed.rst","id":"26"},{"content":"BSD-3-Clause License\n====================\n\n.. literalinclude:: ../LICENSE.txt\n :language: text\n\n[end of docs/license.rst]","filename":"docs/license.rst","id":"27"},{"content":"Changes\n=======\n\n.. include:: ../CHANGES.rst\n\n[end of docs/changes.rst]","filename":"docs/changes.rst","id":"28"},{"content":".. module:: itsdangerous.exc\n\nExceptions\n==========\n\n.. autoexception:: BadData\n :members:\n\n.. autoexception:: BadSignature\n :members:\n\n.. autoexception:: BadTimeSignature\n :members:\n\n.. autoexception:: SignatureExpired\n :members:\n\n.. autoexception:: BadHeader\n :members:\n\n.. autoexception:: BadPayload\n :members:\n\n[end of docs/exceptions.rst]","filename":"docs/exceptions.rst","id":"29"},{"content":"#!/bin/bash\nset -e\npython3 -m venv --upgrade-deps .venv\n. .venv/bin/activate\npip install -r requirements/dev.txt\npip install -e .\npre-commit install --install-hooks\n\n[end of .devcontainer/on-create-command.sh]","filename":".devcontainer/on-create-command.sh","id":"30"},{"content":"{\n \"name\": \"pallets/itsdangerous\",\n \"image\": \"mcr.microsoft.com/devcontainers/python:3\",\n \"customizations\": {\n \"vscode\": {\n \"settings\": {\n \"python.defaultInterpreterPath\": \"${workspaceFolder}/.venv\",\n \"python.terminal.activateEnvInCurrentTerminal\": true,\n \"python.terminal.launchArgs\": [\n \"-X\",\n \"dev\"\n ]\n }\n }\n },\n \"onCreateCommand\": \".devcontainer/on-create-command.sh\"\n}\n\n[end of .devcontainer/devcontainer.json]","filename":".devcontainer/devcontainer.json","id":"31"},{"content":"None\n[end of docs/_static/itsdangerous-logo-sidebar.png]","filename":"docs/_static/itsdangerous-logo-sidebar.png","id":"32"},{"content":"None\n[end of docs/_static/itsdangerous-logo.png]","filename":"docs/_static/itsdangerous-logo.png","id":"33"},{"content":"from __future__ import annotations\n\nimport json as _json\nimport typing as t\n\n\nclass _CompactJSON:\n \"\"\"Wrapper around json module that strips whitespace.\"\"\"\n\n @staticmethod\n def loads(payload: str | bytes) -> t.Any:\n return _json.loads(payload)\n\n @staticmethod\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\n kwargs.setdefault(\"ensure_ascii\", False)\n kwargs.setdefault(\"separators\", (\",\", \":\"))\n return _json.dumps(obj, **kwargs)\n\n[end of src/itsdangerous/_json.py]","filename":"src/itsdangerous/_json.py","id":"34"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport time\nimport typing as t\nfrom datetime import datetime\nfrom datetime import timezone\n\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import bytes_to_int\nfrom .encoding import int_to_bytes\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\nfrom .exc import BadTimeSignature\nfrom .exc import SignatureExpired\nfrom .serializer import _TSerialized\nfrom .serializer import Serializer\nfrom .signer import Signer\n\n\nclass TimestampSigner(Signer):\n \"\"\"Works like the regular :class:`.Signer` but also records the time\n of the signing and can be used to expire signatures. The\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\n unsigning failed because the signature is expired.\n \"\"\"\n\n def get_timestamp(self) -> int:\n \"\"\"Returns the current timestamp. The function must return an\n integer.\n \"\"\"\n return int(time.time())\n\n def timestamp_to_datetime(self, ts: int) -> datetime:\n \"\"\"Convert the timestamp from :meth:`get_timestamp` into an\n aware :class`datetime.datetime` in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n return datetime.fromtimestamp(ts, tz=timezone.utc)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string and also attaches time information.\"\"\"\n value = want_bytes(value)\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\n sep = want_bytes(self.sep)\n value = value + sep + timestamp\n return value + sep + self.get_signature(value)\n\n # Ignore overlapping signatures check, return_timestamp is the only\n # parameter that affects the return type.\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[False] = False,\n ) -> bytes: ...\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[True] = True,\n ) -> tuple[bytes, datetime]: ...\n\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n ) -> tuple[bytes, datetime] | bytes:\n \"\"\"Works like the regular :meth:`.Signer.unsign` but can also\n validate the time. See the base docstring of the class for\n the general behavior. If ``return_timestamp`` is ``True`` the\n timestamp of the signature will be returned as an aware\n :class:`datetime.datetime` object in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n try:\n result = super().unsign(signed_value)\n sig_error = None\n except BadSignature as e:\n sig_error = e\n result = e.payload or b\"\"\n\n sep = want_bytes(self.sep)\n\n # If there is no timestamp in the result there is something\n # seriously wrong. In case there was a signature error, we raise\n # that one directly, otherwise we have a weird situation in\n # which we shouldn't have come except someone uses a time-based\n # serializer on non-timestamp data, so catch that.\n if sep not in result:\n if sig_error:\n raise sig_error\n\n raise BadTimeSignature(\"timestamp missing\", payload=result)\n\n value, ts_bytes = result.rsplit(sep, 1)\n ts_int: int | None = None\n ts_dt: datetime | None = None\n\n try:\n ts_int = bytes_to_int(base64_decode(ts_bytes))\n except Exception:\n pass\n\n # Signature is *not* okay. Raise a proper error now that we have\n # split the value and the timestamp.\n if sig_error is not None:\n if ts_int is not None:\n try:\n ts_dt = self.timestamp_to_datetime(ts_int)\n except (ValueError, OSError, OverflowError) as exc:\n # Windows raises OSError\n # 32-bit raises OverflowError\n raise BadTimeSignature(\n \"Malformed timestamp\", payload=value\n ) from exc\n\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\n\n # Signature was okay but the timestamp is actually not there or\n # malformed. Should not happen, but we handle it anyway.\n if ts_int is None:\n raise BadTimeSignature(\"Malformed timestamp\", payload=value)\n\n # Check timestamp is not older than max_age\n if max_age is not None:\n age = self.get_timestamp() - ts_int\n\n if age > max_age:\n raise SignatureExpired(\n f\"Signature age {age} > {max_age} seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if age < 0:\n raise SignatureExpired(\n f\"Signature age {age} < 0 seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if return_timestamp:\n return value, self.timestamp_to_datetime(ts_int)\n\n return value\n\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\"\"\"\n try:\n self.unsign(signed_value, max_age=max_age)\n return True\n except BadSignature:\n return False\n\n\nclass TimedSerializer(Serializer[_TSerialized]):\n \"\"\"Uses :class:`TimestampSigner` instead of the default\n :class:`.Signer`.\n \"\"\"\n\n default_signer: type[TimestampSigner] = TimestampSigner\n\n def iter_unsigners(\n self, salt: str | bytes | None = None\n ) -> cabc.Iterator[TimestampSigner]:\n return t.cast(\"cabc.Iterator[TimestampSigner]\", super().iter_unsigners(salt))\n\n # TODO: Signature is incompatible because parameters were added\n # before salt.\n\n def loads( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n salt: str | bytes | None = None,\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\n signature validation fails. If a ``max_age`` is provided it will\n ensure the signature is not older than that time in seconds. In\n case the signature is outdated, :exc:`.SignatureExpired` is\n raised. All arguments are forwarded to the signer's\n :meth:`~TimestampSigner.unsign` method.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n base64d, timestamp = signer.unsign(\n s, max_age=max_age, return_timestamp=True\n )\n payload = self.load_payload(base64d)\n\n if return_timestamp:\n return payload, timestamp\n\n return payload\n except SignatureExpired:\n # The signature was unsigned successfully but was\n # expired. Do not try the next signer.\n raise\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def loads_unsafe( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n salt: str | bytes | None = None,\n ) -> tuple[bool, t.Any]:\n return self._loads_unsafe_impl(s, salt, load_kwargs={\"max_age\": max_age})\n\n[end of src/itsdangerous/timed.py]","filename":"src/itsdangerous/timed.py","id":"35"},{"content":"from __future__ import annotations\n\nimport base64\nimport string\nimport struct\nimport typing as t\n\nfrom .exc import BadData\n\n\ndef want_bytes(\n s: str | bytes, encoding: str = \"utf-8\", errors: str = \"strict\"\n) -> bytes:\n if isinstance(s, str):\n s = s.encode(encoding, errors)\n\n return s\n\n\ndef base64_encode(string: str | bytes) -> bytes:\n \"\"\"Base64 encode a string of bytes or text. The resulting bytes are\n safe to use in URLs.\n \"\"\"\n string = want_bytes(string)\n return base64.urlsafe_b64encode(string).rstrip(b\"=\")\n\n\ndef base64_decode(string: str | bytes) -> bytes:\n \"\"\"Base64 decode a URL-safe string of bytes or text. The result is\n bytes.\n \"\"\"\n string = want_bytes(string, encoding=\"ascii\", errors=\"ignore\")\n string += b\"=\" * (-len(string) % 4)\n\n try:\n return base64.urlsafe_b64decode(string)\n except (TypeError, ValueError) as e:\n raise BadData(\"Invalid base64-encoded data\") from e\n\n\n# The alphabet used by base64.urlsafe_*\n_base64_alphabet = f\"{string.ascii_letters}{string.digits}-_=\".encode(\"ascii\")\n\n_int64_struct = struct.Struct(\">Q\")\n_int_to_bytes = _int64_struct.pack\n_bytes_to_int = t.cast(\"t.Callable[[bytes], tuple[int]]\", _int64_struct.unpack)\n\n\ndef int_to_bytes(num: int) -> bytes:\n return _int_to_bytes(num).lstrip(b\"\\x00\")\n\n\ndef bytes_to_int(bytestr: bytes) -> int:\n return _bytes_to_int(bytestr.rjust(8, b\"\\x00\"))[0]\n\n[end of src/itsdangerous/encoding.py]","filename":"src/itsdangerous/encoding.py","id":"36"},{"content":"from __future__ import annotations\n\nimport typing as t\n\nfrom .encoding import base64_decode as base64_decode\nfrom .encoding import base64_encode as base64_encode\nfrom .encoding import want_bytes as want_bytes\nfrom .exc import BadData as BadData\nfrom .exc import BadHeader as BadHeader\nfrom .exc import BadPayload as BadPayload\nfrom .exc import BadSignature as BadSignature\nfrom .exc import BadTimeSignature as BadTimeSignature\nfrom .exc import SignatureExpired as SignatureExpired\nfrom .serializer import Serializer as Serializer\nfrom .signer import HMACAlgorithm as HMACAlgorithm\nfrom .signer import NoneAlgorithm as NoneAlgorithm\nfrom .signer import Signer as Signer\nfrom .timed import TimedSerializer as TimedSerializer\nfrom .timed import TimestampSigner as TimestampSigner\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\n\n\ndef __getattr__(name: str) -> t.Any:\n if name == \"__version__\":\n import importlib.metadata\n import warnings\n\n warnings.warn(\n \"The '__version__' attribute is deprecated and will be removed in\"\n \" ItsDangerous 2.3. Use feature detection or\"\n \" 'importlib.metadata.version(\\\"itsdangerous\\\")' instead.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return importlib.metadata.version(\"itsdangerous\")\n\n raise AttributeError(name)\n\n[end of src/itsdangerous/__init__.py]","filename":"src/itsdangerous/__init__.py","id":"37"},{"content":"from __future__ import annotations\n\nimport typing as t\nimport zlib\n\nfrom ._json import _CompactJSON\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .exc import BadPayload\nfrom .serializer import _PDataSerializer\nfrom .serializer import Serializer\nfrom .timed import TimedSerializer\n\n\nclass URLSafeSerializerMixin(Serializer[str]):\n \"\"\"Mixed in with a regular serializer it will attempt to zlib\n compress the string to make it shorter if necessary. It will also\n base64 encode the string so that it can safely be placed in a URL.\n \"\"\"\n\n default_serializer: _PDataSerializer[str] = _CompactJSON\n\n def load_payload(\n self,\n payload: bytes,\n *args: t.Any,\n serializer: t.Any | None = None,\n **kwargs: t.Any,\n ) -> t.Any:\n decompress = False\n\n if payload.startswith(b\".\"):\n payload = payload[1:]\n decompress = True\n\n try:\n json = base64_decode(payload)\n except Exception as e:\n raise BadPayload(\n \"Could not base64 decode the payload because of an exception\",\n original_error=e,\n ) from e\n\n if decompress:\n try:\n json = zlib.decompress(json)\n except Exception as e:\n raise BadPayload(\n \"Could not zlib decompress the payload before decoding the payload\",\n original_error=e,\n ) from e\n\n return super().load_payload(json, *args, **kwargs)\n\n def dump_payload(self, obj: t.Any) -> bytes:\n json = super().dump_payload(obj)\n is_compressed = False\n compressed = zlib.compress(json)\n\n if len(compressed) < (len(json) - 1):\n json = compressed\n is_compressed = True\n\n base64d = base64_encode(json)\n\n if is_compressed:\n base64d = b\".\" + base64d\n\n return base64d\n\n\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\n \"\"\"Works like :class:`.Serializer` but dumps and loads into a URL\n safe string consisting of the upper and lowercase character of the\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\n \"\"\"Works like :class:`.TimedSerializer` but dumps and loads into a\n URL safe string consisting of the upper and lowercase character of\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n[end of src/itsdangerous/url_safe.py]","filename":"src/itsdangerous/url_safe.py","id":"38"},{"content":"from __future__ import annotations\n\nimport typing as t\nfrom datetime import datetime\n\n\nclass BadData(Exception):\n \"\"\"Raised if bad data of any sort was encountered. This is the base\n for all exceptions that ItsDangerous defines.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str):\n super().__init__(message)\n self.message = message\n\n def __str__(self) -> str:\n return self.message\n\n\nclass BadSignature(BadData):\n \"\"\"Raised if a signature does not match.\"\"\"\n\n def __init__(self, message: str, payload: t.Any | None = None):\n super().__init__(message)\n\n #: The payload that failed the signature test. In some\n #: situations you might still want to inspect this, even if\n #: you know it was tampered with.\n #:\n #: .. versionadded:: 0.14\n self.payload: t.Any | None = payload\n\n\nclass BadTimeSignature(BadSignature):\n \"\"\"Raised if a time-based signature is invalid. This is a subclass\n of :class:`BadSignature`.\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n date_signed: datetime | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the signature expired this exposes the date of when the\n #: signature was created. This can be helpful in order to\n #: tell the user how long a link has been gone stale.\n #:\n #: .. versionchanged:: 2.0\n #: The datetime value is timezone-aware rather than naive.\n #:\n #: .. versionadded:: 0.14\n self.date_signed = date_signed\n\n\nclass SignatureExpired(BadTimeSignature):\n \"\"\"Raised if a signature timestamp is older than ``max_age``. This\n is a subclass of :exc:`BadTimeSignature`.\n \"\"\"\n\n\nclass BadHeader(BadSignature):\n \"\"\"Raised if a signed header is invalid in some form. This only\n happens for serializers that have a header that goes with the\n signature.\n\n .. versionadded:: 0.24\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n header: t.Any | None = None,\n original_error: Exception | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the header is actually available but just malformed it\n #: might be stored here.\n self.header: t.Any | None = header\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n\nclass BadPayload(BadData):\n \"\"\"Raised if a payload is invalid. This could happen if the payload\n is loaded despite an invalid signature, or if there is a mismatch\n between the serializer and deserializer. The original exception\n that occurred during loading is stored on as :attr:`original_error`.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str, original_error: Exception | None = None):\n super().__init__(message)\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n[end of src/itsdangerous/exc.py]","filename":"src/itsdangerous/exc.py","id":"39"},{"content":"[end of src/itsdangerous/py.typed]","filename":"src/itsdangerous/py.typed","id":"40"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport json\nimport typing as t\n\nfrom .encoding import want_bytes\nfrom .exc import BadPayload\nfrom .exc import BadSignature\nfrom .signer import _make_keys_list\nfrom .signer import Signer\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n # This should be either be str or bytes. To avoid having to specify the\n # bound type, it falls back to a union if structural matching fails.\n _TSerialized = te.TypeVar(\n \"_TSerialized\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\n )\nelse:\n # Still available at runtime on Python < 3.13, but without the default.\n _TSerialized = t.TypeVar(\"_TSerialized\", bound=t.Union[str, bytes])\n\n\nclass _PDataSerializer(t.Protocol[_TSerialized]):\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\n # A signature with additional arguments is not handled correctly by type\n # checkers right now, so an overload is used below for serializers that\n # don't match this strict protocol.\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\n\n\n# Use TypeIs once it's available in typing_extensions or 3.13.\ndef is_text_serializer(\n serializer: _PDataSerializer[t.Any],\n) -> te.TypeGuard[_PDataSerializer[str]]:\n \"\"\"Checks whether a serializer generates text or binary.\"\"\"\n return isinstance(serializer.dumps({}), str)\n\n\nclass Serializer(t.Generic[_TSerialized]):\n \"\"\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\n enable serializing and securely signing data other than bytes. It\n can unsign to verify that the data hasn't been changed.\n\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\n :mod:`json`, and by default uses :mod:`json` internally to serialize\n the data to bytes.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param serializer: An object that provides ``dumps`` and ``loads``\n methods for serializing data to a string. Defaults to\n :attr:`default_serializer`, which defaults to :mod:`json`.\n :param serializer_kwargs: Keyword arguments to pass when calling\n ``serializer.dumps``.\n :param signer: A ``Signer`` class to instantiate when signing data.\n Defaults to :attr:`default_signer`, which defaults to\n :class:`~itsdangerous.signer.Signer`.\n :param signer_kwargs: Keyword arguments to pass when instantiating\n the ``Signer`` class.\n :param fallback_signers: List of signer parameters to try when\n unsigning with the default signer fails. Each item can be a dict\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\n ``(signer, signer_kwargs)``. Defaults to\n :attr:`default_fallback_signers`.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 2.0\n Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``.\n\n .. versionchanged:: 1.1\n Added support for ``fallback_signers`` and configured a default\n SHA-512 fallback. This fallback is for users who used the yanked\n 1.0.0 release which defaulted to SHA-512.\n\n .. versionchanged:: 0.14\n The ``signer`` and ``signer_kwargs`` parameters were added to\n the constructor.\n \"\"\"\n\n #: The default serialization module to use to serialize data to a\n #: string internally. The default is :mod:`json`, but can be changed\n #: to any object that provides ``dumps`` and ``loads`` methods.\n default_serializer: _PDataSerializer[t.Any] = json\n\n #: The default ``Signer`` class to instantiate when signing data.\n #: The default is :class:`itsdangerous.signer.Signer`.\n default_signer: type[Signer] = Signer\n\n #: The default fallback signers to try when unsigning fails.\n default_fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = []\n\n # Serializer[str] if no data serializer is provided, or if it returns str.\n @t.overload\n def __init__(\n self: Serializer[str],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: None | _PDataSerializer[str] = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer positional argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer keyword argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a positional argument. If the strict signature of\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\n # to specify the type.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a keyword argument.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: t.Any | None = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n\n if salt is not None:\n salt = want_bytes(salt)\n # if salt is None then the signer's default is used\n\n self.salt = salt\n\n if serializer is None:\n serializer = self.default_serializer\n\n self.serializer: _PDataSerializer[_TSerialized] = serializer\n self.is_text_serializer: bool = is_text_serializer(serializer)\n\n if signer is None:\n signer = self.default_signer\n\n self.signer: type[Signer] = signer\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\n\n if fallback_signers is None:\n fallback_signers = list(self.default_fallback_signers)\n\n self.fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = fallback_signers\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def load_payload(\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\n ) -> t.Any:\n \"\"\"Loads the encoded object. This function raises\n :class:`.BadPayload` if the payload is not valid. The\n ``serializer`` parameter can be used to override the serializer\n stored on the class. The encoded ``payload`` should always be\n bytes.\n \"\"\"\n if serializer is None:\n use_serializer = self.serializer\n is_text = self.is_text_serializer\n else:\n use_serializer = serializer\n is_text = is_text_serializer(serializer)\n\n try:\n if is_text:\n return use_serializer.loads(payload.decode(\"utf-8\")) # type: ignore[arg-type]\n\n return use_serializer.loads(payload) # type: ignore[arg-type]\n except Exception as e:\n raise BadPayload(\n \"Could not load the payload because an exception\"\n \" occurred on unserializing the data.\",\n original_error=e,\n ) from e\n\n def dump_payload(self, obj: t.Any) -> bytes:\n \"\"\"Dumps the encoded object. The return value is always bytes.\n If the internal serializer returns text, the value will be\n encoded as UTF-8.\n \"\"\"\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\n\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\n \"\"\"Creates a new instance of the signer to be used. The default\n implementation uses the :class:`.Signer` base class.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\n\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\n \"\"\"Iterates over all signers to be tried for unsigning. Starts\n with the configured signer, then constructs each signer\n specified in ``fallback_signers``.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n yield self.make_signer(salt)\n\n for fallback in self.fallback_signers:\n if isinstance(fallback, dict):\n kwargs = fallback\n fallback = self.signer\n elif isinstance(fallback, tuple):\n fallback, kwargs = fallback\n else:\n kwargs = self.signer_kwargs\n\n for secret_key in self.secret_keys:\n yield fallback(secret_key, salt=salt, **kwargs)\n\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\n \"\"\"Returns a signed string serialized with the internal\n serializer. The return value can be either a byte or unicode\n string depending on the format of the internal serializer.\n \"\"\"\n payload = want_bytes(self.dump_payload(obj))\n rv = self.make_signer(salt).sign(payload)\n\n if self.is_text_serializer:\n return rv.decode(\"utf-8\") # type: ignore[return-value]\n\n return rv # type: ignore[return-value]\n\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\n \"\"\"Like :meth:`dumps` but dumps into a file. The file handle has\n to be compatible with what the internal serializer expects.\n \"\"\"\n f.write(self.dumps(obj, salt))\n\n def loads(\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\n signature validation fails.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n return self.load_payload(signer.unsign(s))\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\n \"\"\"Like :meth:`loads` but loads from a file.\"\"\"\n return self.loads(f.read(), salt)\n\n def loads_unsafe(\n self, s: str | bytes, salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads` but without verifying the signature. This\n is potentially very dangerous to use depending on how your\n serializer works. The return value is ``(signature_valid,\n payload)`` instead of just the payload. The first item will be a\n boolean that indicates if the signature is valid. This function\n never fails.\n\n Use it for debugging only and if you know that your serializer\n module is not exploitable (for example, do not use it with a\n pickle serializer).\n\n .. versionadded:: 0.15\n \"\"\"\n return self._loads_unsafe_impl(s, salt)\n\n def _loads_unsafe_impl(\n self,\n s: str | bytes,\n salt: str | bytes | None,\n load_kwargs: dict[str, t.Any] | None = None,\n load_payload_kwargs: dict[str, t.Any] | None = None,\n ) -> tuple[bool, t.Any]:\n \"\"\"Low level helper function to implement :meth:`loads_unsafe`\n in serializer subclasses.\n \"\"\"\n if load_kwargs is None:\n load_kwargs = {}\n\n try:\n return True, self.loads(s, salt=salt, **load_kwargs)\n except BadSignature as e:\n if e.payload is None:\n return False, None\n\n if load_payload_kwargs is None:\n load_payload_kwargs = {}\n\n try:\n return (\n False,\n self.load_payload(e.payload, **load_payload_kwargs),\n )\n except BadPayload:\n return False, None\n\n def load_unsafe(\n self, f: t.IO[t.Any], salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads_unsafe` but loads from a file.\n\n .. versionadded:: 0.15\n \"\"\"\n return self.loads_unsafe(f.read(), salt=salt)\n\n[end of src/itsdangerous/serializer.py]","filename":"src/itsdangerous/serializer.py","id":"41"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport hashlib\nimport hmac\nimport typing as t\n\nfrom .encoding import _base64_alphabet\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\n\n\nclass SigningAlgorithm:\n \"\"\"Subclasses must implement :meth:`get_signature` to provide\n signature generation functionality.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n \"\"\"Returns the signature for the given key and value.\"\"\"\n raise NotImplementedError()\n\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\n \"\"\"Verifies the given signature matches the expected\n signature.\n \"\"\"\n return hmac.compare_digest(sig, self.get_signature(key, value))\n\n\nclass NoneAlgorithm(SigningAlgorithm):\n \"\"\"Provides an algorithm that does not perform any signing and\n returns an empty signature.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n return b\"\"\n\n\ndef _lazy_sha1(string: bytes = b\"\") -> t.Any:\n \"\"\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\n SHA-1, in which case the import and use as a default would fail before the\n developer can configure something else.\n \"\"\"\n return hashlib.sha1(string)\n\n\nclass HMACAlgorithm(SigningAlgorithm):\n \"\"\"Provides signature generation using HMACs.\"\"\"\n\n #: The digest method to use with the MAC algorithm. This defaults to\n #: SHA1, but can be changed to any other function in the hashlib\n #: module.\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n def __init__(self, digest_method: t.Any = None):\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\n return mac.digest()\n\n\ndef _make_keys_list(\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n) -> list[bytes]:\n if isinstance(secret_key, (str, bytes)):\n return [want_bytes(secret_key)]\n\n return [want_bytes(s) for s in secret_key] # pyright: ignore\n\n\nclass Signer:\n \"\"\"A signer securely signs bytes, then unsigns them to verify that\n the value hasn't been changed.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param sep: Separator between the signature and value.\n :param key_derivation: How to derive the signing key from the secret\n key and salt. Possible values are ``concat``, ``django-concat``,\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\n defaults to ``django-concat``.\n :param digest_method: Hash function to use when generating the HMAC\n signature. Defaults to :attr:`default_digest_method`, which\n defaults to :func:`hashlib.sha1`. Note that the security of the\n hash alone doesn't apply when used intermediately in HMAC.\n :param algorithm: A :class:`SigningAlgorithm` instance to use\n instead of building a default :class:`HMACAlgorithm` with the\n ``digest_method``.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 0.18\n ``algorithm`` was added as an argument to the class constructor.\n\n .. versionchanged:: 0.14\n ``key_derivation`` and ``digest_method`` were added as arguments\n to the class constructor.\n \"\"\"\n\n #: The default digest method to use for the signer. The default is\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\n #: compatible object. Note that the security of the hash alone\n #: doesn't apply when used intermediately in HMAC.\n #:\n #: .. versionadded:: 0.14\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n #: The default scheme to use to derive the signing key from the\n #: secret key and salt. The default is ``django-concat``. Possible\n #: values are ``concat``, ``django-concat``, and ``hmac``.\n #:\n #: .. versionadded:: 0.14\n default_key_derivation: str = \"django-concat\"\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous.Signer\",\n sep: str | bytes = b\".\",\n key_derivation: str | None = None,\n digest_method: t.Any | None = None,\n algorithm: SigningAlgorithm | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n self.sep: bytes = want_bytes(sep)\n\n if self.sep in _base64_alphabet:\n raise ValueError(\n \"The given separator cannot be used because it may be\"\n \" contained in the signature itself. ASCII letters,\"\n \" digits, and '-_=' must not be used.\"\n )\n\n if salt is not None:\n salt = want_bytes(salt)\n else:\n salt = b\"itsdangerous.Signer\"\n\n self.salt = salt\n\n if key_derivation is None:\n key_derivation = self.default_key_derivation\n\n self.key_derivation: str = key_derivation\n\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n if algorithm is None:\n algorithm = HMACAlgorithm(self.digest_method)\n\n self.algorithm: SigningAlgorithm = algorithm\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\n \"\"\"This method is called to derive the key. The default key\n derivation choices can be overridden here. Key derivation is not\n intended to be used as a security method to make a complex key\n out of a short password. Instead you should use large random\n secret keys.\n\n :param secret_key: A specific secret key to derive from.\n Defaults to the last item in :attr:`secret_keys`.\n\n .. versionchanged:: 2.0\n Added the ``secret_key`` parameter.\n \"\"\"\n if secret_key is None:\n secret_key = self.secret_keys[-1]\n else:\n secret_key = want_bytes(secret_key)\n\n if self.key_derivation == \"concat\":\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\n elif self.key_derivation == \"django-concat\":\n return t.cast(\n bytes, self.digest_method(self.salt + b\"signer\" + secret_key).digest()\n )\n elif self.key_derivation == \"hmac\":\n mac = hmac.new(secret_key, digestmod=self.digest_method)\n mac.update(self.salt)\n return mac.digest()\n elif self.key_derivation == \"none\":\n return secret_key\n else:\n raise TypeError(\"Unknown key derivation method\")\n\n def get_signature(self, value: str | bytes) -> bytes:\n \"\"\"Returns the signature for the given value.\"\"\"\n value = want_bytes(value)\n key = self.derive_key()\n sig = self.algorithm.get_signature(key, value)\n return base64_encode(sig)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string.\"\"\"\n value = want_bytes(value)\n return value + self.sep + self.get_signature(value)\n\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\n \"\"\"Verifies the signature for the given value.\"\"\"\n try:\n sig = base64_decode(sig)\n except Exception:\n return False\n\n value = want_bytes(value)\n\n for secret_key in reversed(self.secret_keys):\n key = self.derive_key(secret_key)\n\n if self.algorithm.verify_signature(key, value, sig):\n return True\n\n return False\n\n def unsign(self, signed_value: str | bytes) -> bytes:\n \"\"\"Unsigns the given string.\"\"\"\n signed_value = want_bytes(signed_value)\n\n if self.sep not in signed_value:\n raise BadSignature(f\"No {self.sep!r} found in value\")\n\n value, sig = signed_value.rsplit(self.sep, 1)\n\n if self.verify_signature(value, sig):\n return value\n\n raise BadSignature(f\"Signature {sig!r} does not match\", payload=value)\n\n def validate(self, signed_value: str | bytes) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\n \"\"\"\n try:\n self.unsign(signed_value)\n return True\n except BadSignature:\n return False\n\n[end of src/itsdangerous/signer.py]","filename":"src/itsdangerous/signer.py","id":"42"}],"string":"[\n {\n \"content\": \"How to contribute to ItsDangerous\\n=================================\\n\\nThank you for considering contributing to ItsDangerous!\\n\\n\\nSupport questions\\n-----------------\\n\\nPlease don't use the issue tracker for this. The issue tracker is a\\ntool to address bugs and feature requests in ItsDangerous itself. Use\\none of the following resources for questions about using ItsDangerous or\\nissues with your own code:\\n\\n- The ``#get-help`` channel on our Discord chat:\\n https://discord.gg/pallets\\n- The mailing list flask@python.org for long term discussion or larger\\n issues.\\n- Ask on `Stack Overflow`_. Search with Google first using:\\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\\n\\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\\n\\n\\nReporting issues\\n----------------\\n\\nInclude the following information in your post:\\n\\n- Describe what you expected to happen.\\n- If possible, include a `minimal reproducible example`_ to help us\\n identify the issue. This also helps check that the issue is not with\\n your own code.\\n- Describe what actually happened. Include the full traceback if there\\n was an exception.\\n- List your Python and ItsDangerous versions. If possible, check if\\n this issue is already fixed in the latest releases or the latest\\n code in the repository.\\n\\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\\n\\n\\nSubmitting patches\\n------------------\\n\\nIf there is not an open issue for what you want to submit, prefer\\nopening one for discussion before working on a PR. You can work on any\\nissue that doesn't have an open PR linked to it or a maintainer assigned\\nto it. These show up in the sidebar. No need to ask if you can work on\\nan issue that interests you.\\n\\nInclude the following in your patch:\\n\\n- Use `Black`_ to format your code. This and other tools will run\\n automatically if you install `pre-commit`_ using the instructions\\n below.\\n- Include tests if your patch adds or changes code. Make sure the test\\n fails without your patch.\\n- Update any relevant docs pages and docstrings. Docs pages and\\n docstrings should be wrapped at 72 characters.\\n- Add an entry in ``CHANGES.rst``. Use the same style as other\\n entries. Also include ``.. versionchanged::`` inline changelogs in\\n relevant docstrings.\\n\\n.. _Black: https://black.readthedocs.io\\n.. _pre-commit: https://pre-commit.com\\n\\n\\nFirst time setup\\n~~~~~~~~~~~~~~~~\\n\\n- Download and install the `latest version of git`_.\\n- Configure git with your `username`_ and `email`_.\\n\\n .. code-block:: text\\n\\n $ git config --global user.name 'your name'\\n $ git config --global user.email 'your email'\\n\\n- Make sure you have a `GitHub account`_.\\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\\n button.\\n- `Clone`_ the main repository locally.\\n\\n .. code-block:: text\\n\\n $ git clone https://github.com/pallets/itsdangerous\\n $ cd itsdangerous\\n\\n- Add your fork as a remote to push your work to. Replace\\n ``{username}`` with your username. This names the remote \\\"fork\\\", the\\n default Pallets remote is \\\"origin\\\".\\n\\n .. code-block:: text\\n\\n $ git remote add fork https://github.com/{username}/itsdangerous\\n\\n- Create a virtualenv.\\n\\n .. code-block:: text\\n\\n $ python3 -m venv env\\n $ . env/bin/activate\\n\\n On Windows, activating is different.\\n\\n .. code-block:: text\\n\\n > env\\\\Scripts\\\\activate\\n\\n- Install the development dependencies, then install ItsDangerous in\\n editable mode.\\n\\n .. code-block:: text\\n\\n $ pip install -r requirements/dev.txt && pip install -e .\\n\\n- Install the pre-commit hooks.\\n\\n .. code-block:: text\\n\\n $ pre-commit install\\n\\n.. _latest version of git: https://git-scm.com/downloads\\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\\n.. _GitHub account: https://github.com/join\\n.. _Fork: https://github.com/pallets/itsdangerous/fork\\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\\n\\n\\nStart coding\\n~~~~~~~~~~~~\\n\\n- Create a branch to identify the issue you would like to work on. If\\n you're submitting a bug or documentation fix, branch off of the\\n latest \\\".x\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/2.0.x\\n\\n If you're submitting a feature addition or change, branch off of the\\n \\\"main\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/main\\n\\n- Using your favorite editor, make your changes,\\n `committing as you go`_.\\n- Include tests that cover any code changes you make. Make sure the\\n test fails without your patch. Run the tests as described below.\\n- Push your commits to your fork on GitHub and\\n `create a pull request`_. Link to the issue being addressed with\\n ``fixes #123`` in the pull request.\\n\\n .. code-block:: text\\n\\n $ git push --set-upstream fork your-branch-name\\n\\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\\n\\n\\nRunning the tests\\n~~~~~~~~~~~~~~~~~\\n\\nRun the basic test suite with pytest.\\n\\n.. code-block:: text\\n\\n $ pytest\\n\\nThis runs the tests for the current environment, which is usually\\nsufficient. CI will run the full suite when you submit your pull\\nrequest. You can run the full test suite with tox if you don't want to\\nwait.\\n\\n.. code-block:: text\\n\\n $ tox\\n\\n\\nRunning test coverage\\n~~~~~~~~~~~~~~~~~~~~~\\n\\nGenerating a report of lines that do not have test coverage can indicate\\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\\ngenerate a report.\\n\\n.. code-block:: text\\n\\n $ pip install coverage\\n $ coverage run -m pytest\\n $ coverage html\\n\\nOpen ``htmlcov/index.html`` in your browser to explore the report.\\n\\nRead more about `coverage <https://coverage.readthedocs.io>`__.\\n\\n\\nBuilding the docs\\n~~~~~~~~~~~~~~~~~\\n\\nBuild the docs in the ``docs`` directory using Sphinx.\\n\\n.. code-block:: text\\n\\n $ cd docs\\n $ make html\\n\\nOpen ``_build/html/index.html`` in your browser to view the docs.\\n\\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\\n\\n[end of CONTRIBUTING.rst]\",\n \"filename\": \"CONTRIBUTING.rst\",\n \"id\": \"0\"\n },\n {\n \"content\": \"repos:\\n - repo: https://github.com/astral-sh/ruff-pre-commit\\n rev: v0.7.1\\n hooks:\\n - id: ruff\\n - id: ruff-format\\n - repo: https://github.com/pre-commit/pre-commit-hooks\\n rev: v5.0.0\\n hooks:\\n - id: check-merge-conflict\\n - id: debug-statements\\n - id: fix-byte-order-marker\\n - id: trailing-whitespace\\n - id: end-of-file-fixer\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[project]\\nname = \\\"itsdangerous\\\"\\nversion = \\\"2.2.0\\\"\\ndescription = \\\"Safely pass data to untrusted environments and back.\\\"\\nreadme = \\\"README.md\\\"\\nlicense = { file = \\\"LICENSE.txt\\\" }\\nmaintainers = [{ name = \\\"Pallets\\\", email = \\\"contact@palletsprojects.com\\\" }]\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Typing :: Typed\\\",\\n]\\nrequires-python = \\\">=3.8\\\"\\n\\n[project.urls]\\nDonate = \\\"https://palletsprojects.com/donate\\\"\\nDocumentation = \\\"https://itsdangerous.palletsprojects.com/\\\"\\nChanges = \\\"https://itsdangerous.palletsprojects.com/changes/\\\"\\nSource = \\\"https://github.com/pallets/itsdangerous/\\\"\\nChat = \\\"https://discord.gg/pallets\\\"\\n\\n[build-system]\\nrequires = [\\\"flit_core<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.module]\\nname = \\\"itsdangerous\\\"\\n\\n[tool.flit.sdist]\\ninclude = [\\n \\\"docs/\\\",\\n \\\"requirements/\\\",\\n \\\"tests/\\\",\\n \\\"CHANGES.rst\\\",\\n \\\"tox.ini\\\",\\n]\\nexclude = [\\n \\\"docs/_build/\\\",\\n]\\n\\n[tool.pytest.ini_options]\\ntestpaths = [\\\"tests\\\"]\\nfilterwarnings = [\\n \\\"error\\\",\\n]\\n\\n[tool.coverage.run]\\nbranch = true\\nsource = [\\\"itsdangerous\\\", \\\"tests\\\"]\\n\\n[tool.coverage.paths]\\nsource = [\\\"src\\\", \\\"*/site-packages\\\"]\\n\\n[tool.mypy]\\npython_version = \\\"3.8\\\"\\nfiles = [\\\"src/itsdangerous\\\"]\\nshow_error_codes = true\\npretty = true\\nstrict = true\\n\\n[tool.pyright]\\npythonVersion = \\\"3.8\\\"\\ninclude = [\\\"src/itsdangerous\\\"]\\ntypeCheckingMode = \\\"basic\\\"\\n\\n[tool.ruff]\\nsrc = [\\\"src\\\"]\\nfix = true\\nshow-fixes = true\\noutput-format = \\\"full\\\"\\n\\n[tool.ruff.lint]\\nselect = [\\n \\\"B\\\", # flake8-bugbear\\n \\\"E\\\", # pycodestyle error\\n \\\"F\\\", # pyflakes\\n \\\"I\\\", # isort\\n \\\"UP\\\", # pyupgrade\\n \\\"W\\\", # pycodestyle warning\\n]\\n\\n[tool.ruff.lint.isort]\\nforce-single-line = true\\norder-by-type = false\\n\\n[tool.gha-update]\\ntag-only = [\\n \\\"slsa-framework/slsa-github-generator\\\",\\n]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\nindent_style = space\\nindent_size = 4\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\nend_of_line = lf\\ncharset = utf-8\\nmax_line_length = 88\\n\\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"3\"\n },\n {\n \"content\": \"# ItsDangerous\\n\\n... so better sign this\\n\\nVarious helpers to pass data to untrusted environments and to get it\\nback safe and sound. Data is cryptographically signed to ensure that a\\ntoken has not been tampered with.\\n\\nIt's possible to customize how data is serialized. Data is compressed as\\nneeded. A timestamp can be added and verified automatically while\\nloading a token.\\n\\n\\n## A Simple Example\\n\\nHere's how you could generate a token for transmitting a user's id and\\nname between web requests.\\n\\n```python\\nfrom itsdangerous import URLSafeSerializer\\nauth_s = URLSafeSerializer(\\\"secret key\\\", \\\"auth\\\")\\ntoken = auth_s.dumps({\\\"id\\\": 5, \\\"name\\\": \\\"itsdangerous\\\"})\\n\\nprint(token)\\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\\n\\ndata = auth_s.loads(token)\\nprint(data[\\\"name\\\"])\\n# itsdangerous\\n```\\n\\n\\n## Donate\\n\\nThe Pallets organization develops and supports ItsDangerous and other\\npopular packages. In order to grow the community of contributors and\\nusers, and allow the maintainers to devote more time to the projects,\\n[please donate today][].\\n\\n[please donate today]: https://palletsprojects.com/donate\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"[tox]\\nenvlist =\\n py3{13,12,11,10,9,8}\\n pypy310\\n style\\n typing\\n docs\\nskip_missing_interpreters = true\\n\\n[testenv]\\npackage = wheel\\nwheel_build_env = .pkg\\nconstrain_package_deps = true\\nuse_frozen_constraints = true\\ndeps = -r requirements/tests.txt\\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\\n\\n[testenv:style]\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit run --all-files\\n\\n[testenv:typing]\\ndeps = -r requirements/typing.txt\\ncommands =\\n mypy\\n pyright\\n pyright --verifytypes itsdangerous --ignoreexternal\\n\\n[testenv:docs]\\ndeps = -r requirements/docs.txt\\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\\n\\n[testenv:update-actions]\\nlabels = update\\ndeps = gha-update\\ncommands = gha-update\\n\\n[testenv:update-pre_commit]\\nlabels = update\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit autoupdate -j4\\n\\n[testenv:update-requirements]\\nlabels = update\\ndeps = pip-tools\\nskip_install = true\\nchange_dir = requirements\\ncommands =\\n pip-compile build.in -q {posargs:-U}\\n pip-compile docs.in -q {posargs:-U}\\n pip-compile tests.in -q {posargs:-U}\\n pip-compile typing.in -q {posargs:-U}\\n pip-compile dev.in -q {posargs:-U}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"5\"\n },\n {\n \"content\": \"Copyright 2011 Pallets\\n\\nRedistribution and use in source and binary forms, with or without\\nmodification, are permitted provided that the following conditions are\\nmet:\\n\\n1. Redistributions of source code must retain the above copyright\\n notice, this list of conditions and the following disclaimer.\\n\\n2. 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\\n3. Neither the name of the copyright holder nor the names of its\\n contributors may be used to endorse or promote products derived from\\n this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE.txt]\",\n \"filename\": \"LICENSE.txt\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Version 2.2.0\\n-------------\\n\\nReleased 2024-04-16\\n\\n- Drop support for Python 3.7. :pr:`372`\\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\\n :pr:`326`\\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\\n- Deprecate the ``__version__`` attribute. Use feature detection, or\\n ``importlib.metadata.version(\\\"itsdangerous\\\")``, instead. :issue:`371`\\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\\n different ``serializer`` argument is given, it will try to infer the return\\n type of its ``dumps`` method. :issue:`347`\\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\\n access it at import time so the developer has time to change the default.\\n :issue:`375`\\n\\n\\nVersion 2.1.2\\n-------------\\n\\nReleased 2022-03-24\\n\\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\\n\\n\\nVersion 2.1.1\\n-------------\\n\\nReleased 2022-03-09\\n\\n- Handle date overflow in timed unsign. :pr:`296`\\n\\n\\nVersion 2.1.0\\n-------------\\n\\nReleased 2022-02-17\\n\\n- Drop support for Python 3.6. :pr:`272`\\n- Remove previously deprecated code. :pr:`273`\\n\\n - JWS functionality: Use a dedicated library such as Authlib\\n instead.\\n - ``import itsdangerous.json``: Import ``json`` from the standard\\n library instead.\\n\\n\\nVersion 2.0.1\\n-------------\\n\\nReleased 2021-05-18\\n\\n- Mark top-level names as exported so type checking understands\\n imports in user projects. :pr:`240`\\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\\n ``None`` again. :issue:`237`\\n\\n\\nVersion 2.0.0\\n-------------\\n\\nReleased 2021-05-11\\n\\n- Drop support for Python 2 and 3.5.\\n- JWS support (``JSONWebSignatureSerializer``,\\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\\n JWS/JWT library such as authlib instead. :issue:`129`\\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\\n ``json`` module instead. :pr:`152`\\n- Simplejson is no longer used if it is installed. To use a different\\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\\n- If a signature has an age less than 0, it will raise\\n ``SignatureExpired`` rather than appearing valid. This can happen if\\n the timestamp offset is changed. :issue:`126`\\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\\n rather than an ``int`` in some cases. :issue:`124`\\n- Added support for key rotation. A list of keys can be passed as\\n ``secret_key``, oldest to newest. The newest key is used for\\n signing, all keys are tried for unsigning. :pr:`141`\\n- Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``. :issue:`155`\\n- Add type information for static typing tools. :pr:`186`\\n\\n\\nVersion 1.1.0\\n-------------\\n\\nReleased 2018-10-26\\n\\n- Change default signing algorithm back to SHA-1. :pr:`113`\\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\\n release which defaulted to SHA-512. :pr:`114`\\n- Add support for fallback algorithms during deserialization to\\n support changing the default in the future without breaking existing\\n signatures. :pr:`113`\\n- Changed capitalization of packages back to lowercase as the change\\n in capitalization broke some tooling. :pr:`113`\\n\\n\\nVersion 1.0.0\\n-------------\\n\\nReleased 2018-10-18\\n\\nYANKED\\n\\n*Note*: This release was yanked from PyPI because it changed the default\\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\\nat SHA1.\\n\\n- Drop support for Python 2.6 and 3.3.\\n- Refactor code from a single module to a package. Any object in the\\n API docs is still importable from the top-level ``itsdangerous``\\n name, but other imports will need to be changed. A future release\\n will remove many of these compatibility imports. :pr:`107`\\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\\n :pr:`27`\\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\\n Python 3. :issue:`29`\\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\\n- More compact JSON dumps for unicode strings. :issue:`38`\\n- Use the full timestamp rather than an offset, allowing dates before\\n 2011. :issue:`46`\\n\\n To retain compatibility with signers from previous versions,\\n consider using `this shim <https://github.com/pallets/itsdangerous\\n /issues/120#issuecomment-456913331>`_ when unsigning.\\n- Detect a ``sep`` character that may show up in the signature itself\\n and raise a ``ValueError``. :issue:`62`\\n- Use a consistent signature for keyword arguments for\\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\\n- Convert JWS exp header to an int when loading. :pr:`99`\\n\\n\\nVersion 0.24\\n------------\\n\\nReleased 2014-03-28\\n\\n- Added a ``BadHeader`` exception that is used for bad headers that\\n replaces the old ``BadPayload`` exception that was reused in those\\n cases.\\n\\n\\nVersion 0.23\\n------------\\n\\nReleased 2013-08-08\\n\\n- Fixed a packaging mistake that caused the tests and license files to\\n not be included.\\n\\n\\nVersion 0.22\\n------------\\n\\nReleased 2013-07-03\\n\\n- Added support for ``TimedJSONWebSignatureSerializer``.\\n- Made it possible to override the signature verification function to\\n allow implementing asymmetrical algorithms.\\n\\n\\nVersion 0.21\\n------------\\n\\nReleased 2013-05-26\\n\\n- Fixed an issue on Python 3 which caused invalid errors to be\\n generated.\\n\\n\\nVersion 0.20\\n------------\\n\\nReleased 2013-05-23\\n\\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\\n ItsDangerous on Python 2.6.\\n\\n\\nVersion 0.19\\n------------\\n\\nReleased 2013-05-21\\n\\n- Dropped support for 2.5 and added support for 3.3.\\n\\n\\nVersion 0.18\\n------------\\n\\nReleased 2013-05-03\\n\\n- Added support for JSON Web Signatures (JWS).\\n\\n\\nVersion 0.17\\n------------\\n\\nReleased 2012-08-10\\n\\n- Fixed a name error when overriding the digest method.\\n\\n\\nVersion 0.16\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made it possible to pass unicode values to ``load_payload`` to make\\n it easier to debug certain things.\\n\\n\\nVersion 0.15\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made standalone ``load_payload`` more robust by raising one specific\\n error if something goes wrong.\\n- Refactored exceptions to catch more cases individually, added more\\n attributes.\\n- Fixed an issue that caused ``load_payload`` not work in some\\n situations with timestamp based serializers\\n- Added an ``loads_unsafe`` method.\\n\\n\\nVersion 0.14\\n------------\\n\\nReleased 2012-06-29\\n\\n- API refactoring to support different key derivations.\\n- Added attributes to exceptions so that you can inspect the data even\\n if the signature check failed.\\n\\n\\nVersion 0.13\\n------------\\n\\nReleased 2012-06-10\\n\\n- Small API change that enables customization of the digest module.\\n\\n\\nVersion 0.12\\n------------\\n\\nReleased 2012-02-22\\n\\n- Fixed a problem with the local timezone being used for the epoch\\n calculation. This might invalidate some of your signatures if you\\n were not running in UTC timezone. You can revert to the old behavior\\n by monkey patching ``itsdangerous.EPOCH``.\\n\\n\\nVersion 0.11\\n------------\\n\\nReleased 2011-07-07\\n\\n- Fixed an uncaught value error.\\n\\n\\nVersion 0.10\\n------------\\n\\nReleased 2011-06-25\\n\\n- Refactored interface that the underlying serializers can be swapped\\n by passing in a module instead of having to override the payload\\n loaders and dumpers. This makes the interface more compatible with\\n Django's recent changes.\\n\\n[end of CHANGES.rst]\",\n \"filename\": \"CHANGES.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"version: 2\\nbuild:\\n os: ubuntu-22.04\\n tools:\\n python: '3.12'\\npython:\\n install:\\n - requirements: requirements/docs.txt\\n - method: pip\\n path: .\\nsphinx:\\n builder: dirhtml\\n fail_on_warning: true\\n\\n[end of .readthedocs.yaml]\",\n \"filename\": \".readthedocs.yaml\",\n \"id\": \"8\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile dev.in\\n#\\nalabaster==1.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nbabel==2.16.0\\n # via\\n # -r docs.txt\\n # sphinx\\ncachetools==5.5.0\\n # via tox\\ncertifi==2024.8.30\\n # via\\n # -r docs.txt\\n # requests\\ncfgv==3.4.0\\n # via pre-commit\\nchardet==5.2.0\\n # via tox\\ncharset-normalizer==3.4.0\\n # via\\n # -r docs.txt\\n # requests\\ncolorama==0.4.6\\n # via tox\\ndistlib==0.3.9\\n # via virtualenv\\ndocutils==0.21.2\\n # via\\n # -r docs.txt\\n # sphinx\\nfilelock==3.16.1\\n # via\\n # tox\\n # virtualenv\\nfreezegun==1.5.1\\n # via -r tests.txt\\nidentify==2.6.1\\n # via pre-commit\\nidna==3.10\\n # via\\n # -r docs.txt\\n # requests\\nimagesize==1.4.1\\n # via\\n # -r docs.txt\\n # sphinx\\niniconfig==2.0.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\njinja2==3.1.4\\n # via\\n # -r docs.txt\\n # sphinx\\nmarkupsafe==3.0.2\\n # via\\n # -r docs.txt\\n # jinja2\\nmypy==1.13.0\\n # via -r typing.txt\\nmypy-extensions==1.0.0\\n # via\\n # -r typing.txt\\n # mypy\\nnodeenv==1.9.1\\n # via\\n # -r typing.txt\\n # pre-commit\\n # pyright\\npackaging==24.1\\n # via\\n # -r docs.txt\\n # -r tests.txt\\n # -r typing.txt\\n # pallets-sphinx-themes\\n # pyproject-api\\n # pytest\\n # sphinx\\n # tox\\npallets-sphinx-themes==2.3.0\\n # via -r docs.txt\\nplatformdirs==4.3.6\\n # via\\n # tox\\n # virtualenv\\npluggy==1.5.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\n # tox\\npre-commit==4.0.1\\n # via -r dev.in\\npygments==2.18.0\\n # via\\n # -r docs.txt\\n # sphinx\\npyproject-api==1.8.0\\n # via tox\\npyright==1.1.386\\n # via -r typing.txt\\npytest==8.3.3\\n # via\\n # -r tests.txt\\n # -r typing.txt\\npython-dateutil==2.9.0.post0\\n # via\\n # -r tests.txt\\n # freezegun\\npyyaml==6.0.2\\n # via pre-commit\\nrequests==2.32.3\\n # via\\n # -r docs.txt\\n # sphinx\\nsix==1.16.0\\n # via\\n # -r tests.txt\\n # python-dateutil\\nsnowballstemmer==2.2.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.txt\\nsphinxcontrib-qthelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\ntox==4.23.2\\n # via -r dev.in\\ntyping-extensions==4.12.2\\n # via\\n # -r typing.txt\\n # mypy\\n # pyright\\nurllib3==2.2.3\\n # via\\n # -r docs.txt\\n # requests\\nvirtualenv==20.27.0\\n # via\\n # pre-commit\\n # tox\\n\\n[end of requirements/dev.txt]\",\n \"filename\": \"requirements/dev.txt\",\n \"id\": \"9\"\n },\n {\n \"content\": \"pallets-sphinx-themes\\nsphinx\\nsphinxcontrib-log-cabinet\\n\\n[end of requirements/docs.in]\",\n \"filename\": \"requirements/docs.in\",\n \"id\": \"10\"\n },\n {\n \"content\": \"build\\n\\n[end of requirements/build.in]\",\n \"filename\": \"requirements/build.in\",\n \"id\": \"11\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile typing.in\\n#\\niniconfig==2.0.0\\n # via pytest\\nmypy==1.13.0\\n # via -r typing.in\\nmypy-extensions==1.0.0\\n # via mypy\\nnodeenv==1.9.1\\n # via pyright\\npackaging==24.1\\n # via pytest\\npluggy==1.5.0\\n # via pytest\\npyright==1.1.386\\n # via -r typing.in\\npytest==8.3.3\\n # via -r typing.in\\ntyping-extensions==4.12.2\\n # via\\n # mypy\\n # pyright\\n\\n[end of requirements/typing.txt]\",\n \"filename\": \"requirements/typing.txt\",\n \"id\": \"12\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile build.in\\n#\\nbuild==1.2.2.post1\\n # via -r build.in\\npackaging==24.1\\n # via build\\npyproject-hooks==1.2.0\\n # via build\\n\\n[end of requirements/build.txt]\",\n \"filename\": \"requirements/build.txt\",\n \"id\": \"13\"\n },\n {\n \"content\": \"mypy\\npyright\\npytest\\n\\n[end of requirements/typing.in]\",\n \"filename\": \"requirements/typing.in\",\n \"id\": \"14\"\n },\n {\n \"content\": \"-r docs.txt\\n-r tests.txt\\n-r typing.txt\\npre-commit\\ntox\\n\\n[end of requirements/dev.in]\",\n \"filename\": \"requirements/dev.in\",\n \"id\": \"15\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile docs.in\\n#\\nalabaster==1.0.0\\n # via sphinx\\nbabel==2.16.0\\n # via sphinx\\ncertifi==2024.8.30\\n # via requests\\ncharset-normalizer==3.4.0\\n # via requests\\ndocutils==0.21.2\\n # via sphinx\\nidna==3.10\\n # via requests\\nimagesize==1.4.1\\n # via sphinx\\njinja2==3.1.4\\n # via sphinx\\nmarkupsafe==3.0.2\\n # via jinja2\\npackaging==24.1\\n # via\\n # pallets-sphinx-themes\\n # sphinx\\npallets-sphinx-themes==2.3.0\\n # via -r docs.in\\npygments==2.18.0\\n # via sphinx\\nrequests==2.32.3\\n # via sphinx\\nsnowballstemmer==2.2.0\\n # via sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.in\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.in\\nsphinxcontrib-qthelp==2.0.0\\n # via sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via sphinx\\nurllib3==2.2.3\\n # via requests\\n\\n[end of requirements/docs.txt]\",\n \"filename\": \"requirements/docs.txt\",\n \"id\": \"16\"\n },\n {\n \"content\": \".. rst-class:: hide-header\\n\\nItsDangerous\\n============\\n\\n.. image:: _static/itsdangerous-logo.png\\n :align: center\\n :target: https://palletsprojects.com/p/itsdangerous/\\n\\nSometimes you want to send some data to untrusted environments, then get\\nit back later. To do this safely, the data must be signed to detect\\nchanges.\\n\\nGiven a key only you know, you can cryptographically sign your data and\\nhand it over to someone else. When you get the data back you can ensure\\nthat nobody tampered with it.\\n\\nThe receiver can see the data, but they can not modify it unless they\\nalso have your key. So if you keep the key secret and complex, you will\\nbe fine.\\n\\n\\nInstalling\\n----------\\n\\nInstall and update using `pip`_:\\n\\n.. code-block:: text\\n\\n pip install -U itsdangerous\\n\\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\\n\\n\\nExample Use Cases\\n-----------------\\n\\n- Sign a user ID in a URL and email it to them to unsubscribe from a\\n newsletter. This way you don't need to generate one-time tokens and\\n store them in the database. Same thing with any kind of activation\\n link for accounts and similar things.\\n- Signed objects can be stored in cookies or other untrusted sources\\n which means you don't need to have sessions stored on the server,\\n which reduces the number of necessary database queries.\\n- Signed information can safely do a round trip between server and\\n client in general which makes them useful for passing server-side\\n state to a client and then back.\\n\\n\\nTable of Contents\\n-----------------\\n\\n.. toctree::\\n\\n concepts\\n serializer\\n signer\\n exceptions\\n timed\\n url_safe\\n encoding\\n license\\n changes\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"17\"\n },\n {\n \"content\": \".. module:: itsdangerous.serializer\\n\\nSerialization Interface\\n=======================\\n\\nThe :doc:`/signer` only signs bytes. To sign other types, the\\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\\nsimilar to Python's :mod:`json` module, which serializes the object to a\\nstring then signs that.\\n\\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n s = Serializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\\n\\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\\nthe data.\\n\\n.. code-block:: python\\n\\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\\n [1, 2, 3, 4]\\n\\nBy default, data is serialized to JSON with the built-in :mod:`json`\\nmodule. This internal serializer can be changed by subclassing.\\n\\nTo record and validate the age of the signature, see :doc:`/timed`.\\nTo serialize to a format that is safe to use in URLs, see\\n:doc:`/url_safe`.\\n\\n\\nResponding to Failure\\n---------------------\\n\\nExceptions have helpful attributes which allow you to inspect the\\npayload if the signature check failed. This has to be done with extra\\ncare because at that point you know that someone tampered with your data\\nbut it might be useful for debugging purposes.\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n from itsdangerous.exc import BadSignature, BadData\\n\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n decoded_payload = None\\n\\n try:\\n decoded_payload = s.loads(data)\\n # This payload is decoded and safe\\n except BadSignature as e:\\n if e.payload is not None:\\n try:\\n decoded_payload = s.load_payload(e.payload)\\n except BadData:\\n pass\\n # This payload is decoded but unsafe because someone\\n # tampered with the signature. The decode (load_payload)\\n # step is explicit because it might be unsafe to unserialize\\n # the payload (think pickle instead of json!)\\n\\nIf you don't want to inspect attributes to figure out what exactly went\\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\\n\\n.. code-block:: python\\n\\n sig_okay, payload = s.loads_unsafe(data)\\n\\nThe first item in the returned tuple is a boolean that indicates if the\\nsignature was correct.\\n\\n\\nFallback Signers\\n----------------\\n\\nYou may want to upgrade the signing parameters without invalidating\\nexisting signatures immediately. For example, you may decide that you\\nwant to use a different digest method. New signatures should use the new\\nmethod, but old signatures should still validate.\\n\\nA list of ``fallback_signers`` can be given that will be tried if\\nunsigning with the current signer fails. Each item in the list can be:\\n\\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\\n passed to the serializer.\\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\\n serializer.\\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\\n given class with the given args.\\n\\nFor example, this is a serializer that signs using SHA-512, but will\\nunsign using either SHA-512 or SHA-1:\\n\\n.. code-block:: python\\n\\n s = Serializer(\\n signer_kwargs={\\\"digest_method\\\": hashlib.sha512},\\n fallback_signers=[{\\\"digest_method\\\": hashlib.sha1}]\\n )\\n\\n\\n\\nAPI\\n---\\n\\n.. autoclass:: Serializer\\n :members:\\n\\n[end of docs/serializer.rst]\",\n \"filename\": \"docs/serializer.rst\",\n \"id\": \"18\"\n },\n {\n \"content\": \".. module:: itsdangerous.signer\\n\\nSigning Interface\\n=================\\n\\nThe most basic interface is the signing interface. The :class:`Signer`\\nclass can be used to attach a signature to a specific string:\\n\\n.. code-block:: python\\n\\n from itsdangerous import Signer\\n s = Signer(\\\"secret-key\\\")\\n s.sign(\\\"my string\\\")\\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\\n\\nThe signature is appended to the string, separated by a dot. To validate\\nthe string, use the :meth:`~Signer.unsign` method:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n b'my string'\\n\\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\\nHowever after unsigning you won't be able to tell if it was unicode or\\na bytestring.\\n\\nIf the value is changed, the signature will no longer match, and\\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nTo record and validate the age of a signature, see :doc:`/timed`.\\n\\n.. autoclass:: Signer\\n :members:\\n\\n\\nSigning Algorithms\\n------------------\\n\\n.. autoclass:: NoneAlgorithm\\n\\n.. autoclass:: HMACAlgorithm\\n\\n[end of docs/signer.rst]\",\n \"filename\": \"docs/signer.rst\",\n \"id\": \"19\"\n },\n {\n \"content\": \"General Concepts\\n================\\n\\n\\nSerializer vs Signer\\n--------------------\\n\\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\\nthe basic system that signs a given ``bytes`` value based on the given\\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\\nserializing and signing other data besides ``bytes``.\\n\\nTypically, you'll want to use a serializer, not a signer. You can\\nconfigure the signing parameters through the serializer, and even\\nprovide fallback signers to upgrade old tokens to new parameters.\\n\\n\\nThe Secret Key\\n--------------\\n\\nSignatures are secured by the ``secret_key``. Typically one secret key\\nis used with all signers, and the salt is used to distinguish different\\ncontexts. Changing the secret key will invalidate existing tokens.\\n\\nIt should be a long random string of bytes. This value must be kept\\nsecret and should not be saved in source code or committed to version\\ncontrol. If an attacker learns the secret key, they can change and\\nresign data to look valid. If you suspect this happened, change the\\nsecret key to invalidate existing tokens.\\n\\nOne way to keep the secret key separate is to read it from an\\nenvironment variable. When deploying for the first time, generate a key\\nand set the environment variable when running the application. All\\nprocess managers (like systemd) and hosting services have a way to\\nspecify environment variables.\\n\\n.. code-block:: python\\n\\n import os\\n from itsdangerous.serializer import Serializer\\n SECRET_KEY = os.environ.get(\\\"SECRET_KEY\\\")\\n s = Serializer(SECRET_KEY)\\n\\n.. code-block:: text\\n\\n $ export SECRET_KEY=\\\"base64 encoded random bytes\\\"\\n $ python application.py\\n\\nOne way to generate a key is to use :func:`os.urandom`.\\n\\n.. code-block:: text\\n\\n $ python3 -c 'import os; print(os.urandom(16).hex())'\\n\\n\\nThe Salt\\n--------\\n\\nThe salt is combined with the secret key to derive a unique key for\\ndistinguishing different contexts. Unlike the secret key, the salt\\ndoesn't have to be random, and can be saved in code. It only has to be\\nunique between contexts, not private.\\n\\nFor example, you want to email activation links to activate user\\naccounts, and upgrade links to upgrade users to a paid accounts. If all\\nyou sign is the user id, and you don't use different salts, a user could\\nreuse the token from the activation link to upgrade the account. If you\\nuse different salts, the signatures will be different and will not be\\nvalid in the other context.\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n\\n s1 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"activate\\\")\\n s1.dumps(42)\\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\\n\\n s2 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"upgrade\\\")\\n s2.dumps(42)\\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\\n\\nThe second serializer can't load data dumped with the first because the\\nsalts differ.\\n\\n.. code-block:: python\\n\\n s2.loads(s1.dumps(42))\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nOnly the serializer with the same salt can load the data.\\n\\n.. code-block:: python\\n\\n s2.loads(s2.dumps(42))\\n 42\\n\\n\\nKey Rotation\\n------------\\n\\nKey rotation can provide an extra layer of mitigation against an\\nattacker discovering a secret key. A rotation system will keep a list of\\nvalid keys, generating a new key and removing the oldest key\\nperiodically. If it takes four weeks for an attacker to crack a key, but\\nthe key is rotated out after three weeks, they will not be able to use\\nany keys they crack. However, if a user doesn't refresh their token\\nwithin three weeks it will be invalid too.\\n\\nThe system that generates and maintains this list is outside the scope\\nof ItsDangerous, but ItsDangerous does support validating against a list\\nof keys.\\n\\nInstead of passing a single key, you can pass a list of keys, oldest to\\nnewest. When signing the last (newest) key will be used, and when\\nvalidating each key will be tried from newest to oldest before raising\\na validation error.\\n\\n.. code-block:: python\\n\\n SECRET_KEYS = [\\\"2b9cd98e\\\", \\\"169d7886\\\", \\\"b6af09f5\\\"]\\n\\n # sign some data with the latest key\\n s = Serializer(SECRET_KEYS)\\n t = s.dumps({\\\"id\\\": 42})\\n\\n # rotate a new key in and the oldest key out\\n SECRET_KEYS.append(\\\"cf9b3588\\\")\\n del SECRET_KEYS[0]\\n\\n s = Serializer(SECRET_KEYS)\\n s.loads(t) # valid even though it was signed with a previous key\\n\\n\\nDigest Method Security\\n----------------------\\n\\nA signer is configured with a ``digest_method``, a hash function that\\nis used as an intermediate step when generating the HMAC signature. The\\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\\nconcerned about this default because they have heard about hash\\ncollisions with SHA-1.\\n\\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\\nhash alone doesn't apply when used in HMAC.\\n\\nIf a project considers SHA-1 a risk anyway, they can configure the\\nsigner with a different digest method such as :func:`hashlib.sha512`.\\nA fallback signer for SHA-1 can be configured so that old tokens will be\\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\\nspace, which is relevant in cookies and URLs.\\n\\n[end of docs/concepts.rst]\",\n \"filename\": \"docs/concepts.rst\",\n \"id\": \"20\"\n },\n {\n \"content\": \".. module:: itsdangerous.url_safe\\n\\nURL Safe Serialization\\n======================\\n\\nOften it is helpful if you can pass these trusted strings in places\\nwhere you only have a limited set of characters available. Because of\\nthis, ItsDangerous also provides URL safe serializers:\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\\n s.loads(\\\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\\\")\\n [1, 2, 3, 4]\\n\\n.. autoclass:: URLSafeSerializer\\n\\n.. autoclass:: URLSafeTimedSerializer\\n\\n[end of docs/url_safe.rst]\",\n \"filename\": \"docs/url_safe.rst\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. module:: itsdangerous.encoding\\n\\nEncoding Utilities\\n==================\\n\\n.. autofunction:: base64_encode\\n\\n.. autofunction:: base64_decode\\n\\n[end of docs/encoding.rst]\",\n \"filename\": \"docs/encoding.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"# Minimal makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nSOURCEDIR = .\\nBUILDDIR = _build\\n\\n# Put it first so that \\\"make\\\" without argument is like \\\"make help\\\".\\nhelp:\\n\\t@$(SPHINXBUILD) -M help \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n.PHONY: help Makefile\\n\\n# Catch-all target: route all unknown targets to Sphinx using the new\\n# \\\"make mode\\\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\\n%: Makefile\\n\\t@$(SPHINXBUILD) -M $@ \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"23\"\n },\n {\n \"content\": \"from pallets_sphinx_themes import get_version\\nfrom pallets_sphinx_themes import ProjectLink\\n\\n# Project --------------------------------------------------------------\\n\\nproject = \\\"ItsDangerous\\\"\\ncopyright = \\\"2011 Pallets\\\"\\nauthor = \\\"Pallets\\\"\\nrelease, version = get_version(\\\"itsdangerous\\\")\\n\\n# General --------------------------------------------------------------\\n\\ndefault_role = \\\"code\\\"\\nextensions = [\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"sphinx.ext.extlinks\\\",\\n \\\"sphinx.ext.intersphinx\\\",\\n \\\"sphinxcontrib.log_cabinet\\\",\\n \\\"pallets_sphinx_themes\\\",\\n]\\nautoclass_content = \\\"both\\\"\\nautodoc_member_order = \\\"bysource\\\"\\nautodoc_typehints = \\\"description\\\"\\nautodoc_preserve_defaults = True\\nextlinks = {\\n \\\"issue\\\": (\\\"https://github.com/pallets/itsdangerous/issues/%s\\\", \\\"#%s\\\"),\\n \\\"pr\\\": (\\\"https://github.com/pallets/itsdangerous/pull/%s\\\", \\\"#%s\\\"),\\n}\\nintersphinx_mapping = {\\n \\\"python\\\": (\\\"https://docs.python.org/3/\\\", None),\\n}\\n\\n# HTML -----------------------------------------------------------------\\n\\nhtml_theme = \\\"flask\\\"\\nhtml_theme_options = {\\\"index_sidebar_logo\\\": False}\\nhtml_context = {\\n \\\"project_links\\\": [\\n ProjectLink(\\\"Donate\\\", \\\"https://palletsprojects.com/donate\\\"),\\n ProjectLink(\\\"PyPI Releases\\\", \\\"https://pypi.org/project/itsdangerous/\\\"),\\n ProjectLink(\\\"Source Code\\\", \\\"https://github.com/pallets/itsdangerous/\\\"),\\n ProjectLink(\\\"Issue Tracker\\\", \\\"https://github.com/pallets/itsdangerous/issues/\\\"),\\n ProjectLink(\\\"Chat\\\", \\\"https://discord.gg/pallets\\\"),\\n ]\\n}\\nhtml_sidebars = {\\n \\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n \\\"**\\\": [\\\"localtoc.html\\\", \\\"relations.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n}\\nsinglehtml_sidebars = {\\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"ethicalads.html\\\"]}\\nhtml_static_path = [\\\"_static\\\"]\\nhtml_favicon = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_logo = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_title = f\\\"{project} Documentation ({version})\\\"\\nhtml_show_sourcelink = False\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\npushd %~dp0\\n\\nREM Command file for Sphinx documentation\\n\\nif \\\"%SPHINXBUILD%\\\" == \\\"\\\" (\\n\\tset SPHINXBUILD=sphinx-build\\n)\\nset SOURCEDIR=.\\nset BUILDDIR=_build\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\n%SPHINXBUILD% >NUL 2>NUL\\nif errorlevel 9009 (\\n\\techo.\\n\\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\\n\\techo.installed, then set the SPHINXBUILD environment variable to point\\n\\techo.to the full path of the 'sphinx-build' executable. Alternatively you\\n\\techo.may add the Sphinx directory to PATH.\\n\\techo.\\n\\techo.If you don't have Sphinx installed, grab it from\\n\\techo.http://sphinx-doc.org/\\n\\texit /b 1\\n)\\n\\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\ngoto end\\n\\n:help\\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\n\\n:end\\npopd\\n\\n[end of docs/make.bat]\",\n \"filename\": \"docs/make.bat\",\n \"id\": \"25\"\n },\n {\n \"content\": \".. module:: itsdangerous.timed\\n\\nSigning With Timestamps\\n=======================\\n\\nIf you want to expire signatures you can use the\\n:class:`TimestampSigner` class which adds timestamp information and\\nsigns it. On unsigning you can validate that the timestamp is not older\\nthan a given age.\\n\\n.. code-block:: python\\n\\n from itsdangerous import TimestampSigner\\n s = TimestampSigner('secret-key')\\n string = s.sign('foo')\\n\\n.. code-block:: python\\n\\n s.unsign(string, max_age=5)\\n Traceback (most recent call last):\\n ...\\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\\n\\n.. autoclass:: TimestampSigner\\n :members:\\n\\n.. autoclass:: TimedSerializer\\n :members:\\n\\n[end of docs/timed.rst]\",\n \"filename\": \"docs/timed.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"BSD-3-Clause License\\n====================\\n\\n.. literalinclude:: ../LICENSE.txt\\n :language: text\\n\\n[end of docs/license.rst]\",\n \"filename\": \"docs/license.rst\",\n \"id\": \"27\"\n },\n {\n \"content\": \"Changes\\n=======\\n\\n.. include:: ../CHANGES.rst\\n\\n[end of docs/changes.rst]\",\n \"filename\": \"docs/changes.rst\",\n \"id\": \"28\"\n },\n {\n \"content\": \".. module:: itsdangerous.exc\\n\\nExceptions\\n==========\\n\\n.. autoexception:: BadData\\n :members:\\n\\n.. autoexception:: BadSignature\\n :members:\\n\\n.. autoexception:: BadTimeSignature\\n :members:\\n\\n.. autoexception:: SignatureExpired\\n :members:\\n\\n.. autoexception:: BadHeader\\n :members:\\n\\n.. autoexception:: BadPayload\\n :members:\\n\\n[end of docs/exceptions.rst]\",\n \"filename\": \"docs/exceptions.rst\",\n \"id\": \"29\"\n },\n {\n \"content\": \"#!/bin/bash\\nset -e\\npython3 -m venv --upgrade-deps .venv\\n. .venv/bin/activate\\npip install -r requirements/dev.txt\\npip install -e .\\npre-commit install --install-hooks\\n\\n[end of .devcontainer/on-create-command.sh]\",\n \"filename\": \".devcontainer/on-create-command.sh\",\n \"id\": \"30\"\n },\n {\n \"content\": \"{\\n \\\"name\\\": \\\"pallets/itsdangerous\\\",\\n \\\"image\\\": \\\"mcr.microsoft.com/devcontainers/python:3\\\",\\n \\\"customizations\\\": {\\n \\\"vscode\\\": {\\n \\\"settings\\\": {\\n \\\"python.defaultInterpreterPath\\\": \\\"${workspaceFolder}/.venv\\\",\\n \\\"python.terminal.activateEnvInCurrentTerminal\\\": true,\\n \\\"python.terminal.launchArgs\\\": [\\n \\\"-X\\\",\\n \\\"dev\\\"\\n ]\\n }\\n }\\n },\\n \\\"onCreateCommand\\\": \\\".devcontainer/on-create-command.sh\\\"\\n}\\n\\n[end of .devcontainer/devcontainer.json]\",\n \"filename\": \".devcontainer/devcontainer.json\",\n \"id\": \"31\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo-sidebar.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo-sidebar.png\",\n \"id\": \"32\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo.png\",\n \"id\": \"33\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport json as _json\\nimport typing as t\\n\\n\\nclass _CompactJSON:\\n \\\"\\\"\\\"Wrapper around json module that strips whitespace.\\\"\\\"\\\"\\n\\n @staticmethod\\n def loads(payload: str | bytes) -> t.Any:\\n return _json.loads(payload)\\n\\n @staticmethod\\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\\n kwargs.setdefault(\\\"ensure_ascii\\\", False)\\n kwargs.setdefault(\\\"separators\\\", (\\\",\\\", \\\":\\\"))\\n return _json.dumps(obj, **kwargs)\\n\\n[end of src/itsdangerous/_json.py]\",\n \"filename\": \"src/itsdangerous/_json.py\",\n \"id\": \"34\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport time\\nimport typing as t\\nfrom datetime import datetime\\nfrom datetime import timezone\\n\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import bytes_to_int\\nfrom .encoding import int_to_bytes\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\nfrom .exc import BadTimeSignature\\nfrom .exc import SignatureExpired\\nfrom .serializer import _TSerialized\\nfrom .serializer import Serializer\\nfrom .signer import Signer\\n\\n\\nclass TimestampSigner(Signer):\\n \\\"\\\"\\\"Works like the regular :class:`.Signer` but also records the time\\n of the signing and can be used to expire signatures. The\\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\\n unsigning failed because the signature is expired.\\n \\\"\\\"\\\"\\n\\n def get_timestamp(self) -> int:\\n \\\"\\\"\\\"Returns the current timestamp. The function must return an\\n integer.\\n \\\"\\\"\\\"\\n return int(time.time())\\n\\n def timestamp_to_datetime(self, ts: int) -> datetime:\\n \\\"\\\"\\\"Convert the timestamp from :meth:`get_timestamp` into an\\n aware :class`datetime.datetime` in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n return datetime.fromtimestamp(ts, tz=timezone.utc)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string and also attaches time information.\\\"\\\"\\\"\\n value = want_bytes(value)\\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\\n sep = want_bytes(self.sep)\\n value = value + sep + timestamp\\n return value + sep + self.get_signature(value)\\n\\n # Ignore overlapping signatures check, return_timestamp is the only\\n # parameter that affects the return type.\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[False] = False,\\n ) -> bytes: ...\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[True] = True,\\n ) -> tuple[bytes, datetime]: ...\\n\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n ) -> tuple[bytes, datetime] | bytes:\\n \\\"\\\"\\\"Works like the regular :meth:`.Signer.unsign` but can also\\n validate the time. See the base docstring of the class for\\n the general behavior. If ``return_timestamp`` is ``True`` the\\n timestamp of the signature will be returned as an aware\\n :class:`datetime.datetime` object in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n try:\\n result = super().unsign(signed_value)\\n sig_error = None\\n except BadSignature as e:\\n sig_error = e\\n result = e.payload or b\\\"\\\"\\n\\n sep = want_bytes(self.sep)\\n\\n # If there is no timestamp in the result there is something\\n # seriously wrong. In case there was a signature error, we raise\\n # that one directly, otherwise we have a weird situation in\\n # which we shouldn't have come except someone uses a time-based\\n # serializer on non-timestamp data, so catch that.\\n if sep not in result:\\n if sig_error:\\n raise sig_error\\n\\n raise BadTimeSignature(\\\"timestamp missing\\\", payload=result)\\n\\n value, ts_bytes = result.rsplit(sep, 1)\\n ts_int: int | None = None\\n ts_dt: datetime | None = None\\n\\n try:\\n ts_int = bytes_to_int(base64_decode(ts_bytes))\\n except Exception:\\n pass\\n\\n # Signature is *not* okay. Raise a proper error now that we have\\n # split the value and the timestamp.\\n if sig_error is not None:\\n if ts_int is not None:\\n try:\\n ts_dt = self.timestamp_to_datetime(ts_int)\\n except (ValueError, OSError, OverflowError) as exc:\\n # Windows raises OSError\\n # 32-bit raises OverflowError\\n raise BadTimeSignature(\\n \\\"Malformed timestamp\\\", payload=value\\n ) from exc\\n\\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\\n\\n # Signature was okay but the timestamp is actually not there or\\n # malformed. Should not happen, but we handle it anyway.\\n if ts_int is None:\\n raise BadTimeSignature(\\\"Malformed timestamp\\\", payload=value)\\n\\n # Check timestamp is not older than max_age\\n if max_age is not None:\\n age = self.get_timestamp() - ts_int\\n\\n if age > max_age:\\n raise SignatureExpired(\\n f\\\"Signature age {age} > {max_age} seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if age < 0:\\n raise SignatureExpired(\\n f\\\"Signature age {age} < 0 seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if return_timestamp:\\n return value, self.timestamp_to_datetime(ts_int)\\n\\n return value\\n\\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\\"\\\"\\\"\\n try:\\n self.unsign(signed_value, max_age=max_age)\\n return True\\n except BadSignature:\\n return False\\n\\n\\nclass TimedSerializer(Serializer[_TSerialized]):\\n \\\"\\\"\\\"Uses :class:`TimestampSigner` instead of the default\\n :class:`.Signer`.\\n \\\"\\\"\\\"\\n\\n default_signer: type[TimestampSigner] = TimestampSigner\\n\\n def iter_unsigners(\\n self, salt: str | bytes | None = None\\n ) -> cabc.Iterator[TimestampSigner]:\\n return t.cast(\\\"cabc.Iterator[TimestampSigner]\\\", super().iter_unsigners(salt))\\n\\n # TODO: Signature is incompatible because parameters were added\\n # before salt.\\n\\n def loads( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n salt: str | bytes | None = None,\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\\n signature validation fails. If a ``max_age`` is provided it will\\n ensure the signature is not older than that time in seconds. In\\n case the signature is outdated, :exc:`.SignatureExpired` is\\n raised. All arguments are forwarded to the signer's\\n :meth:`~TimestampSigner.unsign` method.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n base64d, timestamp = signer.unsign(\\n s, max_age=max_age, return_timestamp=True\\n )\\n payload = self.load_payload(base64d)\\n\\n if return_timestamp:\\n return payload, timestamp\\n\\n return payload\\n except SignatureExpired:\\n # The signature was unsigned successfully but was\\n # expired. Do not try the next signer.\\n raise\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def loads_unsafe( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n salt: str | bytes | None = None,\\n ) -> tuple[bool, t.Any]:\\n return self._loads_unsafe_impl(s, salt, load_kwargs={\\\"max_age\\\": max_age})\\n\\n[end of src/itsdangerous/timed.py]\",\n \"filename\": \"src/itsdangerous/timed.py\",\n \"id\": \"35\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport base64\\nimport string\\nimport struct\\nimport typing as t\\n\\nfrom .exc import BadData\\n\\n\\ndef want_bytes(\\n s: str | bytes, encoding: str = \\\"utf-8\\\", errors: str = \\\"strict\\\"\\n) -> bytes:\\n if isinstance(s, str):\\n s = s.encode(encoding, errors)\\n\\n return s\\n\\n\\ndef base64_encode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 encode a string of bytes or text. The resulting bytes are\\n safe to use in URLs.\\n \\\"\\\"\\\"\\n string = want_bytes(string)\\n return base64.urlsafe_b64encode(string).rstrip(b\\\"=\\\")\\n\\n\\ndef base64_decode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 decode a URL-safe string of bytes or text. The result is\\n bytes.\\n \\\"\\\"\\\"\\n string = want_bytes(string, encoding=\\\"ascii\\\", errors=\\\"ignore\\\")\\n string += b\\\"=\\\" * (-len(string) % 4)\\n\\n try:\\n return base64.urlsafe_b64decode(string)\\n except (TypeError, ValueError) as e:\\n raise BadData(\\\"Invalid base64-encoded data\\\") from e\\n\\n\\n# The alphabet used by base64.urlsafe_*\\n_base64_alphabet = f\\\"{string.ascii_letters}{string.digits}-_=\\\".encode(\\\"ascii\\\")\\n\\n_int64_struct = struct.Struct(\\\">Q\\\")\\n_int_to_bytes = _int64_struct.pack\\n_bytes_to_int = t.cast(\\\"t.Callable[[bytes], tuple[int]]\\\", _int64_struct.unpack)\\n\\n\\ndef int_to_bytes(num: int) -> bytes:\\n return _int_to_bytes(num).lstrip(b\\\"\\\\x00\\\")\\n\\n\\ndef bytes_to_int(bytestr: bytes) -> int:\\n return _bytes_to_int(bytestr.rjust(8, b\\\"\\\\x00\\\"))[0]\\n\\n[end of src/itsdangerous/encoding.py]\",\n \"filename\": \"src/itsdangerous/encoding.py\",\n \"id\": \"36\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\n\\nfrom .encoding import base64_decode as base64_decode\\nfrom .encoding import base64_encode as base64_encode\\nfrom .encoding import want_bytes as want_bytes\\nfrom .exc import BadData as BadData\\nfrom .exc import BadHeader as BadHeader\\nfrom .exc import BadPayload as BadPayload\\nfrom .exc import BadSignature as BadSignature\\nfrom .exc import BadTimeSignature as BadTimeSignature\\nfrom .exc import SignatureExpired as SignatureExpired\\nfrom .serializer import Serializer as Serializer\\nfrom .signer import HMACAlgorithm as HMACAlgorithm\\nfrom .signer import NoneAlgorithm as NoneAlgorithm\\nfrom .signer import Signer as Signer\\nfrom .timed import TimedSerializer as TimedSerializer\\nfrom .timed import TimestampSigner as TimestampSigner\\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\\n\\n\\ndef __getattr__(name: str) -> t.Any:\\n if name == \\\"__version__\\\":\\n import importlib.metadata\\n import warnings\\n\\n warnings.warn(\\n \\\"The '__version__' attribute is deprecated and will be removed in\\\"\\n \\\" ItsDangerous 2.3. Use feature detection or\\\"\\n \\\" 'importlib.metadata.version(\\\\\\\"itsdangerous\\\\\\\")' instead.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return importlib.metadata.version(\\\"itsdangerous\\\")\\n\\n raise AttributeError(name)\\n\\n[end of src/itsdangerous/__init__.py]\",\n \"filename\": \"src/itsdangerous/__init__.py\",\n \"id\": \"37\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nimport zlib\\n\\nfrom ._json import _CompactJSON\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .exc import BadPayload\\nfrom .serializer import _PDataSerializer\\nfrom .serializer import Serializer\\nfrom .timed import TimedSerializer\\n\\n\\nclass URLSafeSerializerMixin(Serializer[str]):\\n \\\"\\\"\\\"Mixed in with a regular serializer it will attempt to zlib\\n compress the string to make it shorter if necessary. It will also\\n base64 encode the string so that it can safely be placed in a URL.\\n \\\"\\\"\\\"\\n\\n default_serializer: _PDataSerializer[str] = _CompactJSON\\n\\n def load_payload(\\n self,\\n payload: bytes,\\n *args: t.Any,\\n serializer: t.Any | None = None,\\n **kwargs: t.Any,\\n ) -> t.Any:\\n decompress = False\\n\\n if payload.startswith(b\\\".\\\"):\\n payload = payload[1:]\\n decompress = True\\n\\n try:\\n json = base64_decode(payload)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not base64 decode the payload because of an exception\\\",\\n original_error=e,\\n ) from e\\n\\n if decompress:\\n try:\\n json = zlib.decompress(json)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not zlib decompress the payload before decoding the payload\\\",\\n original_error=e,\\n ) from e\\n\\n return super().load_payload(json, *args, **kwargs)\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n json = super().dump_payload(obj)\\n is_compressed = False\\n compressed = zlib.compress(json)\\n\\n if len(compressed) < (len(json) - 1):\\n json = compressed\\n is_compressed = True\\n\\n base64d = base64_encode(json)\\n\\n if is_compressed:\\n base64d = b\\\".\\\" + base64d\\n\\n return base64d\\n\\n\\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\\n \\\"\\\"\\\"Works like :class:`.Serializer` but dumps and loads into a URL\\n safe string consisting of the upper and lowercase character of the\\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n\\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\\n \\\"\\\"\\\"Works like :class:`.TimedSerializer` but dumps and loads into a\\n URL safe string consisting of the upper and lowercase character of\\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n[end of src/itsdangerous/url_safe.py]\",\n \"filename\": \"src/itsdangerous/url_safe.py\",\n \"id\": \"38\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nfrom datetime import datetime\\n\\n\\nclass BadData(Exception):\\n \\\"\\\"\\\"Raised if bad data of any sort was encountered. This is the base\\n for all exceptions that ItsDangerous defines.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str):\\n super().__init__(message)\\n self.message = message\\n\\n def __str__(self) -> str:\\n return self.message\\n\\n\\nclass BadSignature(BadData):\\n \\\"\\\"\\\"Raised if a signature does not match.\\\"\\\"\\\"\\n\\n def __init__(self, message: str, payload: t.Any | None = None):\\n super().__init__(message)\\n\\n #: The payload that failed the signature test. In some\\n #: situations you might still want to inspect this, even if\\n #: you know it was tampered with.\\n #:\\n #: .. versionadded:: 0.14\\n self.payload: t.Any | None = payload\\n\\n\\nclass BadTimeSignature(BadSignature):\\n \\\"\\\"\\\"Raised if a time-based signature is invalid. This is a subclass\\n of :class:`BadSignature`.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n date_signed: datetime | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the signature expired this exposes the date of when the\\n #: signature was created. This can be helpful in order to\\n #: tell the user how long a link has been gone stale.\\n #:\\n #: .. versionchanged:: 2.0\\n #: The datetime value is timezone-aware rather than naive.\\n #:\\n #: .. versionadded:: 0.14\\n self.date_signed = date_signed\\n\\n\\nclass SignatureExpired(BadTimeSignature):\\n \\\"\\\"\\\"Raised if a signature timestamp is older than ``max_age``. This\\n is a subclass of :exc:`BadTimeSignature`.\\n \\\"\\\"\\\"\\n\\n\\nclass BadHeader(BadSignature):\\n \\\"\\\"\\\"Raised if a signed header is invalid in some form. This only\\n happens for serializers that have a header that goes with the\\n signature.\\n\\n .. versionadded:: 0.24\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n header: t.Any | None = None,\\n original_error: Exception | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the header is actually available but just malformed it\\n #: might be stored here.\\n self.header: t.Any | None = header\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n\\nclass BadPayload(BadData):\\n \\\"\\\"\\\"Raised if a payload is invalid. This could happen if the payload\\n is loaded despite an invalid signature, or if there is a mismatch\\n between the serializer and deserializer. The original exception\\n that occurred during loading is stored on as :attr:`original_error`.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str, original_error: Exception | None = None):\\n super().__init__(message)\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n[end of src/itsdangerous/exc.py]\",\n \"filename\": \"src/itsdangerous/exc.py\",\n \"id\": \"39\"\n },\n {\n \"content\": \"[end of src/itsdangerous/py.typed]\",\n \"filename\": \"src/itsdangerous/py.typed\",\n \"id\": \"40\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport json\\nimport typing as t\\n\\nfrom .encoding import want_bytes\\nfrom .exc import BadPayload\\nfrom .exc import BadSignature\\nfrom .signer import _make_keys_list\\nfrom .signer import Signer\\n\\nif t.TYPE_CHECKING:\\n import typing_extensions as te\\n\\n # This should be either be str or bytes. To avoid having to specify the\\n # bound type, it falls back to a union if structural matching fails.\\n _TSerialized = te.TypeVar(\\n \\\"_TSerialized\\\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\\n )\\nelse:\\n # Still available at runtime on Python < 3.13, but without the default.\\n _TSerialized = t.TypeVar(\\\"_TSerialized\\\", bound=t.Union[str, bytes])\\n\\n\\nclass _PDataSerializer(t.Protocol[_TSerialized]):\\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\\n # A signature with additional arguments is not handled correctly by type\\n # checkers right now, so an overload is used below for serializers that\\n # don't match this strict protocol.\\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\\n\\n\\n# Use TypeIs once it's available in typing_extensions or 3.13.\\ndef is_text_serializer(\\n serializer: _PDataSerializer[t.Any],\\n) -> te.TypeGuard[_PDataSerializer[str]]:\\n \\\"\\\"\\\"Checks whether a serializer generates text or binary.\\\"\\\"\\\"\\n return isinstance(serializer.dumps({}), str)\\n\\n\\nclass Serializer(t.Generic[_TSerialized]):\\n \\\"\\\"\\\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\\n enable serializing and securely signing data other than bytes. It\\n can unsign to verify that the data hasn't been changed.\\n\\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\\n :mod:`json`, and by default uses :mod:`json` internally to serialize\\n the data to bytes.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param serializer: An object that provides ``dumps`` and ``loads``\\n methods for serializing data to a string. Defaults to\\n :attr:`default_serializer`, which defaults to :mod:`json`.\\n :param serializer_kwargs: Keyword arguments to pass when calling\\n ``serializer.dumps``.\\n :param signer: A ``Signer`` class to instantiate when signing data.\\n Defaults to :attr:`default_signer`, which defaults to\\n :class:`~itsdangerous.signer.Signer`.\\n :param signer_kwargs: Keyword arguments to pass when instantiating\\n the ``Signer`` class.\\n :param fallback_signers: List of signer parameters to try when\\n unsigning with the default signer fails. Each item can be a dict\\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\\n ``(signer, signer_kwargs)``. Defaults to\\n :attr:`default_fallback_signers`.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 2.0\\n Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``.\\n\\n .. versionchanged:: 1.1\\n Added support for ``fallback_signers`` and configured a default\\n SHA-512 fallback. This fallback is for users who used the yanked\\n 1.0.0 release which defaulted to SHA-512.\\n\\n .. versionchanged:: 0.14\\n The ``signer`` and ``signer_kwargs`` parameters were added to\\n the constructor.\\n \\\"\\\"\\\"\\n\\n #: The default serialization module to use to serialize data to a\\n #: string internally. The default is :mod:`json`, but can be changed\\n #: to any object that provides ``dumps`` and ``loads`` methods.\\n default_serializer: _PDataSerializer[t.Any] = json\\n\\n #: The default ``Signer`` class to instantiate when signing data.\\n #: The default is :class:`itsdangerous.signer.Signer`.\\n default_signer: type[Signer] = Signer\\n\\n #: The default fallback signers to try when unsigning fails.\\n default_fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = []\\n\\n # Serializer[str] if no data serializer is provided, or if it returns str.\\n @t.overload\\n def __init__(\\n self: Serializer[str],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: None | _PDataSerializer[str] = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer positional argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer keyword argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a positional argument. If the strict signature of\\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\\n # to specify the type.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a keyword argument.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: t.Any | None = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n # if salt is None then the signer's default is used\\n\\n self.salt = salt\\n\\n if serializer is None:\\n serializer = self.default_serializer\\n\\n self.serializer: _PDataSerializer[_TSerialized] = serializer\\n self.is_text_serializer: bool = is_text_serializer(serializer)\\n\\n if signer is None:\\n signer = self.default_signer\\n\\n self.signer: type[Signer] = signer\\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\\n\\n if fallback_signers is None:\\n fallback_signers = list(self.default_fallback_signers)\\n\\n self.fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = fallback_signers\\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def load_payload(\\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\\n ) -> t.Any:\\n \\\"\\\"\\\"Loads the encoded object. This function raises\\n :class:`.BadPayload` if the payload is not valid. The\\n ``serializer`` parameter can be used to override the serializer\\n stored on the class. The encoded ``payload`` should always be\\n bytes.\\n \\\"\\\"\\\"\\n if serializer is None:\\n use_serializer = self.serializer\\n is_text = self.is_text_serializer\\n else:\\n use_serializer = serializer\\n is_text = is_text_serializer(serializer)\\n\\n try:\\n if is_text:\\n return use_serializer.loads(payload.decode(\\\"utf-8\\\")) # type: ignore[arg-type]\\n\\n return use_serializer.loads(payload) # type: ignore[arg-type]\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not load the payload because an exception\\\"\\n \\\" occurred on unserializing the data.\\\",\\n original_error=e,\\n ) from e\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n \\\"\\\"\\\"Dumps the encoded object. The return value is always bytes.\\n If the internal serializer returns text, the value will be\\n encoded as UTF-8.\\n \\\"\\\"\\\"\\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\\n\\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\\n \\\"\\\"\\\"Creates a new instance of the signer to be used. The default\\n implementation uses the :class:`.Signer` base class.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\\n\\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\\n \\\"\\\"\\\"Iterates over all signers to be tried for unsigning. Starts\\n with the configured signer, then constructs each signer\\n specified in ``fallback_signers``.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n yield self.make_signer(salt)\\n\\n for fallback in self.fallback_signers:\\n if isinstance(fallback, dict):\\n kwargs = fallback\\n fallback = self.signer\\n elif isinstance(fallback, tuple):\\n fallback, kwargs = fallback\\n else:\\n kwargs = self.signer_kwargs\\n\\n for secret_key in self.secret_keys:\\n yield fallback(secret_key, salt=salt, **kwargs)\\n\\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\\n \\\"\\\"\\\"Returns a signed string serialized with the internal\\n serializer. The return value can be either a byte or unicode\\n string depending on the format of the internal serializer.\\n \\\"\\\"\\\"\\n payload = want_bytes(self.dump_payload(obj))\\n rv = self.make_signer(salt).sign(payload)\\n\\n if self.is_text_serializer:\\n return rv.decode(\\\"utf-8\\\") # type: ignore[return-value]\\n\\n return rv # type: ignore[return-value]\\n\\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\\n \\\"\\\"\\\"Like :meth:`dumps` but dumps into a file. The file handle has\\n to be compatible with what the internal serializer expects.\\n \\\"\\\"\\\"\\n f.write(self.dumps(obj, salt))\\n\\n def loads(\\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\\n signature validation fails.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n return self.load_payload(signer.unsign(s))\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\\n \\\"\\\"\\\"Like :meth:`loads` but loads from a file.\\\"\\\"\\\"\\n return self.loads(f.read(), salt)\\n\\n def loads_unsafe(\\n self, s: str | bytes, salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads` but without verifying the signature. This\\n is potentially very dangerous to use depending on how your\\n serializer works. The return value is ``(signature_valid,\\n payload)`` instead of just the payload. The first item will be a\\n boolean that indicates if the signature is valid. This function\\n never fails.\\n\\n Use it for debugging only and if you know that your serializer\\n module is not exploitable (for example, do not use it with a\\n pickle serializer).\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self._loads_unsafe_impl(s, salt)\\n\\n def _loads_unsafe_impl(\\n self,\\n s: str | bytes,\\n salt: str | bytes | None,\\n load_kwargs: dict[str, t.Any] | None = None,\\n load_payload_kwargs: dict[str, t.Any] | None = None,\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Low level helper function to implement :meth:`loads_unsafe`\\n in serializer subclasses.\\n \\\"\\\"\\\"\\n if load_kwargs is None:\\n load_kwargs = {}\\n\\n try:\\n return True, self.loads(s, salt=salt, **load_kwargs)\\n except BadSignature as e:\\n if e.payload is None:\\n return False, None\\n\\n if load_payload_kwargs is None:\\n load_payload_kwargs = {}\\n\\n try:\\n return (\\n False,\\n self.load_payload(e.payload, **load_payload_kwargs),\\n )\\n except BadPayload:\\n return False, None\\n\\n def load_unsafe(\\n self, f: t.IO[t.Any], salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads_unsafe` but loads from a file.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self.loads_unsafe(f.read(), salt=salt)\\n\\n[end of src/itsdangerous/serializer.py]\",\n \"filename\": \"src/itsdangerous/serializer.py\",\n \"id\": \"41\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport hashlib\\nimport hmac\\nimport typing as t\\n\\nfrom .encoding import _base64_alphabet\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\n\\n\\nclass SigningAlgorithm:\\n \\\"\\\"\\\"Subclasses must implement :meth:`get_signature` to provide\\n signature generation functionality.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given key and value.\\\"\\\"\\\"\\n raise NotImplementedError()\\n\\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\\n \\\"\\\"\\\"Verifies the given signature matches the expected\\n signature.\\n \\\"\\\"\\\"\\n return hmac.compare_digest(sig, self.get_signature(key, value))\\n\\n\\nclass NoneAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides an algorithm that does not perform any signing and\\n returns an empty signature.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n return b\\\"\\\"\\n\\n\\ndef _lazy_sha1(string: bytes = b\\\"\\\") -> t.Any:\\n \\\"\\\"\\\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\\n SHA-1, in which case the import and use as a default would fail before the\\n developer can configure something else.\\n \\\"\\\"\\\"\\n return hashlib.sha1(string)\\n\\n\\nclass HMACAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides signature generation using HMACs.\\\"\\\"\\\"\\n\\n #: The digest method to use with the MAC algorithm. This defaults to\\n #: SHA1, but can be changed to any other function in the hashlib\\n #: module.\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n def __init__(self, digest_method: t.Any = None):\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\\n return mac.digest()\\n\\n\\ndef _make_keys_list(\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n) -> list[bytes]:\\n if isinstance(secret_key, (str, bytes)):\\n return [want_bytes(secret_key)]\\n\\n return [want_bytes(s) for s in secret_key] # pyright: ignore\\n\\n\\nclass Signer:\\n \\\"\\\"\\\"A signer securely signs bytes, then unsigns them to verify that\\n the value hasn't been changed.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param sep: Separator between the signature and value.\\n :param key_derivation: How to derive the signing key from the secret\\n key and salt. Possible values are ``concat``, ``django-concat``,\\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\\n defaults to ``django-concat``.\\n :param digest_method: Hash function to use when generating the HMAC\\n signature. Defaults to :attr:`default_digest_method`, which\\n defaults to :func:`hashlib.sha1`. Note that the security of the\\n hash alone doesn't apply when used intermediately in HMAC.\\n :param algorithm: A :class:`SigningAlgorithm` instance to use\\n instead of building a default :class:`HMACAlgorithm` with the\\n ``digest_method``.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 0.18\\n ``algorithm`` was added as an argument to the class constructor.\\n\\n .. versionchanged:: 0.14\\n ``key_derivation`` and ``digest_method`` were added as arguments\\n to the class constructor.\\n \\\"\\\"\\\"\\n\\n #: The default digest method to use for the signer. The default is\\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\\n #: compatible object. Note that the security of the hash alone\\n #: doesn't apply when used intermediately in HMAC.\\n #:\\n #: .. versionadded:: 0.14\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n #: The default scheme to use to derive the signing key from the\\n #: secret key and salt. The default is ``django-concat``. Possible\\n #: values are ``concat``, ``django-concat``, and ``hmac``.\\n #:\\n #: .. versionadded:: 0.14\\n default_key_derivation: str = \\\"django-concat\\\"\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous.Signer\\\",\\n sep: str | bytes = b\\\".\\\",\\n key_derivation: str | None = None,\\n digest_method: t.Any | None = None,\\n algorithm: SigningAlgorithm | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n self.sep: bytes = want_bytes(sep)\\n\\n if self.sep in _base64_alphabet:\\n raise ValueError(\\n \\\"The given separator cannot be used because it may be\\\"\\n \\\" contained in the signature itself. ASCII letters,\\\"\\n \\\" digits, and '-_=' must not be used.\\\"\\n )\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n else:\\n salt = b\\\"itsdangerous.Signer\\\"\\n\\n self.salt = salt\\n\\n if key_derivation is None:\\n key_derivation = self.default_key_derivation\\n\\n self.key_derivation: str = key_derivation\\n\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n if algorithm is None:\\n algorithm = HMACAlgorithm(self.digest_method)\\n\\n self.algorithm: SigningAlgorithm = algorithm\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\\n \\\"\\\"\\\"This method is called to derive the key. The default key\\n derivation choices can be overridden here. Key derivation is not\\n intended to be used as a security method to make a complex key\\n out of a short password. Instead you should use large random\\n secret keys.\\n\\n :param secret_key: A specific secret key to derive from.\\n Defaults to the last item in :attr:`secret_keys`.\\n\\n .. versionchanged:: 2.0\\n Added the ``secret_key`` parameter.\\n \\\"\\\"\\\"\\n if secret_key is None:\\n secret_key = self.secret_keys[-1]\\n else:\\n secret_key = want_bytes(secret_key)\\n\\n if self.key_derivation == \\\"concat\\\":\\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\\n elif self.key_derivation == \\\"django-concat\\\":\\n return t.cast(\\n bytes, self.digest_method(self.salt + b\\\"signer\\\" + secret_key).digest()\\n )\\n elif self.key_derivation == \\\"hmac\\\":\\n mac = hmac.new(secret_key, digestmod=self.digest_method)\\n mac.update(self.salt)\\n return mac.digest()\\n elif self.key_derivation == \\\"none\\\":\\n return secret_key\\n else:\\n raise TypeError(\\\"Unknown key derivation method\\\")\\n\\n def get_signature(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given value.\\\"\\\"\\\"\\n value = want_bytes(value)\\n key = self.derive_key()\\n sig = self.algorithm.get_signature(key, value)\\n return base64_encode(sig)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string.\\\"\\\"\\\"\\n value = want_bytes(value)\\n return value + self.sep + self.get_signature(value)\\n\\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\\n \\\"\\\"\\\"Verifies the signature for the given value.\\\"\\\"\\\"\\n try:\\n sig = base64_decode(sig)\\n except Exception:\\n return False\\n\\n value = want_bytes(value)\\n\\n for secret_key in reversed(self.secret_keys):\\n key = self.derive_key(secret_key)\\n\\n if self.algorithm.verify_signature(key, value, sig):\\n return True\\n\\n return False\\n\\n def unsign(self, signed_value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Unsigns the given string.\\\"\\\"\\\"\\n signed_value = want_bytes(signed_value)\\n\\n if self.sep not in signed_value:\\n raise BadSignature(f\\\"No {self.sep!r} found in value\\\")\\n\\n value, sig = signed_value.rsplit(self.sep, 1)\\n\\n if self.verify_signature(value, sig):\\n return value\\n\\n raise BadSignature(f\\\"Signature {sig!r} does not match\\\", payload=value)\\n\\n def validate(self, signed_value: str | bytes) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\n \\\"\\\"\\\"\\n try:\\n self.unsign(signed_value)\\n return True\\n except BadSignature:\\n return False\\n\\n[end of src/itsdangerous/signer.py]\",\n \"filename\": \"src/itsdangerous/signer.py\",\n \"id\": \"42\"\n }\n]","isConversational":false}}},{"rowIdx":78,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 78,\n \"num_files\": 43,\n \"repo_id\": \"repo_0078\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerous itself. Use\none of the following resources for questions about using ItsDangerous or\nissues with your own code:\n\n- The ``#get-help`` channel on our Discord chat:\n https://discord.gg/pallets\n- The mailing list flask@python.org for long term discussion or larger\n issues.\n- Ask on `Stack Overflow`_. Search with Google first using:\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\n\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\n\n\nReporting issues\n----------------\n\nInclude the following information in your post:\n\n- Describe what you expected to happen.\n- If possible, include a `minimal reproducible example`_ to help us\n identify the issue. This also helps check that the issue is not with\n your own code.\n- Describe what actually happened. Include the full traceback if there\n was an exception.\n- List your Python and ItsDangerous versions. If possible, check if\n this issue is already fixed in the latest releases or the latest\n code in the repository.\n\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\n\n\nSubmitting patches\n------------------\n\nIf there is not an open issue for what you want to submit, prefer\nopening one for discussion before working on a PR. You can work on any\nissue that doesn't have an open PR linked to it or a maintainer assigned\nto it. These show up in the sidebar. No need to ask if you can work on\nan issue that interests you.\n\nInclude the following in your patch:\n\n- Use `Black`_ to format your code. This and other tools will run\n automatically if you install `pre-commit`_ using the instructions\n below.\n- Include tests if your patch adds or changes code. Make sure the test\n fails without your patch.\n- Update any relevant docs pages and docstrings. Docs pages and\n docstrings should be wrapped at 72 characters.\n- Add an entry in ``CHANGES.rst``. Use the same style as other\n entries. Also include ``.. versionchanged::`` inline changelogs in\n relevant docstrings.\n\n.. _Black: https://black.readthedocs.io\n.. _pre-commit: https://pre-commit.com\n\n\nFirst time setup\n~~~~~~~~~~~~~~~~\n\n- Download and install the `latest version of git`_.\n- Configure git with your `username`_ and `email`_.\n\n .. code-block:: text\n\n $ git config --global user.name 'your name'\n $ git config --global user.email 'your email'\n\n- Make sure you have a `GitHub account`_.\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\n button.\n- `Clone`_ the main repository locally.\n\n .. code-block:: text\n\n $ git clone https://github.com/pallets/itsdangerous\n $ cd itsdangerous\n\n- Add your fork as a remote to push your work to. Replace\n ``{username}`` with your username. This names the remote \"fork\", the\n default Pallets remote is \"origin\".\n\n .. code-block:: text\n\n $ git remote add fork https://github.com/{username}/itsdangerous\n\n- Create a virtualenv.\n\n .. code-block:: text\n\n $ python3 -m venv env\n $ . env/bin/activate\n\n On Windows, activating is different.\n\n .. code-block:: text\n\n > env\\Scripts\\activate\n\n- Install the development dependencies, then install ItsDangerous in\n editable mode.\n\n .. code-block:: text\n\n $ pip install -r requirements/dev.txt && pip install -e .\n\n- Install the pre-commit hooks.\n\n .. code-block:: text\n\n $ pre-commit install\n\n.. _latest version of git: https://git-scm.com/downloads\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\n.. _GitHub account: https://github.com/join\n.. _Fork: https://github.com/pallets/itsdangerous/fork\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\n\n\nStart coding\n~~~~~~~~~~~~\n\n- Create a branch to identify the issue you would like to work on. If\n you're submitting a bug or documentation fix, branch off of the\n latest \".x\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/2.0.x\n\n If you're submitting a feature addition or change, branch off of the\n \"main\" branch.\n\n .. code-block:: text\n\n $ git fetch origin\n $ git checkout -b your-branch-name origin/main\n\n- Using your favorite editor, make your changes,\n `committing as you go`_.\n- Include tests that cover any code changes you make. Make sure the\n test fails without your patch. Run the tests as described below.\n- Push your commits to your fork on GitHub and\n `create a pull request`_. Link to the issue being addressed with\n ``fixes #123`` in the pull request.\n\n .. code-block:: text\n\n $ git push --set-upstream fork your-branch-name\n\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\n\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nRun the basic test suite with pytest.\n\n.. code-block:: text\n\n $ pytest\n\nThis runs the tests for the current environment, which is usually\nsufficient. CI will run the full suite when you submit your pull\nrequest. You can run the full test suite with tox if you don't want to\nwait.\n\n.. code-block:: text\n\n $ tox\n\n\nRunning test coverage\n~~~~~~~~~~~~~~~~~~~~~\n\nGenerating a report of lines that do not have test coverage can indicate\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\ngenerate a report.\n\n.. code-block:: text\n\n $ pip install coverage\n $ coverage run -m pytest\n $ coverage html\n\nOpen ``htmlcov/index.html`` in your browser to explore the report.\n\nRead more about `coverage <https://coverage.readthedocs.io>`__.\n\n\nBuilding the docs\n~~~~~~~~~~~~~~~~~\n\nBuild the docs in the ``docs`` directory using Sphinx.\n\n.. code-block:: text\n\n $ cd docs\n $ make html\n\nOpen ``_build/html/index.html`` in your browser to view the docs.\n\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\n\n[end of CONTRIBUTING.rst]","filename":"CONTRIBUTING.rst","id":"0"},{"content":"repos:\n - repo: https://github.com/astral-sh/ruff-pre-commit\n rev: v0.7.1\n hooks:\n - id: ruff\n - id: ruff-format\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v5.0.0\n hooks:\n - id: check-merge-conflict\n - id: debug-statements\n - id: fix-byte-order-marker\n - id: trailing-whitespace\n - id: end-of-file-fixer\n\n[end of .pre-commit-config.yaml]","filename":".pre-commit-config.yaml","id":"1"},{"content":"[project]\nname = \"itsdangerous\"\nversion = \"2.2.0\"\ndescription = \"Safely pass data to untrusted environments and back.\"\nreadme = \"README.md\"\nlicense = { file = \"LICENSE.txt\" }\nmaintainers = [{ name = \"Pallets\", email = \"contact@palletsprojects.com\" }]\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: BSD License\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python\",\n \"Typing :: Typed\",\n]\nrequires-python = \">=3.8\"\n\n[project.urls]\nDonate = \"https://palletsprojects.com/donate\"\nDocumentation = \"https://itsdangerous.palletsprojects.com/\"\nChanges = \"https://itsdangerous.palletsprojects.com/changes/\"\nSource = \"https://github.com/pallets/itsdangerous/\"\nChat = \"https://discord.gg/pallets\"\n\n[build-system]\nrequires = [\"flit_core<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.module]\nname = \"itsdangerous\"\n\n[tool.flit.sdist]\ninclude = [\n \"docs/\",\n \"requirements/\",\n \"tests/\",\n \"CHANGES.rst\",\n \"tox.ini\",\n]\nexclude = [\n \"docs/_build/\",\n]\n\n[tool.pytest.ini_options]\ntestpaths = [\"tests\"]\nfilterwarnings = [\n \"error\",\n]\n\n[tool.coverage.run]\nbranch = true\nsource = [\"itsdangerous\", \"tests\"]\n\n[tool.coverage.paths]\nsource = [\"src\", \"*/site-packages\"]\n\n[tool.mypy]\npython_version = \"3.8\"\nfiles = [\"src/itsdangerous\"]\nshow_error_codes = true\npretty = true\nstrict = true\n\n[tool.pyright]\npythonVersion = \"3.8\"\ninclude = [\"src/itsdangerous\"]\ntypeCheckingMode = \"basic\"\n\n[tool.ruff]\nsrc = [\"src\"]\nfix = true\nshow-fixes = true\noutput-format = \"full\"\n\n[tool.ruff.lint]\nselect = [\n \"B\", # flake8-bugbear\n \"E\", # pycodestyle error\n \"F\", # pyflakes\n \"I\", # isort\n \"UP\", # pyupgrade\n \"W\", # pycodestyle warning\n]\n\n[tool.ruff.lint.isort]\nforce-single-line = true\norder-by-type = false\n\n[tool.gha-update]\ntag-only = [\n \"slsa-framework/slsa-github-generator\",\n]\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"root = true\n\n[*]\nindent_style = space\nindent_size = 4\ninsert_final_newline = true\ntrim_trailing_whitespace = true\nend_of_line = lf\ncharset = utf-8\nmax_line_length = 88\n\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\nindent_size = 2\n\n[end of .editorconfig]","filename":".editorconfig","id":"3"},{"content":"# ItsDangerous\n\n... so better sign this\n\nVarious helpers to pass data to untrusted environments and to get it\nback safe and sound. Data is cryptographically signed to ensure that a\ntoken has not been tampered with.\n\nIt's possible to customize how data is serialized. Data is compressed as\nneeded. A timestamp can be added and verified automatically while\nloading a token.\n\n\n## A Simple Example\n\nHere's how you could generate a token for transmitting a user's id and\nname between web requests.\n\n```python\nfrom itsdangerous import URLSafeSerializer\nauth_s = URLSafeSerializer(\"secret key\", \"auth\")\ntoken = auth_s.dumps({\"id\": 5, \"name\": \"itsdangerous\"})\n\nprint(token)\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\n\ndata = auth_s.loads(token)\nprint(data[\"name\"])\n# itsdangerous\n```\n\n\n## Donate\n\nThe Pallets organization develops and supports ItsDangerous and other\npopular packages. In order to grow the community of contributors and\nusers, and allow the maintainers to devote more time to the projects,\n[please donate today][].\n\n[please donate today]: https://palletsprojects.com/donate\n\n[end of README.md]","filename":"README.md","id":"4"},{"content":"[tox]\nenvlist =\n py3{13,12,11,10,9,8}\n pypy310\n style\n typing\n docs\nskip_missing_interpreters = true\n\n[testenv]\npackage = wheel\nwheel_build_env = .pkg\nconstrain_package_deps = true\nuse_frozen_constraints = true\ndeps = -r requirements/tests.txt\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\n\n[testenv:style]\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit run --all-files\n\n[testenv:typing]\ndeps = -r requirements/typing.txt\ncommands =\n mypy\n pyright\n pyright --verifytypes itsdangerous --ignoreexternal\n\n[testenv:docs]\ndeps = -r requirements/docs.txt\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\n\n[testenv:update-actions]\nlabels = update\ndeps = gha-update\ncommands = gha-update\n\n[testenv:update-pre_commit]\nlabels = update\ndeps = pre-commit\nskip_install = true\ncommands = pre-commit autoupdate -j4\n\n[testenv:update-requirements]\nlabels = update\ndeps = pip-tools\nskip_install = true\nchange_dir = requirements\ncommands =\n pip-compile build.in -q {posargs:-U}\n pip-compile docs.in -q {posargs:-U}\n pip-compile tests.in -q {posargs:-U}\n pip-compile typing.in -q {posargs:-U}\n pip-compile dev.in -q {posargs:-U}\n\n[end of tox.ini]","filename":"tox.ini","id":"5"},{"content":"Copyright 2011 Pallets\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n1. Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n2. 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\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[end of LICENSE.txt]","filename":"LICENSE.txt","id":"6"},{"content":"Version 2.2.0\n-------------\n\nReleased 2024-04-16\n\n- Drop support for Python 3.7. :pr:`372`\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\n :pr:`326`\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\n- Deprecate the ``__version__`` attribute. Use feature detection, or\n ``importlib.metadata.version(\"itsdangerous\")``, instead. :issue:`371`\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\n different ``serializer`` argument is given, it will try to infer the return\n type of its ``dumps`` method. :issue:`347`\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\n access it at import time so the developer has time to change the default.\n :issue:`375`\n\n\nVersion 2.1.2\n-------------\n\nReleased 2022-03-24\n\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\n\n\nVersion 2.1.1\n-------------\n\nReleased 2022-03-09\n\n- Handle date overflow in timed unsign. :pr:`296`\n\n\nVersion 2.1.0\n-------------\n\nReleased 2022-02-17\n\n- Drop support for Python 3.6. :pr:`272`\n- Remove previously deprecated code. :pr:`273`\n\n - JWS functionality: Use a dedicated library such as Authlib\n instead.\n - ``import itsdangerous.json``: Import ``json`` from the standard\n library instead.\n\n\nVersion 2.0.1\n-------------\n\nReleased 2021-05-18\n\n- Mark top-level names as exported so type checking understands\n imports in user projects. :pr:`240`\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\n ``None`` again. :issue:`237`\n\n\nVersion 2.0.0\n-------------\n\nReleased 2021-05-11\n\n- Drop support for Python 2 and 3.5.\n- JWS support (``JSONWebSignatureSerializer``,\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\n JWS/JWT library such as authlib instead. :issue:`129`\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\n ``json`` module instead. :pr:`152`\n- Simplejson is no longer used if it is installed. To use a different\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\n- If a signature has an age less than 0, it will raise\n ``SignatureExpired`` rather than appearing valid. This can happen if\n the timestamp offset is changed. :issue:`126`\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\n rather than an ``int`` in some cases. :issue:`124`\n- Added support for key rotation. A list of keys can be passed as\n ``secret_key``, oldest to newest. The newest key is used for\n signing, all keys are tried for unsigning. :pr:`141`\n- Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``. :issue:`155`\n- Add type information for static typing tools. :pr:`186`\n\n\nVersion 1.1.0\n-------------\n\nReleased 2018-10-26\n\n- Change default signing algorithm back to SHA-1. :pr:`113`\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\n release which defaulted to SHA-512. :pr:`114`\n- Add support for fallback algorithms during deserialization to\n support changing the default in the future without breaking existing\n signatures. :pr:`113`\n- Changed capitalization of packages back to lowercase as the change\n in capitalization broke some tooling. :pr:`113`\n\n\nVersion 1.0.0\n-------------\n\nReleased 2018-10-18\n\nYANKED\n\n*Note*: This release was yanked from PyPI because it changed the default\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\nat SHA1.\n\n- Drop support for Python 2.6 and 3.3.\n- Refactor code from a single module to a package. Any object in the\n API docs is still importable from the top-level ``itsdangerous``\n name, but other imports will need to be changed. A future release\n will remove many of these compatibility imports. :pr:`107`\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\n :pr:`27`\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\n Python 3. :issue:`29`\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\n- More compact JSON dumps for unicode strings. :issue:`38`\n- Use the full timestamp rather than an offset, allowing dates before\n 2011. :issue:`46`\n\n To retain compatibility with signers from previous versions,\n consider using `this shim <https://github.com/pallets/itsdangerous\n /issues/120#issuecomment-456913331>`_ when unsigning.\n- Detect a ``sep`` character that may show up in the signature itself\n and raise a ``ValueError``. :issue:`62`\n- Use a consistent signature for keyword arguments for\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\n- Convert JWS exp header to an int when loading. :pr:`99`\n\n\nVersion 0.24\n------------\n\nReleased 2014-03-28\n\n- Added a ``BadHeader`` exception that is used for bad headers that\n replaces the old ``BadPayload`` exception that was reused in those\n cases.\n\n\nVersion 0.23\n------------\n\nReleased 2013-08-08\n\n- Fixed a packaging mistake that caused the tests and license files to\n not be included.\n\n\nVersion 0.22\n------------\n\nReleased 2013-07-03\n\n- Added support for ``TimedJSONWebSignatureSerializer``.\n- Made it possible to override the signature verification function to\n allow implementing asymmetrical algorithms.\n\n\nVersion 0.21\n------------\n\nReleased 2013-05-26\n\n- Fixed an issue on Python 3 which caused invalid errors to be\n generated.\n\n\nVersion 0.20\n------------\n\nReleased 2013-05-23\n\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\n ItsDangerous on Python 2.6.\n\n\nVersion 0.19\n------------\n\nReleased 2013-05-21\n\n- Dropped support for 2.5 and added support for 3.3.\n\n\nVersion 0.18\n------------\n\nReleased 2013-05-03\n\n- Added support for JSON Web Signatures (JWS).\n\n\nVersion 0.17\n------------\n\nReleased 2012-08-10\n\n- Fixed a name error when overriding the digest method.\n\n\nVersion 0.16\n------------\n\nReleased 2012-07-11\n\n- Made it possible to pass unicode values to ``load_payload`` to make\n it easier to debug certain things.\n\n\nVersion 0.15\n------------\n\nReleased 2012-07-11\n\n- Made standalone ``load_payload`` more robust by raising one specific\n error if something goes wrong.\n- Refactored exceptions to catch more cases individually, added more\n attributes.\n- Fixed an issue that caused ``load_payload`` not work in some\n situations with timestamp based serializers\n- Added an ``loads_unsafe`` method.\n\n\nVersion 0.14\n------------\n\nReleased 2012-06-29\n\n- API refactoring to support different key derivations.\n- Added attributes to exceptions so that you can inspect the data even\n if the signature check failed.\n\n\nVersion 0.13\n------------\n\nReleased 2012-06-10\n\n- Small API change that enables customization of the digest module.\n\n\nVersion 0.12\n------------\n\nReleased 2012-02-22\n\n- Fixed a problem with the local timezone being used for the epoch\n calculation. This might invalidate some of your signatures if you\n were not running in UTC timezone. You can revert to the old behavior\n by monkey patching ``itsdangerous.EPOCH``.\n\n\nVersion 0.11\n------------\n\nReleased 2011-07-07\n\n- Fixed an uncaught value error.\n\n\nVersion 0.10\n------------\n\nReleased 2011-06-25\n\n- Refactored interface that the underlying serializers can be swapped\n by passing in a module instead of having to override the payload\n loaders and dumpers. This makes the interface more compatible with\n Django's recent changes.\n\n[end of CHANGES.rst]","filename":"CHANGES.rst","id":"7"},{"content":"version: 2\nbuild:\n os: ubuntu-22.04\n tools:\n python: '3.12'\npython:\n install:\n - requirements: requirements/docs.txt\n - method: pip\n path: .\nsphinx:\n builder: dirhtml\n fail_on_warning: true\n\n[end of .readthedocs.yaml]","filename":".readthedocs.yaml","id":"8"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile dev.in\n#\nalabaster==1.0.0\n # via\n # -r docs.txt\n # sphinx\nbabel==2.16.0\n # via\n # -r docs.txt\n # sphinx\ncachetools==5.5.0\n # via tox\ncertifi==2024.8.30\n # via\n # -r docs.txt\n # requests\ncfgv==3.4.0\n # via pre-commit\nchardet==5.2.0\n # via tox\ncharset-normalizer==3.4.0\n # via\n # -r docs.txt\n # requests\ncolorama==0.4.6\n # via tox\ndistlib==0.3.9\n # via virtualenv\ndocutils==0.21.2\n # via\n # -r docs.txt\n # sphinx\nfilelock==3.16.1\n # via\n # tox\n # virtualenv\nfreezegun==1.5.1\n # via -r tests.txt\nidentify==2.6.1\n # via pre-commit\nidna==3.10\n # via\n # -r docs.txt\n # requests\nimagesize==1.4.1\n # via\n # -r docs.txt\n # sphinx\niniconfig==2.0.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\njinja2==3.1.4\n # via\n # -r docs.txt\n # sphinx\nmarkupsafe==3.0.2\n # via\n # -r docs.txt\n # jinja2\nmypy==1.13.0\n # via -r typing.txt\nmypy-extensions==1.0.0\n # via\n # -r typing.txt\n # mypy\nnodeenv==1.9.1\n # via\n # -r typing.txt\n # pre-commit\n # pyright\npackaging==24.1\n # via\n # -r docs.txt\n # -r tests.txt\n # -r typing.txt\n # pallets-sphinx-themes\n # pyproject-api\n # pytest\n # sphinx\n # tox\npallets-sphinx-themes==2.3.0\n # via -r docs.txt\nplatformdirs==4.3.6\n # via\n # tox\n # virtualenv\npluggy==1.5.0\n # via\n # -r tests.txt\n # -r typing.txt\n # pytest\n # tox\npre-commit==4.0.1\n # via -r dev.in\npygments==2.18.0\n # via\n # -r docs.txt\n # sphinx\npyproject-api==1.8.0\n # via tox\npyright==1.1.386\n # via -r typing.txt\npytest==8.3.3\n # via\n # -r tests.txt\n # -r typing.txt\npython-dateutil==2.9.0.post0\n # via\n # -r tests.txt\n # freezegun\npyyaml==6.0.2\n # via pre-commit\nrequests==2.32.3\n # via\n # -r docs.txt\n # sphinx\nsix==1.16.0\n # via\n # -r tests.txt\n # python-dateutil\nsnowballstemmer==2.2.0\n # via\n # -r docs.txt\n # sphinx\nsphinx==8.1.3\n # via\n # -r docs.txt\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via\n # -r docs.txt\n # pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-devhelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-jsmath==1.0.1\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.txt\nsphinxcontrib-qthelp==2.0.0\n # via\n # -r docs.txt\n # sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via\n # -r docs.txt\n # sphinx\ntox==4.23.2\n # via -r dev.in\ntyping-extensions==4.12.2\n # via\n # -r typing.txt\n # mypy\n # pyright\nurllib3==2.2.3\n # via\n # -r docs.txt\n # requests\nvirtualenv==20.27.0\n # via\n # pre-commit\n # tox\n\n[end of requirements/dev.txt]","filename":"requirements/dev.txt","id":"9"},{"content":"pallets-sphinx-themes\nsphinx\nsphinxcontrib-log-cabinet\n\n[end of requirements/docs.in]","filename":"requirements/docs.in","id":"10"},{"content":"build\n\n[end of requirements/build.in]","filename":"requirements/build.in","id":"11"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile typing.in\n#\niniconfig==2.0.0\n # via pytest\nmypy==1.13.0\n # via -r typing.in\nmypy-extensions==1.0.0\n # via mypy\nnodeenv==1.9.1\n # via pyright\npackaging==24.1\n # via pytest\npluggy==1.5.0\n # via pytest\npyright==1.1.386\n # via -r typing.in\npytest==8.3.3\n # via -r typing.in\ntyping-extensions==4.12.2\n # via\n # mypy\n # pyright\n\n[end of requirements/typing.txt]","filename":"requirements/typing.txt","id":"12"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile build.in\n#\nbuild==1.2.2.post1\n # via -r build.in\npackaging==24.1\n # via build\npyproject-hooks==1.2.0\n # via build\n\n[end of requirements/build.txt]","filename":"requirements/build.txt","id":"13"},{"content":"mypy\npyright\npytest\n\n[end of requirements/typing.in]","filename":"requirements/typing.in","id":"14"},{"content":"-r docs.txt\n-r tests.txt\n-r typing.txt\npre-commit\ntox\n\n[end of requirements/dev.in]","filename":"requirements/dev.in","id":"15"},{"content":"#\n# This file is autogenerated by pip-compile with Python 3.13\n# by the following command:\n#\n# pip-compile docs.in\n#\nalabaster==1.0.0\n # via sphinx\nbabel==2.16.0\n # via sphinx\ncertifi==2024.8.30\n # via requests\ncharset-normalizer==3.4.0\n # via requests\ndocutils==0.21.2\n # via sphinx\nidna==3.10\n # via requests\nimagesize==1.4.1\n # via sphinx\njinja2==3.1.4\n # via sphinx\nmarkupsafe==3.0.2\n # via jinja2\npackaging==24.1\n # via\n # pallets-sphinx-themes\n # sphinx\npallets-sphinx-themes==2.3.0\n # via -r docs.in\npygments==2.18.0\n # via sphinx\nrequests==2.32.3\n # via sphinx\nsnowballstemmer==2.2.0\n # via sphinx\nsphinx==8.1.3\n # via\n # -r docs.in\n # pallets-sphinx-themes\n # sphinx-notfound-page\n # sphinxcontrib-log-cabinet\nsphinx-notfound-page==1.0.4\n # via pallets-sphinx-themes\nsphinxcontrib-applehelp==2.0.0\n # via sphinx\nsphinxcontrib-devhelp==2.0.0\n # via sphinx\nsphinxcontrib-htmlhelp==2.1.0\n # via sphinx\nsphinxcontrib-jsmath==1.0.1\n # via sphinx\nsphinxcontrib-log-cabinet==1.0.1\n # via -r docs.in\nsphinxcontrib-qthelp==2.0.0\n # via sphinx\nsphinxcontrib-serializinghtml==2.0.0\n # via sphinx\nurllib3==2.2.3\n # via requests\n\n[end of requirements/docs.txt]","filename":"requirements/docs.txt","id":"16"},{"content":".. rst-class:: hide-header\n\nItsDangerous\n============\n\n.. image:: _static/itsdangerous-logo.png\n :align: center\n :target: https://palletsprojects.com/p/itsdangerous/\n\nSometimes you want to send some data to untrusted environments, then get\nit back later. To do this safely, the data must be signed to detect\nchanges.\n\nGiven a key only you know, you can cryptographically sign your data and\nhand it over to someone else. When you get the data back you can ensure\nthat nobody tampered with it.\n\nThe receiver can see the data, but they can not modify it unless they\nalso have your key. So if you keep the key secret and complex, you will\nbe fine.\n\n\nInstalling\n----------\n\nInstall and update using `pip`_:\n\n.. code-block:: text\n\n pip install -U itsdangerous\n\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\n\n\nExample Use Cases\n-----------------\n\n- Sign a user ID in a URL and email it to them to unsubscribe from a\n newsletter. This way you don't need to generate one-time tokens and\n store them in the database. Same thing with any kind of activation\n link for accounts and similar things.\n- Signed objects can be stored in cookies or other untrusted sources\n which means you don't need to have sessions stored on the server,\n which reduces the number of necessary database queries.\n- Signed information can safely do a round trip between server and\n client in general which makes them useful for passing server-side\n state to a client and then back.\n\n\nTable of Contents\n-----------------\n\n.. toctree::\n\n concepts\n serializer\n signer\n exceptions\n timed\n url_safe\n encoding\n license\n changes\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"17"},{"content":".. module:: itsdangerous.serializer\n\nSerialization Interface\n=======================\n\nThe :doc:`/signer` only signs bytes. To sign other types, the\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\nsimilar to Python's :mod:`json` module, which serializes the object to a\nstring then signs that.\n\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n s = Serializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\n\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\nthe data.\n\n.. code-block:: python\n\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\n [1, 2, 3, 4]\n\nBy default, data is serialized to JSON with the built-in :mod:`json`\nmodule. This internal serializer can be changed by subclassing.\n\nTo record and validate the age of the signature, see :doc:`/timed`.\nTo serialize to a format that is safe to use in URLs, see\n:doc:`/url_safe`.\n\n\nResponding to Failure\n---------------------\n\nExceptions have helpful attributes which allow you to inspect the\npayload if the signature check failed. This has to be done with extra\ncare because at that point you know that someone tampered with your data\nbut it might be useful for debugging purposes.\n\n.. code-block:: python\n\n from itsdangerous.serializer import Serializer\n from itsdangerous.exc import BadSignature, BadData\n\n s = URLSafeSerializer(\"secret-key\")\n decoded_payload = None\n\n try:\n decoded_payload = s.loads(data)\n # This payload is decoded and safe\n except BadSignature as e:\n if e.payload is not None:\n try:\n decoded_payload = s.load_payload(e.payload)\n except BadData:\n pass\n # This payload is decoded but unsafe because someone\n # tampered with the signature. The decode (load_payload)\n # step is explicit because it might be unsafe to unserialize\n # the payload (think pickle instead of json!)\n\nIf you don't want to inspect attributes to figure out what exactly went\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\n\n.. code-block:: python\n\n sig_okay, payload = s.loads_unsafe(data)\n\nThe first item in the returned tuple is a boolean that indicates if the\nsignature was correct.\n\n\nFallback Signers\n----------------\n\nYou may want to upgrade the signing parameters without invalidating\nexisting signatures immediately. For example, you may decide that you\nwant to use a different digest method. New signatures should use the new\nmethod, but old signatures should still validate.\n\nA list of ``fallback_signers`` can be given that will be tried if\nunsigning with the current signer fails. Each item in the list can be:\n\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\n passed to the serializer.\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\n serializer.\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\n given class with the given args.\n\nFor example, this is a serializer that signs using SHA-512, but will\nunsign using either SHA-512 or SHA-1:\n\n.. code-block:: python\n\n s = Serializer(\n signer_kwargs={\"digest_method\": hashlib.sha512},\n fallback_signers=[{\"digest_method\": hashlib.sha1}]\n )\n\n\n\nAPI\n---\n\n.. autoclass:: Serializer\n :members:\n\n[end of docs/serializer.rst]","filename":"docs/serializer.rst","id":"18"},{"content":".. module:: itsdangerous.signer\n\nSigning Interface\n=================\n\nThe most basic interface is the signing interface. The :class:`Signer`\nclass can be used to attach a signature to a specific string:\n\n.. code-block:: python\n\n from itsdangerous import Signer\n s = Signer(\"secret-key\")\n s.sign(\"my string\")\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\n\nThe signature is appended to the string, separated by a dot. To validate\nthe string, use the :meth:`~Signer.unsign` method:\n\n.. code-block:: python\n\n s.unsign(b\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n b'my string'\n\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\nHowever after unsigning you won't be able to tell if it was unicode or\na bytestring.\n\nIf the value is changed, the signature will no longer match, and\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\n\n.. code-block:: python\n\n s.unsign(b\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\")\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nTo record and validate the age of a signature, see :doc:`/timed`.\n\n.. autoclass:: Signer\n :members:\n\n\nSigning Algorithms\n------------------\n\n.. autoclass:: NoneAlgorithm\n\n.. autoclass:: HMACAlgorithm\n\n[end of docs/signer.rst]","filename":"docs/signer.rst","id":"19"},{"content":"General Concepts\n================\n\n\nSerializer vs Signer\n--------------------\n\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\nthe basic system that signs a given ``bytes`` value based on the given\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\nserializing and signing other data besides ``bytes``.\n\nTypically, you'll want to use a serializer, not a signer. You can\nconfigure the signing parameters through the serializer, and even\nprovide fallback signers to upgrade old tokens to new parameters.\n\n\nThe Secret Key\n--------------\n\nSignatures are secured by the ``secret_key``. Typically one secret key\nis used with all signers, and the salt is used to distinguish different\ncontexts. Changing the secret key will invalidate existing tokens.\n\nIt should be a long random string of bytes. This value must be kept\nsecret and should not be saved in source code or committed to version\ncontrol. If an attacker learns the secret key, they can change and\nresign data to look valid. If you suspect this happened, change the\nsecret key to invalidate existing tokens.\n\nOne way to keep the secret key separate is to read it from an\nenvironment variable. When deploying for the first time, generate a key\nand set the environment variable when running the application. All\nprocess managers (like systemd) and hosting services have a way to\nspecify environment variables.\n\n.. code-block:: python\n\n import os\n from itsdangerous.serializer import Serializer\n SECRET_KEY = os.environ.get(\"SECRET_KEY\")\n s = Serializer(SECRET_KEY)\n\n.. code-block:: text\n\n $ export SECRET_KEY=\"base64 encoded random bytes\"\n $ python application.py\n\nOne way to generate a key is to use :func:`os.urandom`.\n\n.. code-block:: text\n\n $ python3 -c 'import os; print(os.urandom(16).hex())'\n\n\nThe Salt\n--------\n\nThe salt is combined with the secret key to derive a unique key for\ndistinguishing different contexts. Unlike the secret key, the salt\ndoesn't have to be random, and can be saved in code. It only has to be\nunique between contexts, not private.\n\nFor example, you want to email activation links to activate user\naccounts, and upgrade links to upgrade users to a paid accounts. If all\nyou sign is the user id, and you don't use different salts, a user could\nreuse the token from the activation link to upgrade the account. If you\nuse different salts, the signatures will be different and will not be\nvalid in the other context.\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n\n s1 = URLSafeSerializer(\"secret-key\", salt=\"activate\")\n s1.dumps(42)\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\n\n s2 = URLSafeSerializer(\"secret-key\", salt=\"upgrade\")\n s2.dumps(42)\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\n\nThe second serializer can't load data dumped with the first because the\nsalts differ.\n\n.. code-block:: python\n\n s2.loads(s1.dumps(42))\n Traceback (most recent call last):\n ...\n BadSignature: Signature does not match\n\nOnly the serializer with the same salt can load the data.\n\n.. code-block:: python\n\n s2.loads(s2.dumps(42))\n 42\n\n\nKey Rotation\n------------\n\nKey rotation can provide an extra layer of mitigation against an\nattacker discovering a secret key. A rotation system will keep a list of\nvalid keys, generating a new key and removing the oldest key\nperiodically. If it takes four weeks for an attacker to crack a key, but\nthe key is rotated out after three weeks, they will not be able to use\nany keys they crack. However, if a user doesn't refresh their token\nwithin three weeks it will be invalid too.\n\nThe system that generates and maintains this list is outside the scope\nof ItsDangerous, but ItsDangerous does support validating against a list\nof keys.\n\nInstead of passing a single key, you can pass a list of keys, oldest to\nnewest. When signing the last (newest) key will be used, and when\nvalidating each key will be tried from newest to oldest before raising\na validation error.\n\n.. code-block:: python\n\n SECRET_KEYS = [\"2b9cd98e\", \"169d7886\", \"b6af09f5\"]\n\n # sign some data with the latest key\n s = Serializer(SECRET_KEYS)\n t = s.dumps({\"id\": 42})\n\n # rotate a new key in and the oldest key out\n SECRET_KEYS.append(\"cf9b3588\")\n del SECRET_KEYS[0]\n\n s = Serializer(SECRET_KEYS)\n s.loads(t) # valid even though it was signed with a previous key\n\n\nDigest Method Security\n----------------------\n\nA signer is configured with a ``digest_method``, a hash function that\nis used as an intermediate step when generating the HMAC signature. The\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\nconcerned about this default because they have heard about hash\ncollisions with SHA-1.\n\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\nhash alone doesn't apply when used in HMAC.\n\nIf a project considers SHA-1 a risk anyway, they can configure the\nsigner with a different digest method such as :func:`hashlib.sha512`.\nA fallback signer for SHA-1 can be configured so that old tokens will be\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\nspace, which is relevant in cookies and URLs.\n\n[end of docs/concepts.rst]","filename":"docs/concepts.rst","id":"20"},{"content":".. module:: itsdangerous.url_safe\n\nURL Safe Serialization\n======================\n\nOften it is helpful if you can pass these trusted strings in places\nwhere you only have a limited set of characters available. Because of\nthis, ItsDangerous also provides URL safe serializers:\n\n.. code-block:: python\n\n from itsdangerous.url_safe import URLSafeSerializer\n s = URLSafeSerializer(\"secret-key\")\n s.dumps([1, 2, 3, 4])\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\n s.loads(\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\")\n [1, 2, 3, 4]\n\n.. autoclass:: URLSafeSerializer\n\n.. autoclass:: URLSafeTimedSerializer\n\n[end of docs/url_safe.rst]","filename":"docs/url_safe.rst","id":"21"},{"content":".. module:: itsdangerous.encoding\n\nEncoding Utilities\n==================\n\n.. autofunction:: base64_encode\n\n.. autofunction:: base64_decode\n\n[end of docs/encoding.rst]","filename":"docs/encoding.rst","id":"22"},{"content":"# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSOURCEDIR = .\nBUILDDIR = _build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"23"},{"content":"from pallets_sphinx_themes import get_version\nfrom pallets_sphinx_themes import ProjectLink\n\n# Project --------------------------------------------------------------\n\nproject = \"ItsDangerous\"\ncopyright = \"2011 Pallets\"\nauthor = \"Pallets\"\nrelease, version = get_version(\"itsdangerous\")\n\n# General --------------------------------------------------------------\n\ndefault_role = \"code\"\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.extlinks\",\n \"sphinx.ext.intersphinx\",\n \"sphinxcontrib.log_cabinet\",\n \"pallets_sphinx_themes\",\n]\nautoclass_content = \"both\"\nautodoc_member_order = \"bysource\"\nautodoc_typehints = \"description\"\nautodoc_preserve_defaults = True\nextlinks = {\n \"issue\": (\"https://github.com/pallets/itsdangerous/issues/%s\", \"#%s\"),\n \"pr\": (\"https://github.com/pallets/itsdangerous/pull/%s\", \"#%s\"),\n}\nintersphinx_mapping = {\n \"python\": (\"https://docs.python.org/3/\", None),\n}\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = \"flask\"\nhtml_theme_options = {\"index_sidebar_logo\": False}\nhtml_context = {\n \"project_links\": [\n ProjectLink(\"Donate\", \"https://palletsprojects.com/donate\"),\n ProjectLink(\"PyPI Releases\", \"https://pypi.org/project/itsdangerous/\"),\n ProjectLink(\"Source Code\", \"https://github.com/pallets/itsdangerous/\"),\n ProjectLink(\"Issue Tracker\", \"https://github.com/pallets/itsdangerous/issues/\"),\n ProjectLink(\"Chat\", \"https://discord.gg/pallets\"),\n ]\n}\nhtml_sidebars = {\n \"index\": [\"project.html\", \"localtoc.html\", \"searchbox.html\", \"ethicalads.html\"],\n \"**\": [\"localtoc.html\", \"relations.html\", \"searchbox.html\", \"ethicalads.html\"],\n}\nsinglehtml_sidebars = {\"index\": [\"project.html\", \"localtoc.html\", \"ethicalads.html\"]}\nhtml_static_path = [\"_static\"]\nhtml_favicon = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_logo = \"_static/itsdangerous-logo-sidebar.png\"\nhtml_title = f\"{project} Documentation ({version})\"\nhtml_show_sourcelink = False\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"24"},{"content":"@ECHO OFF\n\npushd %~dp0\n\nREM Command file for Sphinx documentation\n\nif \"%SPHINXBUILD%\" == \"\" (\n\tset SPHINXBUILD=sphinx-build\n)\nset SOURCEDIR=.\nset BUILDDIR=_build\n\nif \"%1\" == \"\" goto help\n\n%SPHINXBUILD% >NUL 2>NUL\nif errorlevel 9009 (\n\techo.\n\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\n\techo.installed, then set the SPHINXBUILD environment variable to point\n\techo.to the full path of the 'sphinx-build' executable. Alternatively you\n\techo.may add the Sphinx directory to PATH.\n\techo.\n\techo.If you don't have Sphinx installed, grab it from\n\techo.http://sphinx-doc.org/\n\texit /b 1\n)\n\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\ngoto end\n\n:help\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\n\n:end\npopd\n\n[end of docs/make.bat]","filename":"docs/make.bat","id":"25"},{"content":".. module:: itsdangerous.timed\n\nSigning With Timestamps\n=======================\n\nIf you want to expire signatures you can use the\n:class:`TimestampSigner` class which adds timestamp information and\nsigns it. On unsigning you can validate that the timestamp is not older\nthan a given age.\n\n.. code-block:: python\n\n from itsdangerous import TimestampSigner\n s = TimestampSigner('secret-key')\n string = s.sign('foo')\n\n.. code-block:: python\n\n s.unsign(string, max_age=5)\n Traceback (most recent call last):\n ...\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\n\n.. autoclass:: TimestampSigner\n :members:\n\n.. autoclass:: TimedSerializer\n :members:\n\n[end of docs/timed.rst]","filename":"docs/timed.rst","id":"26"},{"content":"BSD-3-Clause License\n====================\n\n.. literalinclude:: ../LICENSE.txt\n :language: text\n\n[end of docs/license.rst]","filename":"docs/license.rst","id":"27"},{"content":"Changes\n=======\n\n.. include:: ../CHANGES.rst\n\n[end of docs/changes.rst]","filename":"docs/changes.rst","id":"28"},{"content":".. module:: itsdangerous.exc\n\nExceptions\n==========\n\n.. autoexception:: BadData\n :members:\n\n.. autoexception:: BadSignature\n :members:\n\n.. autoexception:: BadTimeSignature\n :members:\n\n.. autoexception:: SignatureExpired\n :members:\n\n.. autoexception:: BadHeader\n :members:\n\n.. autoexception:: BadPayload\n :members:\n\n[end of docs/exceptions.rst]","filename":"docs/exceptions.rst","id":"29"},{"content":"#!/bin/bash\nset -e\npython3 -m venv --upgrade-deps .venv\n. .venv/bin/activate\npip install -r requirements/dev.txt\npip install -e .\npre-commit install --install-hooks\n\n[end of .devcontainer/on-create-command.sh]","filename":".devcontainer/on-create-command.sh","id":"30"},{"content":"{\n \"name\": \"pallets/itsdangerous\",\n \"image\": \"mcr.microsoft.com/devcontainers/python:3\",\n \"customizations\": {\n \"vscode\": {\n \"settings\": {\n \"python.defaultInterpreterPath\": \"${workspaceFolder}/.venv\",\n \"python.terminal.activateEnvInCurrentTerminal\": true,\n \"python.terminal.launchArgs\": [\n \"-X\",\n \"dev\"\n ]\n }\n }\n },\n \"onCreateCommand\": \".devcontainer/on-create-command.sh\"\n}\n\n[end of .devcontainer/devcontainer.json]","filename":".devcontainer/devcontainer.json","id":"31"},{"content":"None\n[end of docs/_static/itsdangerous-logo-sidebar.png]","filename":"docs/_static/itsdangerous-logo-sidebar.png","id":"32"},{"content":"None\n[end of docs/_static/itsdangerous-logo.png]","filename":"docs/_static/itsdangerous-logo.png","id":"33"},{"content":"from __future__ import annotations\n\nimport json as _json\nimport typing as t\n\n\nclass _CompactJSON:\n \"\"\"Wrapper around json module that strips whitespace.\"\"\"\n\n @staticmethod\n def loads(payload: str | bytes) -> t.Any:\n return _json.loads(payload)\n\n @staticmethod\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\n kwargs.setdefault(\"ensure_ascii\", False)\n kwargs.setdefault(\"separators\", (\",\", \":\"))\n return _json.dumps(obj, **kwargs)\n\n[end of src/itsdangerous/_json.py]","filename":"src/itsdangerous/_json.py","id":"34"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport time\nimport typing as t\nfrom datetime import datetime\nfrom datetime import timezone\n\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import bytes_to_int\nfrom .encoding import int_to_bytes\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\nfrom .exc import BadTimeSignature\nfrom .exc import SignatureExpired\nfrom .serializer import _TSerialized\nfrom .serializer import Serializer\nfrom .signer import Signer\n\n\nclass TimestampSigner(Signer):\n \"\"\"Works like the regular :class:`.Signer` but also records the time\n of the signing and can be used to expire signatures. The\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\n unsigning failed because the signature is expired.\n \"\"\"\n\n def get_timestamp(self) -> int:\n \"\"\"Returns the current timestamp. The function must return an\n integer.\n \"\"\"\n return int(time.time())\n\n def timestamp_to_datetime(self, ts: int) -> datetime:\n \"\"\"Convert the timestamp from :meth:`get_timestamp` into an\n aware :class`datetime.datetime` in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n return datetime.fromtimestamp(ts, tz=timezone.utc)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string and also attaches time information.\"\"\"\n value = want_bytes(value)\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\n sep = want_bytes(self.sep)\n value = value + sep + timestamp\n return value + sep + self.get_signature(value)\n\n # Ignore overlapping signatures check, return_timestamp is the only\n # parameter that affects the return type.\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[False] = False,\n ) -> bytes: ...\n\n @t.overload\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: t.Literal[True] = True,\n ) -> tuple[bytes, datetime]: ...\n\n def unsign(\n self,\n signed_value: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n ) -> tuple[bytes, datetime] | bytes:\n \"\"\"Works like the regular :meth:`.Signer.unsign` but can also\n validate the time. See the base docstring of the class for\n the general behavior. If ``return_timestamp`` is ``True`` the\n timestamp of the signature will be returned as an aware\n :class:`datetime.datetime` object in UTC.\n\n .. versionchanged:: 2.0\n The timestamp is returned as a timezone-aware ``datetime``\n in UTC rather than a naive ``datetime`` assumed to be UTC.\n \"\"\"\n try:\n result = super().unsign(signed_value)\n sig_error = None\n except BadSignature as e:\n sig_error = e\n result = e.payload or b\"\"\n\n sep = want_bytes(self.sep)\n\n # If there is no timestamp in the result there is something\n # seriously wrong. In case there was a signature error, we raise\n # that one directly, otherwise we have a weird situation in\n # which we shouldn't have come except someone uses a time-based\n # serializer on non-timestamp data, so catch that.\n if sep not in result:\n if sig_error:\n raise sig_error\n\n raise BadTimeSignature(\"timestamp missing\", payload=result)\n\n value, ts_bytes = result.rsplit(sep, 1)\n ts_int: int | None = None\n ts_dt: datetime | None = None\n\n try:\n ts_int = bytes_to_int(base64_decode(ts_bytes))\n except Exception:\n pass\n\n # Signature is *not* okay. Raise a proper error now that we have\n # split the value and the timestamp.\n if sig_error is not None:\n if ts_int is not None:\n try:\n ts_dt = self.timestamp_to_datetime(ts_int)\n except (ValueError, OSError, OverflowError) as exc:\n # Windows raises OSError\n # 32-bit raises OverflowError\n raise BadTimeSignature(\n \"Malformed timestamp\", payload=value\n ) from exc\n\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\n\n # Signature was okay but the timestamp is actually not there or\n # malformed. Should not happen, but we handle it anyway.\n if ts_int is None:\n raise BadTimeSignature(\"Malformed timestamp\", payload=value)\n\n # Check timestamp is not older than max_age\n if max_age is not None:\n age = self.get_timestamp() - ts_int\n\n if age > max_age:\n raise SignatureExpired(\n f\"Signature age {age} > {max_age} seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if age < 0:\n raise SignatureExpired(\n f\"Signature age {age} < 0 seconds\",\n payload=value,\n date_signed=self.timestamp_to_datetime(ts_int),\n )\n\n if return_timestamp:\n return value, self.timestamp_to_datetime(ts_int)\n\n return value\n\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\"\"\"\n try:\n self.unsign(signed_value, max_age=max_age)\n return True\n except BadSignature:\n return False\n\n\nclass TimedSerializer(Serializer[_TSerialized]):\n \"\"\"Uses :class:`TimestampSigner` instead of the default\n :class:`.Signer`.\n \"\"\"\n\n default_signer: type[TimestampSigner] = TimestampSigner\n\n def iter_unsigners(\n self, salt: str | bytes | None = None\n ) -> cabc.Iterator[TimestampSigner]:\n return t.cast(\"cabc.Iterator[TimestampSigner]\", super().iter_unsigners(salt))\n\n # TODO: Signature is incompatible because parameters were added\n # before salt.\n\n def loads( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n return_timestamp: bool = False,\n salt: str | bytes | None = None,\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\n signature validation fails. If a ``max_age`` is provided it will\n ensure the signature is not older than that time in seconds. In\n case the signature is outdated, :exc:`.SignatureExpired` is\n raised. All arguments are forwarded to the signer's\n :meth:`~TimestampSigner.unsign` method.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n base64d, timestamp = signer.unsign(\n s, max_age=max_age, return_timestamp=True\n )\n payload = self.load_payload(base64d)\n\n if return_timestamp:\n return payload, timestamp\n\n return payload\n except SignatureExpired:\n # The signature was unsigned successfully but was\n # expired. Do not try the next signer.\n raise\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def loads_unsafe( # type: ignore[override]\n self,\n s: str | bytes,\n max_age: int | None = None,\n salt: str | bytes | None = None,\n ) -> tuple[bool, t.Any]:\n return self._loads_unsafe_impl(s, salt, load_kwargs={\"max_age\": max_age})\n\n[end of src/itsdangerous/timed.py]","filename":"src/itsdangerous/timed.py","id":"35"},{"content":"from __future__ import annotations\n\nimport base64\nimport string\nimport struct\nimport typing as t\n\nfrom .exc import BadData\n\n\ndef want_bytes(\n s: str | bytes, encoding: str = \"utf-8\", errors: str = \"strict\"\n) -> bytes:\n if isinstance(s, str):\n s = s.encode(encoding, errors)\n\n return s\n\n\ndef base64_encode(string: str | bytes) -> bytes:\n \"\"\"Base64 encode a string of bytes or text. The resulting bytes are\n safe to use in URLs.\n \"\"\"\n string = want_bytes(string)\n return base64.urlsafe_b64encode(string).rstrip(b\"=\")\n\n\ndef base64_decode(string: str | bytes) -> bytes:\n \"\"\"Base64 decode a URL-safe string of bytes or text. The result is\n bytes.\n \"\"\"\n string = want_bytes(string, encoding=\"ascii\", errors=\"ignore\")\n string += b\"=\" * (-len(string) % 4)\n\n try:\n return base64.urlsafe_b64decode(string)\n except (TypeError, ValueError) as e:\n raise BadData(\"Invalid base64-encoded data\") from e\n\n\n# The alphabet used by base64.urlsafe_*\n_base64_alphabet = f\"{string.ascii_letters}{string.digits}-_=\".encode(\"ascii\")\n\n_int64_struct = struct.Struct(\">Q\")\n_int_to_bytes = _int64_struct.pack\n_bytes_to_int = t.cast(\"t.Callable[[bytes], tuple[int]]\", _int64_struct.unpack)\n\n\ndef int_to_bytes(num: int) -> bytes:\n return _int_to_bytes(num).lstrip(b\"\\x00\")\n\n\ndef bytes_to_int(bytestr: bytes) -> int:\n return _bytes_to_int(bytestr.rjust(8, b\"\\x00\"))[0]\n\n[end of src/itsdangerous/encoding.py]","filename":"src/itsdangerous/encoding.py","id":"36"},{"content":"from __future__ import annotations\n\nimport typing as t\n\nfrom .encoding import base64_decode as base64_decode\nfrom .encoding import base64_encode as base64_encode\nfrom .encoding import want_bytes as want_bytes\nfrom .exc import BadData as BadData\nfrom .exc import BadHeader as BadHeader\nfrom .exc import BadPayload as BadPayload\nfrom .exc import BadSignature as BadSignature\nfrom .exc import BadTimeSignature as BadTimeSignature\nfrom .exc import SignatureExpired as SignatureExpired\nfrom .serializer import Serializer as Serializer\nfrom .signer import HMACAlgorithm as HMACAlgorithm\nfrom .signer import NoneAlgorithm as NoneAlgorithm\nfrom .signer import Signer as Signer\nfrom .timed import TimedSerializer as TimedSerializer\nfrom .timed import TimestampSigner as TimestampSigner\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\n\n\ndef __getattr__(name: str) -> t.Any:\n if name == \"__version__\":\n import importlib.metadata\n import warnings\n\n warnings.warn(\n \"The '__version__' attribute is deprecated and will be removed in\"\n \" ItsDangerous 2.3. Use feature detection or\"\n \" 'importlib.metadata.version(\\\"itsdangerous\\\")' instead.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return importlib.metadata.version(\"itsdangerous\")\n\n raise AttributeError(name)\n\n[end of src/itsdangerous/__init__.py]","filename":"src/itsdangerous/__init__.py","id":"37"},{"content":"from __future__ import annotations\n\nimport typing as t\nimport zlib\n\nfrom ._json import _CompactJSON\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .exc import BadPayload\nfrom .serializer import _PDataSerializer\nfrom .serializer import Serializer\nfrom .timed import TimedSerializer\n\n\nclass URLSafeSerializerMixin(Serializer[str]):\n \"\"\"Mixed in with a regular serializer it will attempt to zlib\n compress the string to make it shorter if necessary. It will also\n base64 encode the string so that it can safely be placed in a URL.\n \"\"\"\n\n default_serializer: _PDataSerializer[str] = _CompactJSON\n\n def load_payload(\n self,\n payload: bytes,\n *args: t.Any,\n serializer: t.Any | None = None,\n **kwargs: t.Any,\n ) -> t.Any:\n decompress = False\n\n if payload.startswith(b\".\"):\n payload = payload[1:]\n decompress = True\n\n try:\n json = base64_decode(payload)\n except Exception as e:\n raise BadPayload(\n \"Could not base64 decode the payload because of an exception\",\n original_error=e,\n ) from e\n\n if decompress:\n try:\n json = zlib.decompress(json)\n except Exception as e:\n raise BadPayload(\n \"Could not zlib decompress the payload before decoding the payload\",\n original_error=e,\n ) from e\n\n return super().load_payload(json, *args, **kwargs)\n\n def dump_payload(self, obj: t.Any) -> bytes:\n json = super().dump_payload(obj)\n is_compressed = False\n compressed = zlib.compress(json)\n\n if len(compressed) < (len(json) - 1):\n json = compressed\n is_compressed = True\n\n base64d = base64_encode(json)\n\n if is_compressed:\n base64d = b\".\" + base64d\n\n return base64d\n\n\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\n \"\"\"Works like :class:`.Serializer` but dumps and loads into a URL\n safe string consisting of the upper and lowercase character of the\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\n \"\"\"Works like :class:`.TimedSerializer` but dumps and loads into a\n URL safe string consisting of the upper and lowercase character of\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\n \"\"\"\n\n[end of src/itsdangerous/url_safe.py]","filename":"src/itsdangerous/url_safe.py","id":"38"},{"content":"from __future__ import annotations\n\nimport typing as t\nfrom datetime import datetime\n\n\nclass BadData(Exception):\n \"\"\"Raised if bad data of any sort was encountered. This is the base\n for all exceptions that ItsDangerous defines.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str):\n super().__init__(message)\n self.message = message\n\n def __str__(self) -> str:\n return self.message\n\n\nclass BadSignature(BadData):\n \"\"\"Raised if a signature does not match.\"\"\"\n\n def __init__(self, message: str, payload: t.Any | None = None):\n super().__init__(message)\n\n #: The payload that failed the signature test. In some\n #: situations you might still want to inspect this, even if\n #: you know it was tampered with.\n #:\n #: .. versionadded:: 0.14\n self.payload: t.Any | None = payload\n\n\nclass BadTimeSignature(BadSignature):\n \"\"\"Raised if a time-based signature is invalid. This is a subclass\n of :class:`BadSignature`.\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n date_signed: datetime | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the signature expired this exposes the date of when the\n #: signature was created. This can be helpful in order to\n #: tell the user how long a link has been gone stale.\n #:\n #: .. versionchanged:: 2.0\n #: The datetime value is timezone-aware rather than naive.\n #:\n #: .. versionadded:: 0.14\n self.date_signed = date_signed\n\n\nclass SignatureExpired(BadTimeSignature):\n \"\"\"Raised if a signature timestamp is older than ``max_age``. This\n is a subclass of :exc:`BadTimeSignature`.\n \"\"\"\n\n\nclass BadHeader(BadSignature):\n \"\"\"Raised if a signed header is invalid in some form. This only\n happens for serializers that have a header that goes with the\n signature.\n\n .. versionadded:: 0.24\n \"\"\"\n\n def __init__(\n self,\n message: str,\n payload: t.Any | None = None,\n header: t.Any | None = None,\n original_error: Exception | None = None,\n ):\n super().__init__(message, payload)\n\n #: If the header is actually available but just malformed it\n #: might be stored here.\n self.header: t.Any | None = header\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n\nclass BadPayload(BadData):\n \"\"\"Raised if a payload is invalid. This could happen if the payload\n is loaded despite an invalid signature, or if there is a mismatch\n between the serializer and deserializer. The original exception\n that occurred during loading is stored on as :attr:`original_error`.\n\n .. versionadded:: 0.15\n \"\"\"\n\n def __init__(self, message: str, original_error: Exception | None = None):\n super().__init__(message)\n\n #: If available, the error that indicates why the payload was\n #: not valid. This might be ``None``.\n self.original_error: Exception | None = original_error\n\n[end of src/itsdangerous/exc.py]","filename":"src/itsdangerous/exc.py","id":"39"},{"content":"[end of src/itsdangerous/py.typed]","filename":"src/itsdangerous/py.typed","id":"40"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport json\nimport typing as t\n\nfrom .encoding import want_bytes\nfrom .exc import BadPayload\nfrom .exc import BadSignature\nfrom .signer import _make_keys_list\nfrom .signer import Signer\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n # This should be either be str or bytes. To avoid having to specify the\n # bound type, it falls back to a union if structural matching fails.\n _TSerialized = te.TypeVar(\n \"_TSerialized\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\n )\nelse:\n # Still available at runtime on Python < 3.13, but without the default.\n _TSerialized = t.TypeVar(\"_TSerialized\", bound=t.Union[str, bytes])\n\n\nclass _PDataSerializer(t.Protocol[_TSerialized]):\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\n # A signature with additional arguments is not handled correctly by type\n # checkers right now, so an overload is used below for serializers that\n # don't match this strict protocol.\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\n\n\n# Use TypeIs once it's available in typing_extensions or 3.13.\ndef is_text_serializer(\n serializer: _PDataSerializer[t.Any],\n) -> te.TypeGuard[_PDataSerializer[str]]:\n \"\"\"Checks whether a serializer generates text or binary.\"\"\"\n return isinstance(serializer.dumps({}), str)\n\n\nclass Serializer(t.Generic[_TSerialized]):\n \"\"\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\n enable serializing and securely signing data other than bytes. It\n can unsign to verify that the data hasn't been changed.\n\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\n :mod:`json`, and by default uses :mod:`json` internally to serialize\n the data to bytes.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param serializer: An object that provides ``dumps`` and ``loads``\n methods for serializing data to a string. Defaults to\n :attr:`default_serializer`, which defaults to :mod:`json`.\n :param serializer_kwargs: Keyword arguments to pass when calling\n ``serializer.dumps``.\n :param signer: A ``Signer`` class to instantiate when signing data.\n Defaults to :attr:`default_signer`, which defaults to\n :class:`~itsdangerous.signer.Signer`.\n :param signer_kwargs: Keyword arguments to pass when instantiating\n the ``Signer`` class.\n :param fallback_signers: List of signer parameters to try when\n unsigning with the default signer fails. Each item can be a dict\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\n ``(signer, signer_kwargs)``. Defaults to\n :attr:`default_fallback_signers`.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 2.0\n Removed the default SHA-512 fallback signer from\n ``default_fallback_signers``.\n\n .. versionchanged:: 1.1\n Added support for ``fallback_signers`` and configured a default\n SHA-512 fallback. This fallback is for users who used the yanked\n 1.0.0 release which defaulted to SHA-512.\n\n .. versionchanged:: 0.14\n The ``signer`` and ``signer_kwargs`` parameters were added to\n the constructor.\n \"\"\"\n\n #: The default serialization module to use to serialize data to a\n #: string internally. The default is :mod:`json`, but can be changed\n #: to any object that provides ``dumps`` and ``loads`` methods.\n default_serializer: _PDataSerializer[t.Any] = json\n\n #: The default ``Signer`` class to instantiate when signing data.\n #: The default is :class:`itsdangerous.signer.Signer`.\n default_signer: type[Signer] = Signer\n\n #: The default fallback signers to try when unsigning fails.\n default_fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = []\n\n # Serializer[str] if no data serializer is provided, or if it returns str.\n @t.overload\n def __init__(\n self: Serializer[str],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: None | _PDataSerializer[str] = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer positional argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Serializer[bytes] with a bytes data serializer keyword argument.\n @t.overload\n def __init__(\n self: Serializer[bytes],\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: _PDataSerializer[bytes],\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a positional argument. If the strict signature of\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\n # to specify the type.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n # Fall back with a keyword argument.\n @t.overload\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n *,\n serializer: t.Any,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ): ...\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous\",\n serializer: t.Any | None = None,\n serializer_kwargs: dict[str, t.Any] | None = None,\n signer: type[Signer] | None = None,\n signer_kwargs: dict[str, t.Any] | None = None,\n fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ]\n | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n\n if salt is not None:\n salt = want_bytes(salt)\n # if salt is None then the signer's default is used\n\n self.salt = salt\n\n if serializer is None:\n serializer = self.default_serializer\n\n self.serializer: _PDataSerializer[_TSerialized] = serializer\n self.is_text_serializer: bool = is_text_serializer(serializer)\n\n if signer is None:\n signer = self.default_signer\n\n self.signer: type[Signer] = signer\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\n\n if fallback_signers is None:\n fallback_signers = list(self.default_fallback_signers)\n\n self.fallback_signers: list[\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\n ] = fallback_signers\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def load_payload(\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\n ) -> t.Any:\n \"\"\"Loads the encoded object. This function raises\n :class:`.BadPayload` if the payload is not valid. The\n ``serializer`` parameter can be used to override the serializer\n stored on the class. The encoded ``payload`` should always be\n bytes.\n \"\"\"\n if serializer is None:\n use_serializer = self.serializer\n is_text = self.is_text_serializer\n else:\n use_serializer = serializer\n is_text = is_text_serializer(serializer)\n\n try:\n if is_text:\n return use_serializer.loads(payload.decode(\"utf-8\")) # type: ignore[arg-type]\n\n return use_serializer.loads(payload) # type: ignore[arg-type]\n except Exception as e:\n raise BadPayload(\n \"Could not load the payload because an exception\"\n \" occurred on unserializing the data.\",\n original_error=e,\n ) from e\n\n def dump_payload(self, obj: t.Any) -> bytes:\n \"\"\"Dumps the encoded object. The return value is always bytes.\n If the internal serializer returns text, the value will be\n encoded as UTF-8.\n \"\"\"\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\n\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\n \"\"\"Creates a new instance of the signer to be used. The default\n implementation uses the :class:`.Signer` base class.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\n\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\n \"\"\"Iterates over all signers to be tried for unsigning. Starts\n with the configured signer, then constructs each signer\n specified in ``fallback_signers``.\n \"\"\"\n if salt is None:\n salt = self.salt\n\n yield self.make_signer(salt)\n\n for fallback in self.fallback_signers:\n if isinstance(fallback, dict):\n kwargs = fallback\n fallback = self.signer\n elif isinstance(fallback, tuple):\n fallback, kwargs = fallback\n else:\n kwargs = self.signer_kwargs\n\n for secret_key in self.secret_keys:\n yield fallback(secret_key, salt=salt, **kwargs)\n\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\n \"\"\"Returns a signed string serialized with the internal\n serializer. The return value can be either a byte or unicode\n string depending on the format of the internal serializer.\n \"\"\"\n payload = want_bytes(self.dump_payload(obj))\n rv = self.make_signer(salt).sign(payload)\n\n if self.is_text_serializer:\n return rv.decode(\"utf-8\") # type: ignore[return-value]\n\n return rv # type: ignore[return-value]\n\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\n \"\"\"Like :meth:`dumps` but dumps into a file. The file handle has\n to be compatible with what the internal serializer expects.\n \"\"\"\n f.write(self.dumps(obj, salt))\n\n def loads(\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\n ) -> t.Any:\n \"\"\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\n signature validation fails.\n \"\"\"\n s = want_bytes(s)\n last_exception = None\n\n for signer in self.iter_unsigners(salt):\n try:\n return self.load_payload(signer.unsign(s))\n except BadSignature as err:\n last_exception = err\n\n raise t.cast(BadSignature, last_exception)\n\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\n \"\"\"Like :meth:`loads` but loads from a file.\"\"\"\n return self.loads(f.read(), salt)\n\n def loads_unsafe(\n self, s: str | bytes, salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads` but without verifying the signature. This\n is potentially very dangerous to use depending on how your\n serializer works. The return value is ``(signature_valid,\n payload)`` instead of just the payload. The first item will be a\n boolean that indicates if the signature is valid. This function\n never fails.\n\n Use it for debugging only and if you know that your serializer\n module is not exploitable (for example, do not use it with a\n pickle serializer).\n\n .. versionadded:: 0.15\n \"\"\"\n return self._loads_unsafe_impl(s, salt)\n\n def _loads_unsafe_impl(\n self,\n s: str | bytes,\n salt: str | bytes | None,\n load_kwargs: dict[str, t.Any] | None = None,\n load_payload_kwargs: dict[str, t.Any] | None = None,\n ) -> tuple[bool, t.Any]:\n \"\"\"Low level helper function to implement :meth:`loads_unsafe`\n in serializer subclasses.\n \"\"\"\n if load_kwargs is None:\n load_kwargs = {}\n\n try:\n return True, self.loads(s, salt=salt, **load_kwargs)\n except BadSignature as e:\n if e.payload is None:\n return False, None\n\n if load_payload_kwargs is None:\n load_payload_kwargs = {}\n\n try:\n return (\n False,\n self.load_payload(e.payload, **load_payload_kwargs),\n )\n except BadPayload:\n return False, None\n\n def load_unsafe(\n self, f: t.IO[t.Any], salt: str | bytes | None = None\n ) -> tuple[bool, t.Any]:\n \"\"\"Like :meth:`loads_unsafe` but loads from a file.\n\n .. versionadded:: 0.15\n \"\"\"\n return self.loads_unsafe(f.read(), salt=salt)\n\n[end of src/itsdangerous/serializer.py]","filename":"src/itsdangerous/serializer.py","id":"41"},{"content":"from __future__ import annotations\n\nimport collections.abc as cabc\nimport hashlib\nimport hmac\nimport typing as t\n\nfrom .encoding import _base64_alphabet\nfrom .encoding import base64_decode\nfrom .encoding import base64_encode\nfrom .encoding import want_bytes\nfrom .exc import BadSignature\n\n\nclass SigningAlgorithm:\n \"\"\"Subclasses must implement :meth:`get_signature` to provide\n signature generation functionality.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n \"\"\"Returns the signature for the given key and value.\"\"\"\n raise NotImplementedError()\n\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\n \"\"\"Verifies the given signature matches the expected\n signature.\n \"\"\"\n return hmac.compare_digest(sig, self.get_signature(key, value))\n\n\nclass NoneAlgorithm(SigningAlgorithm):\n \"\"\"Provides an algorithm that does not perform any signing and\n returns an empty signature.\n \"\"\"\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n return b\"\"\n\n\ndef _lazy_sha1(string: bytes = b\"\") -> t.Any:\n \"\"\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\n SHA-1, in which case the import and use as a default would fail before the\n developer can configure something else.\n \"\"\"\n return hashlib.sha1(string)\n\n\nclass HMACAlgorithm(SigningAlgorithm):\n \"\"\"Provides signature generation using HMACs.\"\"\"\n\n #: The digest method to use with the MAC algorithm. This defaults to\n #: SHA1, but can be changed to any other function in the hashlib\n #: module.\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n def __init__(self, digest_method: t.Any = None):\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n def get_signature(self, key: bytes, value: bytes) -> bytes:\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\n return mac.digest()\n\n\ndef _make_keys_list(\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n) -> list[bytes]:\n if isinstance(secret_key, (str, bytes)):\n return [want_bytes(secret_key)]\n\n return [want_bytes(s) for s in secret_key] # pyright: ignore\n\n\nclass Signer:\n \"\"\"A signer securely signs bytes, then unsigns them to verify that\n the value hasn't been changed.\n\n The secret key should be a random string of ``bytes`` and should not\n be saved to code or version control. Different salts should be used\n to distinguish signing in different contexts. See :doc:`/concepts`\n for information about the security of the secret key and salt.\n\n :param secret_key: The secret key to sign and verify with. Can be a\n list of keys, oldest to newest, to support key rotation.\n :param salt: Extra key to combine with ``secret_key`` to distinguish\n signatures in different contexts.\n :param sep: Separator between the signature and value.\n :param key_derivation: How to derive the signing key from the secret\n key and salt. Possible values are ``concat``, ``django-concat``,\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\n defaults to ``django-concat``.\n :param digest_method: Hash function to use when generating the HMAC\n signature. Defaults to :attr:`default_digest_method`, which\n defaults to :func:`hashlib.sha1`. Note that the security of the\n hash alone doesn't apply when used intermediately in HMAC.\n :param algorithm: A :class:`SigningAlgorithm` instance to use\n instead of building a default :class:`HMACAlgorithm` with the\n ``digest_method``.\n\n .. versionchanged:: 2.0\n Added support for key rotation by passing a list to\n ``secret_key``.\n\n .. versionchanged:: 0.18\n ``algorithm`` was added as an argument to the class constructor.\n\n .. versionchanged:: 0.14\n ``key_derivation`` and ``digest_method`` were added as arguments\n to the class constructor.\n \"\"\"\n\n #: The default digest method to use for the signer. The default is\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\n #: compatible object. Note that the security of the hash alone\n #: doesn't apply when used intermediately in HMAC.\n #:\n #: .. versionadded:: 0.14\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\n\n #: The default scheme to use to derive the signing key from the\n #: secret key and salt. The default is ``django-concat``. Possible\n #: values are ``concat``, ``django-concat``, and ``hmac``.\n #:\n #: .. versionadded:: 0.14\n default_key_derivation: str = \"django-concat\"\n\n def __init__(\n self,\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\n salt: str | bytes | None = b\"itsdangerous.Signer\",\n sep: str | bytes = b\".\",\n key_derivation: str | None = None,\n digest_method: t.Any | None = None,\n algorithm: SigningAlgorithm | None = None,\n ):\n #: The list of secret keys to try for verifying signatures, from\n #: oldest to newest. The newest (last) key is used for signing.\n #:\n #: This allows a key rotation system to keep a list of allowed\n #: keys and remove expired ones.\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\n self.sep: bytes = want_bytes(sep)\n\n if self.sep in _base64_alphabet:\n raise ValueError(\n \"The given separator cannot be used because it may be\"\n \" contained in the signature itself. ASCII letters,\"\n \" digits, and '-_=' must not be used.\"\n )\n\n if salt is not None:\n salt = want_bytes(salt)\n else:\n salt = b\"itsdangerous.Signer\"\n\n self.salt = salt\n\n if key_derivation is None:\n key_derivation = self.default_key_derivation\n\n self.key_derivation: str = key_derivation\n\n if digest_method is None:\n digest_method = self.default_digest_method\n\n self.digest_method: t.Any = digest_method\n\n if algorithm is None:\n algorithm = HMACAlgorithm(self.digest_method)\n\n self.algorithm: SigningAlgorithm = algorithm\n\n @property\n def secret_key(self) -> bytes:\n \"\"\"The newest (last) entry in the :attr:`secret_keys` list. This\n is for compatibility from before key rotation support was added.\n \"\"\"\n return self.secret_keys[-1]\n\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\n \"\"\"This method is called to derive the key. The default key\n derivation choices can be overridden here. Key derivation is not\n intended to be used as a security method to make a complex key\n out of a short password. Instead you should use large random\n secret keys.\n\n :param secret_key: A specific secret key to derive from.\n Defaults to the last item in :attr:`secret_keys`.\n\n .. versionchanged:: 2.0\n Added the ``secret_key`` parameter.\n \"\"\"\n if secret_key is None:\n secret_key = self.secret_keys[-1]\n else:\n secret_key = want_bytes(secret_key)\n\n if self.key_derivation == \"concat\":\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\n elif self.key_derivation == \"django-concat\":\n return t.cast(\n bytes, self.digest_method(self.salt + b\"signer\" + secret_key).digest()\n )\n elif self.key_derivation == \"hmac\":\n mac = hmac.new(secret_key, digestmod=self.digest_method)\n mac.update(self.salt)\n return mac.digest()\n elif self.key_derivation == \"none\":\n return secret_key\n else:\n raise TypeError(\"Unknown key derivation method\")\n\n def get_signature(self, value: str | bytes) -> bytes:\n \"\"\"Returns the signature for the given value.\"\"\"\n value = want_bytes(value)\n key = self.derive_key()\n sig = self.algorithm.get_signature(key, value)\n return base64_encode(sig)\n\n def sign(self, value: str | bytes) -> bytes:\n \"\"\"Signs the given string.\"\"\"\n value = want_bytes(value)\n return value + self.sep + self.get_signature(value)\n\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\n \"\"\"Verifies the signature for the given value.\"\"\"\n try:\n sig = base64_decode(sig)\n except Exception:\n return False\n\n value = want_bytes(value)\n\n for secret_key in reversed(self.secret_keys):\n key = self.derive_key(secret_key)\n\n if self.algorithm.verify_signature(key, value, sig):\n return True\n\n return False\n\n def unsign(self, signed_value: str | bytes) -> bytes:\n \"\"\"Unsigns the given string.\"\"\"\n signed_value = want_bytes(signed_value)\n\n if self.sep not in signed_value:\n raise BadSignature(f\"No {self.sep!r} found in value\")\n\n value, sig = signed_value.rsplit(self.sep, 1)\n\n if self.verify_signature(value, sig):\n return value\n\n raise BadSignature(f\"Signature {sig!r} does not match\", payload=value)\n\n def validate(self, signed_value: str | bytes) -> bool:\n \"\"\"Only validates the given signed value. Returns ``True`` if\n the signature exists and is valid.\n \"\"\"\n try:\n self.unsign(signed_value)\n return True\n except BadSignature:\n return False\n\n[end of src/itsdangerous/signer.py]","filename":"src/itsdangerous/signer.py","id":"42"}],"string":"[\n {\n \"content\": \"How to contribute to ItsDangerous\\n=================================\\n\\nThank you for considering contributing to ItsDangerous!\\n\\n\\nSupport questions\\n-----------------\\n\\nPlease don't use the issue tracker for this. The issue tracker is a\\ntool to address bugs and feature requests in ItsDangerous itself. Use\\none of the following resources for questions about using ItsDangerous or\\nissues with your own code:\\n\\n- The ``#get-help`` channel on our Discord chat:\\n https://discord.gg/pallets\\n- The mailing list flask@python.org for long term discussion or larger\\n issues.\\n- Ask on `Stack Overflow`_. Search with Google first using:\\n ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}``\\n\\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent\\n\\n\\nReporting issues\\n----------------\\n\\nInclude the following information in your post:\\n\\n- Describe what you expected to happen.\\n- If possible, include a `minimal reproducible example`_ to help us\\n identify the issue. This also helps check that the issue is not with\\n your own code.\\n- Describe what actually happened. Include the full traceback if there\\n was an exception.\\n- List your Python and ItsDangerous versions. If possible, check if\\n this issue is already fixed in the latest releases or the latest\\n code in the repository.\\n\\n.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example\\n\\n\\nSubmitting patches\\n------------------\\n\\nIf there is not an open issue for what you want to submit, prefer\\nopening one for discussion before working on a PR. You can work on any\\nissue that doesn't have an open PR linked to it or a maintainer assigned\\nto it. These show up in the sidebar. No need to ask if you can work on\\nan issue that interests you.\\n\\nInclude the following in your patch:\\n\\n- Use `Black`_ to format your code. This and other tools will run\\n automatically if you install `pre-commit`_ using the instructions\\n below.\\n- Include tests if your patch adds or changes code. Make sure the test\\n fails without your patch.\\n- Update any relevant docs pages and docstrings. Docs pages and\\n docstrings should be wrapped at 72 characters.\\n- Add an entry in ``CHANGES.rst``. Use the same style as other\\n entries. Also include ``.. versionchanged::`` inline changelogs in\\n relevant docstrings.\\n\\n.. _Black: https://black.readthedocs.io\\n.. _pre-commit: https://pre-commit.com\\n\\n\\nFirst time setup\\n~~~~~~~~~~~~~~~~\\n\\n- Download and install the `latest version of git`_.\\n- Configure git with your `username`_ and `email`_.\\n\\n .. code-block:: text\\n\\n $ git config --global user.name 'your name'\\n $ git config --global user.email 'your email'\\n\\n- Make sure you have a `GitHub account`_.\\n- Fork ItsDangerous to your GitHub account by clicking the `Fork`_\\n button.\\n- `Clone`_ the main repository locally.\\n\\n .. code-block:: text\\n\\n $ git clone https://github.com/pallets/itsdangerous\\n $ cd itsdangerous\\n\\n- Add your fork as a remote to push your work to. Replace\\n ``{username}`` with your username. This names the remote \\\"fork\\\", the\\n default Pallets remote is \\\"origin\\\".\\n\\n .. code-block:: text\\n\\n $ git remote add fork https://github.com/{username}/itsdangerous\\n\\n- Create a virtualenv.\\n\\n .. code-block:: text\\n\\n $ python3 -m venv env\\n $ . env/bin/activate\\n\\n On Windows, activating is different.\\n\\n .. code-block:: text\\n\\n > env\\\\Scripts\\\\activate\\n\\n- Install the development dependencies, then install ItsDangerous in\\n editable mode.\\n\\n .. code-block:: text\\n\\n $ pip install -r requirements/dev.txt && pip install -e .\\n\\n- Install the pre-commit hooks.\\n\\n .. code-block:: text\\n\\n $ pre-commit install\\n\\n.. _latest version of git: https://git-scm.com/downloads\\n.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git\\n.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address\\n.. _GitHub account: https://github.com/join\\n.. _Fork: https://github.com/pallets/itsdangerous/fork\\n.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork\\n\\n\\nStart coding\\n~~~~~~~~~~~~\\n\\n- Create a branch to identify the issue you would like to work on. If\\n you're submitting a bug or documentation fix, branch off of the\\n latest \\\".x\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/2.0.x\\n\\n If you're submitting a feature addition or change, branch off of the\\n \\\"main\\\" branch.\\n\\n .. code-block:: text\\n\\n $ git fetch origin\\n $ git checkout -b your-branch-name origin/main\\n\\n- Using your favorite editor, make your changes,\\n `committing as you go`_.\\n- Include tests that cover any code changes you make. Make sure the\\n test fails without your patch. Run the tests as described below.\\n- Push your commits to your fork on GitHub and\\n `create a pull request`_. Link to the issue being addressed with\\n ``fixes #123`` in the pull request.\\n\\n .. code-block:: text\\n\\n $ git push --set-upstream fork your-branch-name\\n\\n.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes\\n.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request\\n\\n\\nRunning the tests\\n~~~~~~~~~~~~~~~~~\\n\\nRun the basic test suite with pytest.\\n\\n.. code-block:: text\\n\\n $ pytest\\n\\nThis runs the tests for the current environment, which is usually\\nsufficient. CI will run the full suite when you submit your pull\\nrequest. You can run the full test suite with tox if you don't want to\\nwait.\\n\\n.. code-block:: text\\n\\n $ tox\\n\\n\\nRunning test coverage\\n~~~~~~~~~~~~~~~~~~~~~\\n\\nGenerating a report of lines that do not have test coverage can indicate\\nwhere to start contributing. Run ``pytest`` using ``coverage`` and\\ngenerate a report.\\n\\n.. code-block:: text\\n\\n $ pip install coverage\\n $ coverage run -m pytest\\n $ coverage html\\n\\nOpen ``htmlcov/index.html`` in your browser to explore the report.\\n\\nRead more about `coverage <https://coverage.readthedocs.io>`__.\\n\\n\\nBuilding the docs\\n~~~~~~~~~~~~~~~~~\\n\\nBuild the docs in the ``docs`` directory using Sphinx.\\n\\n.. code-block:: text\\n\\n $ cd docs\\n $ make html\\n\\nOpen ``_build/html/index.html`` in your browser to view the docs.\\n\\nRead more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.\\n\\n[end of CONTRIBUTING.rst]\",\n \"filename\": \"CONTRIBUTING.rst\",\n \"id\": \"0\"\n },\n {\n \"content\": \"repos:\\n - repo: https://github.com/astral-sh/ruff-pre-commit\\n rev: v0.7.1\\n hooks:\\n - id: ruff\\n - id: ruff-format\\n - repo: https://github.com/pre-commit/pre-commit-hooks\\n rev: v5.0.0\\n hooks:\\n - id: check-merge-conflict\\n - id: debug-statements\\n - id: fix-byte-order-marker\\n - id: trailing-whitespace\\n - id: end-of-file-fixer\\n\\n[end of .pre-commit-config.yaml]\",\n \"filename\": \".pre-commit-config.yaml\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[project]\\nname = \\\"itsdangerous\\\"\\nversion = \\\"2.2.0\\\"\\ndescription = \\\"Safely pass data to untrusted environments and back.\\\"\\nreadme = \\\"README.md\\\"\\nlicense = { file = \\\"LICENSE.txt\\\" }\\nmaintainers = [{ name = \\\"Pallets\\\", email = \\\"contact@palletsprojects.com\\\" }]\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"License :: OSI Approved :: BSD License\\\",\\n \\\"Operating System :: OS Independent\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Typing :: Typed\\\",\\n]\\nrequires-python = \\\">=3.8\\\"\\n\\n[project.urls]\\nDonate = \\\"https://palletsprojects.com/donate\\\"\\nDocumentation = \\\"https://itsdangerous.palletsprojects.com/\\\"\\nChanges = \\\"https://itsdangerous.palletsprojects.com/changes/\\\"\\nSource = \\\"https://github.com/pallets/itsdangerous/\\\"\\nChat = \\\"https://discord.gg/pallets\\\"\\n\\n[build-system]\\nrequires = [\\\"flit_core<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.module]\\nname = \\\"itsdangerous\\\"\\n\\n[tool.flit.sdist]\\ninclude = [\\n \\\"docs/\\\",\\n \\\"requirements/\\\",\\n \\\"tests/\\\",\\n \\\"CHANGES.rst\\\",\\n \\\"tox.ini\\\",\\n]\\nexclude = [\\n \\\"docs/_build/\\\",\\n]\\n\\n[tool.pytest.ini_options]\\ntestpaths = [\\\"tests\\\"]\\nfilterwarnings = [\\n \\\"error\\\",\\n]\\n\\n[tool.coverage.run]\\nbranch = true\\nsource = [\\\"itsdangerous\\\", \\\"tests\\\"]\\n\\n[tool.coverage.paths]\\nsource = [\\\"src\\\", \\\"*/site-packages\\\"]\\n\\n[tool.mypy]\\npython_version = \\\"3.8\\\"\\nfiles = [\\\"src/itsdangerous\\\"]\\nshow_error_codes = true\\npretty = true\\nstrict = true\\n\\n[tool.pyright]\\npythonVersion = \\\"3.8\\\"\\ninclude = [\\\"src/itsdangerous\\\"]\\ntypeCheckingMode = \\\"basic\\\"\\n\\n[tool.ruff]\\nsrc = [\\\"src\\\"]\\nfix = true\\nshow-fixes = true\\noutput-format = \\\"full\\\"\\n\\n[tool.ruff.lint]\\nselect = [\\n \\\"B\\\", # flake8-bugbear\\n \\\"E\\\", # pycodestyle error\\n \\\"F\\\", # pyflakes\\n \\\"I\\\", # isort\\n \\\"UP\\\", # pyupgrade\\n \\\"W\\\", # pycodestyle warning\\n]\\n\\n[tool.ruff.lint.isort]\\nforce-single-line = true\\norder-by-type = false\\n\\n[tool.gha-update]\\ntag-only = [\\n \\\"slsa-framework/slsa-github-generator\\\",\\n]\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"root = true\\n\\n[*]\\nindent_style = space\\nindent_size = 4\\ninsert_final_newline = true\\ntrim_trailing_whitespace = true\\nend_of_line = lf\\ncharset = utf-8\\nmax_line_length = 88\\n\\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\\nindent_size = 2\\n\\n[end of .editorconfig]\",\n \"filename\": \".editorconfig\",\n \"id\": \"3\"\n },\n {\n \"content\": \"# ItsDangerous\\n\\n... so better sign this\\n\\nVarious helpers to pass data to untrusted environments and to get it\\nback safe and sound. Data is cryptographically signed to ensure that a\\ntoken has not been tampered with.\\n\\nIt's possible to customize how data is serialized. Data is compressed as\\nneeded. A timestamp can be added and verified automatically while\\nloading a token.\\n\\n\\n## A Simple Example\\n\\nHere's how you could generate a token for transmitting a user's id and\\nname between web requests.\\n\\n```python\\nfrom itsdangerous import URLSafeSerializer\\nauth_s = URLSafeSerializer(\\\"secret key\\\", \\\"auth\\\")\\ntoken = auth_s.dumps({\\\"id\\\": 5, \\\"name\\\": \\\"itsdangerous\\\"})\\n\\nprint(token)\\n# eyJpZCI6NSwibmFtZSI6Iml0c2Rhbmdlcm91cyJ9.6YP6T0BaO67XP--9UzTrmurXSmg\\n\\ndata = auth_s.loads(token)\\nprint(data[\\\"name\\\"])\\n# itsdangerous\\n```\\n\\n\\n## Donate\\n\\nThe Pallets organization develops and supports ItsDangerous and other\\npopular packages. In order to grow the community of contributors and\\nusers, and allow the maintainers to devote more time to the projects,\\n[please donate today][].\\n\\n[please donate today]: https://palletsprojects.com/donate\\n\\n[end of README.md]\",\n \"filename\": \"README.md\",\n \"id\": \"4\"\n },\n {\n \"content\": \"[tox]\\nenvlist =\\n py3{13,12,11,10,9,8}\\n pypy310\\n style\\n typing\\n docs\\nskip_missing_interpreters = true\\n\\n[testenv]\\npackage = wheel\\nwheel_build_env = .pkg\\nconstrain_package_deps = true\\nuse_frozen_constraints = true\\ndeps = -r requirements/tests.txt\\ncommands = pytest -v --tb=short --basetemp={envtmpdir} {posargs}\\n\\n[testenv:style]\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit run --all-files\\n\\n[testenv:typing]\\ndeps = -r requirements/typing.txt\\ncommands =\\n mypy\\n pyright\\n pyright --verifytypes itsdangerous --ignoreexternal\\n\\n[testenv:docs]\\ndeps = -r requirements/docs.txt\\ncommands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml\\n\\n[testenv:update-actions]\\nlabels = update\\ndeps = gha-update\\ncommands = gha-update\\n\\n[testenv:update-pre_commit]\\nlabels = update\\ndeps = pre-commit\\nskip_install = true\\ncommands = pre-commit autoupdate -j4\\n\\n[testenv:update-requirements]\\nlabels = update\\ndeps = pip-tools\\nskip_install = true\\nchange_dir = requirements\\ncommands =\\n pip-compile build.in -q {posargs:-U}\\n pip-compile docs.in -q {posargs:-U}\\n pip-compile tests.in -q {posargs:-U}\\n pip-compile typing.in -q {posargs:-U}\\n pip-compile dev.in -q {posargs:-U}\\n\\n[end of tox.ini]\",\n \"filename\": \"tox.ini\",\n \"id\": \"5\"\n },\n {\n \"content\": \"Copyright 2011 Pallets\\n\\nRedistribution and use in source and binary forms, with or without\\nmodification, are permitted provided that the following conditions are\\nmet:\\n\\n1. Redistributions of source code must retain the above copyright\\n notice, this list of conditions and the following disclaimer.\\n\\n2. 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\\n3. Neither the name of the copyright holder nor the names of its\\n contributors may be used to endorse or promote products derived from\\n this software without specific prior written permission.\\n\\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\\n\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\\n\\n[end of LICENSE.txt]\",\n \"filename\": \"LICENSE.txt\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Version 2.2.0\\n-------------\\n\\nReleased 2024-04-16\\n\\n- Drop support for Python 3.7. :pr:`372`\\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\\n :pr:`326`\\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\\n- Deprecate the ``__version__`` attribute. Use feature detection, or\\n ``importlib.metadata.version(\\\"itsdangerous\\\")``, instead. :issue:`371`\\n- ``Serializer`` and the return type of ``dumps`` is generic for type checking.\\n By default it is ``Serializer[str]`` and ``dumps`` returns a ``str``. If a\\n different ``serializer`` argument is given, it will try to infer the return\\n type of its ``dumps`` method. :issue:`347`\\n- The default ``hashlib.sha1`` may not be available in FIPS builds. Don't\\n access it at import time so the developer has time to change the default.\\n :issue:`375`\\n\\n\\nVersion 2.1.2\\n-------------\\n\\nReleased 2022-03-24\\n\\n- Handle date overflow in timed unsign on 32-bit systems. :pr:`299`\\n\\n\\nVersion 2.1.1\\n-------------\\n\\nReleased 2022-03-09\\n\\n- Handle date overflow in timed unsign. :pr:`296`\\n\\n\\nVersion 2.1.0\\n-------------\\n\\nReleased 2022-02-17\\n\\n- Drop support for Python 3.6. :pr:`272`\\n- Remove previously deprecated code. :pr:`273`\\n\\n - JWS functionality: Use a dedicated library such as Authlib\\n instead.\\n - ``import itsdangerous.json``: Import ``json`` from the standard\\n library instead.\\n\\n\\nVersion 2.0.1\\n-------------\\n\\nReleased 2021-05-18\\n\\n- Mark top-level names as exported so type checking understands\\n imports in user projects. :pr:`240`\\n- The ``salt`` argument to ``Serializer`` and ``Signer`` can be\\n ``None`` again. :issue:`237`\\n\\n\\nVersion 2.0.0\\n-------------\\n\\nReleased 2021-05-11\\n\\n- Drop support for Python 2 and 3.5.\\n- JWS support (``JSONWebSignatureSerializer``,\\n ``TimedJSONWebSignatureSerializer``) is deprecated. Use a dedicated\\n JWS/JWT library such as authlib instead. :issue:`129`\\n- Importing ``itsdangerous.json`` is deprecated. Import Python's\\n ``json`` module instead. :pr:`152`\\n- Simplejson is no longer used if it is installed. To use a different\\n library, pass it as ``Serializer(serializer=...)``. :issue:`146`\\n- ``datetime`` values are timezone-aware with ``timezone.utc``. Code\\n using ``TimestampSigner.unsign(return_timestamp=True)`` or\\n ``BadTimeSignature.date_signed`` may need to change. :issue:`150`\\n- If a signature has an age less than 0, it will raise\\n ``SignatureExpired`` rather than appearing valid. This can happen if\\n the timestamp offset is changed. :issue:`126`\\n- ``BadTimeSignature.date_signed`` is always a ``datetime`` object\\n rather than an ``int`` in some cases. :issue:`124`\\n- Added support for key rotation. A list of keys can be passed as\\n ``secret_key``, oldest to newest. The newest key is used for\\n signing, all keys are tried for unsigning. :pr:`141`\\n- Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``. :issue:`155`\\n- Add type information for static typing tools. :pr:`186`\\n\\n\\nVersion 1.1.0\\n-------------\\n\\nReleased 2018-10-26\\n\\n- Change default signing algorithm back to SHA-1. :pr:`113`\\n- Added a default SHA-512 fallback for users who used the yanked 1.0.0\\n release which defaulted to SHA-512. :pr:`114`\\n- Add support for fallback algorithms during deserialization to\\n support changing the default in the future without breaking existing\\n signatures. :pr:`113`\\n- Changed capitalization of packages back to lowercase as the change\\n in capitalization broke some tooling. :pr:`113`\\n\\n\\nVersion 1.0.0\\n-------------\\n\\nReleased 2018-10-18\\n\\nYANKED\\n\\n*Note*: This release was yanked from PyPI because it changed the default\\nalgorithm to SHA-512. This decision was reverted in 1.1.0 and it remains\\nat SHA1.\\n\\n- Drop support for Python 2.6 and 3.3.\\n- Refactor code from a single module to a package. Any object in the\\n API docs is still importable from the top-level ``itsdangerous``\\n name, but other imports will need to be changed. A future release\\n will remove many of these compatibility imports. :pr:`107`\\n- Optimize how timestamps are serialized and deserialized. :pr:`13`\\n- ``base64_decode`` raises ``BadData`` when it is passed invalid data.\\n :pr:`27`\\n- Ensure value is bytes when signing to avoid a ``TypeError`` on\\n Python 3. :issue:`29`\\n- Add a ``serializer_kwargs`` argument to ``Serializer``, which is\\n passed to ``dumps`` during ``dump_payload``. :pr:`36`\\n- More compact JSON dumps for unicode strings. :issue:`38`\\n- Use the full timestamp rather than an offset, allowing dates before\\n 2011. :issue:`46`\\n\\n To retain compatibility with signers from previous versions,\\n consider using `this shim <https://github.com/pallets/itsdangerous\\n /issues/120#issuecomment-456913331>`_ when unsigning.\\n- Detect a ``sep`` character that may show up in the signature itself\\n and raise a ``ValueError``. :issue:`62`\\n- Use a consistent signature for keyword arguments for\\n ``Serializer.load_payload`` in subclasses. :issue:`74`, :pr:`75`\\n- Change default intermediate hash from SHA-1 to SHA-512. :pr:`80`\\n- Convert JWS exp header to an int when loading. :pr:`99`\\n\\n\\nVersion 0.24\\n------------\\n\\nReleased 2014-03-28\\n\\n- Added a ``BadHeader`` exception that is used for bad headers that\\n replaces the old ``BadPayload`` exception that was reused in those\\n cases.\\n\\n\\nVersion 0.23\\n------------\\n\\nReleased 2013-08-08\\n\\n- Fixed a packaging mistake that caused the tests and license files to\\n not be included.\\n\\n\\nVersion 0.22\\n------------\\n\\nReleased 2013-07-03\\n\\n- Added support for ``TimedJSONWebSignatureSerializer``.\\n- Made it possible to override the signature verification function to\\n allow implementing asymmetrical algorithms.\\n\\n\\nVersion 0.21\\n------------\\n\\nReleased 2013-05-26\\n\\n- Fixed an issue on Python 3 which caused invalid errors to be\\n generated.\\n\\n\\nVersion 0.20\\n------------\\n\\nReleased 2013-05-23\\n\\n- Fixed an incorrect call into ``want_bytes`` that broke some uses of\\n ItsDangerous on Python 2.6.\\n\\n\\nVersion 0.19\\n------------\\n\\nReleased 2013-05-21\\n\\n- Dropped support for 2.5 and added support for 3.3.\\n\\n\\nVersion 0.18\\n------------\\n\\nReleased 2013-05-03\\n\\n- Added support for JSON Web Signatures (JWS).\\n\\n\\nVersion 0.17\\n------------\\n\\nReleased 2012-08-10\\n\\n- Fixed a name error when overriding the digest method.\\n\\n\\nVersion 0.16\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made it possible to pass unicode values to ``load_payload`` to make\\n it easier to debug certain things.\\n\\n\\nVersion 0.15\\n------------\\n\\nReleased 2012-07-11\\n\\n- Made standalone ``load_payload`` more robust by raising one specific\\n error if something goes wrong.\\n- Refactored exceptions to catch more cases individually, added more\\n attributes.\\n- Fixed an issue that caused ``load_payload`` not work in some\\n situations with timestamp based serializers\\n- Added an ``loads_unsafe`` method.\\n\\n\\nVersion 0.14\\n------------\\n\\nReleased 2012-06-29\\n\\n- API refactoring to support different key derivations.\\n- Added attributes to exceptions so that you can inspect the data even\\n if the signature check failed.\\n\\n\\nVersion 0.13\\n------------\\n\\nReleased 2012-06-10\\n\\n- Small API change that enables customization of the digest module.\\n\\n\\nVersion 0.12\\n------------\\n\\nReleased 2012-02-22\\n\\n- Fixed a problem with the local timezone being used for the epoch\\n calculation. This might invalidate some of your signatures if you\\n were not running in UTC timezone. You can revert to the old behavior\\n by monkey patching ``itsdangerous.EPOCH``.\\n\\n\\nVersion 0.11\\n------------\\n\\nReleased 2011-07-07\\n\\n- Fixed an uncaught value error.\\n\\n\\nVersion 0.10\\n------------\\n\\nReleased 2011-06-25\\n\\n- Refactored interface that the underlying serializers can be swapped\\n by passing in a module instead of having to override the payload\\n loaders and dumpers. This makes the interface more compatible with\\n Django's recent changes.\\n\\n[end of CHANGES.rst]\",\n \"filename\": \"CHANGES.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"version: 2\\nbuild:\\n os: ubuntu-22.04\\n tools:\\n python: '3.12'\\npython:\\n install:\\n - requirements: requirements/docs.txt\\n - method: pip\\n path: .\\nsphinx:\\n builder: dirhtml\\n fail_on_warning: true\\n\\n[end of .readthedocs.yaml]\",\n \"filename\": \".readthedocs.yaml\",\n \"id\": \"8\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile dev.in\\n#\\nalabaster==1.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nbabel==2.16.0\\n # via\\n # -r docs.txt\\n # sphinx\\ncachetools==5.5.0\\n # via tox\\ncertifi==2024.8.30\\n # via\\n # -r docs.txt\\n # requests\\ncfgv==3.4.0\\n # via pre-commit\\nchardet==5.2.0\\n # via tox\\ncharset-normalizer==3.4.0\\n # via\\n # -r docs.txt\\n # requests\\ncolorama==0.4.6\\n # via tox\\ndistlib==0.3.9\\n # via virtualenv\\ndocutils==0.21.2\\n # via\\n # -r docs.txt\\n # sphinx\\nfilelock==3.16.1\\n # via\\n # tox\\n # virtualenv\\nfreezegun==1.5.1\\n # via -r tests.txt\\nidentify==2.6.1\\n # via pre-commit\\nidna==3.10\\n # via\\n # -r docs.txt\\n # requests\\nimagesize==1.4.1\\n # via\\n # -r docs.txt\\n # sphinx\\niniconfig==2.0.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\njinja2==3.1.4\\n # via\\n # -r docs.txt\\n # sphinx\\nmarkupsafe==3.0.2\\n # via\\n # -r docs.txt\\n # jinja2\\nmypy==1.13.0\\n # via -r typing.txt\\nmypy-extensions==1.0.0\\n # via\\n # -r typing.txt\\n # mypy\\nnodeenv==1.9.1\\n # via\\n # -r typing.txt\\n # pre-commit\\n # pyright\\npackaging==24.1\\n # via\\n # -r docs.txt\\n # -r tests.txt\\n # -r typing.txt\\n # pallets-sphinx-themes\\n # pyproject-api\\n # pytest\\n # sphinx\\n # tox\\npallets-sphinx-themes==2.3.0\\n # via -r docs.txt\\nplatformdirs==4.3.6\\n # via\\n # tox\\n # virtualenv\\npluggy==1.5.0\\n # via\\n # -r tests.txt\\n # -r typing.txt\\n # pytest\\n # tox\\npre-commit==4.0.1\\n # via -r dev.in\\npygments==2.18.0\\n # via\\n # -r docs.txt\\n # sphinx\\npyproject-api==1.8.0\\n # via tox\\npyright==1.1.386\\n # via -r typing.txt\\npytest==8.3.3\\n # via\\n # -r tests.txt\\n # -r typing.txt\\npython-dateutil==2.9.0.post0\\n # via\\n # -r tests.txt\\n # freezegun\\npyyaml==6.0.2\\n # via pre-commit\\nrequests==2.32.3\\n # via\\n # -r docs.txt\\n # sphinx\\nsix==1.16.0\\n # via\\n # -r tests.txt\\n # python-dateutil\\nsnowballstemmer==2.2.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via\\n # -r docs.txt\\n # pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.txt\\nsphinxcontrib-qthelp==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via\\n # -r docs.txt\\n # sphinx\\ntox==4.23.2\\n # via -r dev.in\\ntyping-extensions==4.12.2\\n # via\\n # -r typing.txt\\n # mypy\\n # pyright\\nurllib3==2.2.3\\n # via\\n # -r docs.txt\\n # requests\\nvirtualenv==20.27.0\\n # via\\n # pre-commit\\n # tox\\n\\n[end of requirements/dev.txt]\",\n \"filename\": \"requirements/dev.txt\",\n \"id\": \"9\"\n },\n {\n \"content\": \"pallets-sphinx-themes\\nsphinx\\nsphinxcontrib-log-cabinet\\n\\n[end of requirements/docs.in]\",\n \"filename\": \"requirements/docs.in\",\n \"id\": \"10\"\n },\n {\n \"content\": \"build\\n\\n[end of requirements/build.in]\",\n \"filename\": \"requirements/build.in\",\n \"id\": \"11\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile typing.in\\n#\\niniconfig==2.0.0\\n # via pytest\\nmypy==1.13.0\\n # via -r typing.in\\nmypy-extensions==1.0.0\\n # via mypy\\nnodeenv==1.9.1\\n # via pyright\\npackaging==24.1\\n # via pytest\\npluggy==1.5.0\\n # via pytest\\npyright==1.1.386\\n # via -r typing.in\\npytest==8.3.3\\n # via -r typing.in\\ntyping-extensions==4.12.2\\n # via\\n # mypy\\n # pyright\\n\\n[end of requirements/typing.txt]\",\n \"filename\": \"requirements/typing.txt\",\n \"id\": \"12\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile build.in\\n#\\nbuild==1.2.2.post1\\n # via -r build.in\\npackaging==24.1\\n # via build\\npyproject-hooks==1.2.0\\n # via build\\n\\n[end of requirements/build.txt]\",\n \"filename\": \"requirements/build.txt\",\n \"id\": \"13\"\n },\n {\n \"content\": \"mypy\\npyright\\npytest\\n\\n[end of requirements/typing.in]\",\n \"filename\": \"requirements/typing.in\",\n \"id\": \"14\"\n },\n {\n \"content\": \"-r docs.txt\\n-r tests.txt\\n-r typing.txt\\npre-commit\\ntox\\n\\n[end of requirements/dev.in]\",\n \"filename\": \"requirements/dev.in\",\n \"id\": \"15\"\n },\n {\n \"content\": \"#\\n# This file is autogenerated by pip-compile with Python 3.13\\n# by the following command:\\n#\\n# pip-compile docs.in\\n#\\nalabaster==1.0.0\\n # via sphinx\\nbabel==2.16.0\\n # via sphinx\\ncertifi==2024.8.30\\n # via requests\\ncharset-normalizer==3.4.0\\n # via requests\\ndocutils==0.21.2\\n # via sphinx\\nidna==3.10\\n # via requests\\nimagesize==1.4.1\\n # via sphinx\\njinja2==3.1.4\\n # via sphinx\\nmarkupsafe==3.0.2\\n # via jinja2\\npackaging==24.1\\n # via\\n # pallets-sphinx-themes\\n # sphinx\\npallets-sphinx-themes==2.3.0\\n # via -r docs.in\\npygments==2.18.0\\n # via sphinx\\nrequests==2.32.3\\n # via sphinx\\nsnowballstemmer==2.2.0\\n # via sphinx\\nsphinx==8.1.3\\n # via\\n # -r docs.in\\n # pallets-sphinx-themes\\n # sphinx-notfound-page\\n # sphinxcontrib-log-cabinet\\nsphinx-notfound-page==1.0.4\\n # via pallets-sphinx-themes\\nsphinxcontrib-applehelp==2.0.0\\n # via sphinx\\nsphinxcontrib-devhelp==2.0.0\\n # via sphinx\\nsphinxcontrib-htmlhelp==2.1.0\\n # via sphinx\\nsphinxcontrib-jsmath==1.0.1\\n # via sphinx\\nsphinxcontrib-log-cabinet==1.0.1\\n # via -r docs.in\\nsphinxcontrib-qthelp==2.0.0\\n # via sphinx\\nsphinxcontrib-serializinghtml==2.0.0\\n # via sphinx\\nurllib3==2.2.3\\n # via requests\\n\\n[end of requirements/docs.txt]\",\n \"filename\": \"requirements/docs.txt\",\n \"id\": \"16\"\n },\n {\n \"content\": \".. rst-class:: hide-header\\n\\nItsDangerous\\n============\\n\\n.. image:: _static/itsdangerous-logo.png\\n :align: center\\n :target: https://palletsprojects.com/p/itsdangerous/\\n\\nSometimes you want to send some data to untrusted environments, then get\\nit back later. To do this safely, the data must be signed to detect\\nchanges.\\n\\nGiven a key only you know, you can cryptographically sign your data and\\nhand it over to someone else. When you get the data back you can ensure\\nthat nobody tampered with it.\\n\\nThe receiver can see the data, but they can not modify it unless they\\nalso have your key. So if you keep the key secret and complex, you will\\nbe fine.\\n\\n\\nInstalling\\n----------\\n\\nInstall and update using `pip`_:\\n\\n.. code-block:: text\\n\\n pip install -U itsdangerous\\n\\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\\n\\n\\nExample Use Cases\\n-----------------\\n\\n- Sign a user ID in a URL and email it to them to unsubscribe from a\\n newsletter. This way you don't need to generate one-time tokens and\\n store them in the database. Same thing with any kind of activation\\n link for accounts and similar things.\\n- Signed objects can be stored in cookies or other untrusted sources\\n which means you don't need to have sessions stored on the server,\\n which reduces the number of necessary database queries.\\n- Signed information can safely do a round trip between server and\\n client in general which makes them useful for passing server-side\\n state to a client and then back.\\n\\n\\nTable of Contents\\n-----------------\\n\\n.. toctree::\\n\\n concepts\\n serializer\\n signer\\n exceptions\\n timed\\n url_safe\\n encoding\\n license\\n changes\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"17\"\n },\n {\n \"content\": \".. module:: itsdangerous.serializer\\n\\nSerialization Interface\\n=======================\\n\\nThe :doc:`/signer` only signs bytes. To sign other types, the\\n:class:`Serializer` class provides a ``dumps``/``loads`` interface\\nsimilar to Python's :mod:`json` module, which serializes the object to a\\nstring then signs that.\\n\\nUse :meth:`~Serializer.dumps` to serialize and sign the data:\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n s = Serializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n b'[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo'\\n\\nUse :meth:`~Serializer.loads` to verify the signature and deserialize\\nthe data.\\n\\n.. code-block:: python\\n\\n s.loads('[1, 2, 3, 4].r7R9RhGgDPvvWl3iNzLuIIfELmo')\\n [1, 2, 3, 4]\\n\\nBy default, data is serialized to JSON with the built-in :mod:`json`\\nmodule. This internal serializer can be changed by subclassing.\\n\\nTo record and validate the age of the signature, see :doc:`/timed`.\\nTo serialize to a format that is safe to use in URLs, see\\n:doc:`/url_safe`.\\n\\n\\nResponding to Failure\\n---------------------\\n\\nExceptions have helpful attributes which allow you to inspect the\\npayload if the signature check failed. This has to be done with extra\\ncare because at that point you know that someone tampered with your data\\nbut it might be useful for debugging purposes.\\n\\n.. code-block:: python\\n\\n from itsdangerous.serializer import Serializer\\n from itsdangerous.exc import BadSignature, BadData\\n\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n decoded_payload = None\\n\\n try:\\n decoded_payload = s.loads(data)\\n # This payload is decoded and safe\\n except BadSignature as e:\\n if e.payload is not None:\\n try:\\n decoded_payload = s.load_payload(e.payload)\\n except BadData:\\n pass\\n # This payload is decoded but unsafe because someone\\n # tampered with the signature. The decode (load_payload)\\n # step is explicit because it might be unsafe to unserialize\\n # the payload (think pickle instead of json!)\\n\\nIf you don't want to inspect attributes to figure out what exactly went\\nwrong you can also use :meth:`~Serializer.loads_unsafe`:\\n\\n.. code-block:: python\\n\\n sig_okay, payload = s.loads_unsafe(data)\\n\\nThe first item in the returned tuple is a boolean that indicates if the\\nsignature was correct.\\n\\n\\nFallback Signers\\n----------------\\n\\nYou may want to upgrade the signing parameters without invalidating\\nexisting signatures immediately. For example, you may decide that you\\nwant to use a different digest method. New signatures should use the new\\nmethod, but old signatures should still validate.\\n\\nA list of ``fallback_signers`` can be given that will be tried if\\nunsigning with the current signer fails. Each item in the list can be:\\n\\n- A dict of ``signer_kwargs`` to instantiate the ``signer`` class\\n passed to the serializer.\\n- A :class:`~itsdangerous.signer.Signer` class to instantiated with\\n the ``secret_key``, ``salt``, and ``signer_kwargs`` passed to the\\n serializer.\\n- A tuple of ``(signer_class, signer_kwargs)`` to instantiate the\\n given class with the given args.\\n\\nFor example, this is a serializer that signs using SHA-512, but will\\nunsign using either SHA-512 or SHA-1:\\n\\n.. code-block:: python\\n\\n s = Serializer(\\n signer_kwargs={\\\"digest_method\\\": hashlib.sha512},\\n fallback_signers=[{\\\"digest_method\\\": hashlib.sha1}]\\n )\\n\\n\\n\\nAPI\\n---\\n\\n.. autoclass:: Serializer\\n :members:\\n\\n[end of docs/serializer.rst]\",\n \"filename\": \"docs/serializer.rst\",\n \"id\": \"18\"\n },\n {\n \"content\": \".. module:: itsdangerous.signer\\n\\nSigning Interface\\n=================\\n\\nThe most basic interface is the signing interface. The :class:`Signer`\\nclass can be used to attach a signature to a specific string:\\n\\n.. code-block:: python\\n\\n from itsdangerous import Signer\\n s = Signer(\\\"secret-key\\\")\\n s.sign(\\\"my string\\\")\\n b'my string.wh6tMHxLgJqB6oY1uT73iMlyrOA'\\n\\nThe signature is appended to the string, separated by a dot. To validate\\nthe string, use the :meth:`~Signer.unsign` method:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"my string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n b'my string'\\n\\nIf unicode strings are provided, an implicit encoding to UTF-8 happens.\\nHowever after unsigning you won't be able to tell if it was unicode or\\na bytestring.\\n\\nIf the value is changed, the signature will no longer match, and\\nunsigning will raise a :exc:`~itsdangerous.exc.BadSignature` exception:\\n\\n.. code-block:: python\\n\\n s.unsign(b\\\"different string.wh6tMHxLgJqB6oY1uT73iMlyrOA\\\")\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nTo record and validate the age of a signature, see :doc:`/timed`.\\n\\n.. autoclass:: Signer\\n :members:\\n\\n\\nSigning Algorithms\\n------------------\\n\\n.. autoclass:: NoneAlgorithm\\n\\n.. autoclass:: HMACAlgorithm\\n\\n[end of docs/signer.rst]\",\n \"filename\": \"docs/signer.rst\",\n \"id\": \"19\"\n },\n {\n \"content\": \"General Concepts\\n================\\n\\n\\nSerializer vs Signer\\n--------------------\\n\\nItsDangerous provides two levels of data handling. The :doc:`/signer` is\\nthe basic system that signs a given ``bytes`` value based on the given\\nsigning parameters. The :doc:`/serializer` wraps a signer to enable\\nserializing and signing other data besides ``bytes``.\\n\\nTypically, you'll want to use a serializer, not a signer. You can\\nconfigure the signing parameters through the serializer, and even\\nprovide fallback signers to upgrade old tokens to new parameters.\\n\\n\\nThe Secret Key\\n--------------\\n\\nSignatures are secured by the ``secret_key``. Typically one secret key\\nis used with all signers, and the salt is used to distinguish different\\ncontexts. Changing the secret key will invalidate existing tokens.\\n\\nIt should be a long random string of bytes. This value must be kept\\nsecret and should not be saved in source code or committed to version\\ncontrol. If an attacker learns the secret key, they can change and\\nresign data to look valid. If you suspect this happened, change the\\nsecret key to invalidate existing tokens.\\n\\nOne way to keep the secret key separate is to read it from an\\nenvironment variable. When deploying for the first time, generate a key\\nand set the environment variable when running the application. All\\nprocess managers (like systemd) and hosting services have a way to\\nspecify environment variables.\\n\\n.. code-block:: python\\n\\n import os\\n from itsdangerous.serializer import Serializer\\n SECRET_KEY = os.environ.get(\\\"SECRET_KEY\\\")\\n s = Serializer(SECRET_KEY)\\n\\n.. code-block:: text\\n\\n $ export SECRET_KEY=\\\"base64 encoded random bytes\\\"\\n $ python application.py\\n\\nOne way to generate a key is to use :func:`os.urandom`.\\n\\n.. code-block:: text\\n\\n $ python3 -c 'import os; print(os.urandom(16).hex())'\\n\\n\\nThe Salt\\n--------\\n\\nThe salt is combined with the secret key to derive a unique key for\\ndistinguishing different contexts. Unlike the secret key, the salt\\ndoesn't have to be random, and can be saved in code. It only has to be\\nunique between contexts, not private.\\n\\nFor example, you want to email activation links to activate user\\naccounts, and upgrade links to upgrade users to a paid accounts. If all\\nyou sign is the user id, and you don't use different salts, a user could\\nreuse the token from the activation link to upgrade the account. If you\\nuse different salts, the signatures will be different and will not be\\nvalid in the other context.\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n\\n s1 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"activate\\\")\\n s1.dumps(42)\\n 'NDI.MHQqszw6Wc81wOBQszCrEE_RlzY'\\n\\n s2 = URLSafeSerializer(\\\"secret-key\\\", salt=\\\"upgrade\\\")\\n s2.dumps(42)\\n 'NDI.c0MpsD6gzpilOAeUPra3NShPXsE'\\n\\nThe second serializer can't load data dumped with the first because the\\nsalts differ.\\n\\n.. code-block:: python\\n\\n s2.loads(s1.dumps(42))\\n Traceback (most recent call last):\\n ...\\n BadSignature: Signature does not match\\n\\nOnly the serializer with the same salt can load the data.\\n\\n.. code-block:: python\\n\\n s2.loads(s2.dumps(42))\\n 42\\n\\n\\nKey Rotation\\n------------\\n\\nKey rotation can provide an extra layer of mitigation against an\\nattacker discovering a secret key. A rotation system will keep a list of\\nvalid keys, generating a new key and removing the oldest key\\nperiodically. If it takes four weeks for an attacker to crack a key, but\\nthe key is rotated out after three weeks, they will not be able to use\\nany keys they crack. However, if a user doesn't refresh their token\\nwithin three weeks it will be invalid too.\\n\\nThe system that generates and maintains this list is outside the scope\\nof ItsDangerous, but ItsDangerous does support validating against a list\\nof keys.\\n\\nInstead of passing a single key, you can pass a list of keys, oldest to\\nnewest. When signing the last (newest) key will be used, and when\\nvalidating each key will be tried from newest to oldest before raising\\na validation error.\\n\\n.. code-block:: python\\n\\n SECRET_KEYS = [\\\"2b9cd98e\\\", \\\"169d7886\\\", \\\"b6af09f5\\\"]\\n\\n # sign some data with the latest key\\n s = Serializer(SECRET_KEYS)\\n t = s.dumps({\\\"id\\\": 42})\\n\\n # rotate a new key in and the oldest key out\\n SECRET_KEYS.append(\\\"cf9b3588\\\")\\n del SECRET_KEYS[0]\\n\\n s = Serializer(SECRET_KEYS)\\n s.loads(t) # valid even though it was signed with a previous key\\n\\n\\nDigest Method Security\\n----------------------\\n\\nA signer is configured with a ``digest_method``, a hash function that\\nis used as an intermediate step when generating the HMAC signature. The\\ndefault method is :func:`hashlib.sha1`. Occasionally, users are\\nconcerned about this default because they have heard about hash\\ncollisions with SHA-1.\\n\\nWhen used as the intermediate, iterated step in HMAC, SHA-1 is not\\ninsecure. In fact, even MD5 is still secure in HMAC. The security of the\\nhash alone doesn't apply when used in HMAC.\\n\\nIf a project considers SHA-1 a risk anyway, they can configure the\\nsigner with a different digest method such as :func:`hashlib.sha512`.\\nA fallback signer for SHA-1 can be configured so that old tokens will be\\nupgraded. SHA-512 produces a longer hash, so tokens will take up more\\nspace, which is relevant in cookies and URLs.\\n\\n[end of docs/concepts.rst]\",\n \"filename\": \"docs/concepts.rst\",\n \"id\": \"20\"\n },\n {\n \"content\": \".. module:: itsdangerous.url_safe\\n\\nURL Safe Serialization\\n======================\\n\\nOften it is helpful if you can pass these trusted strings in places\\nwhere you only have a limited set of characters available. Because of\\nthis, ItsDangerous also provides URL safe serializers:\\n\\n.. code-block:: python\\n\\n from itsdangerous.url_safe import URLSafeSerializer\\n s = URLSafeSerializer(\\\"secret-key\\\")\\n s.dumps([1, 2, 3, 4])\\n 'WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo'\\n s.loads(\\\"WzEsMiwzLDRd.wSPHqC0gR7VUqivlSukJ0IeTDgo\\\")\\n [1, 2, 3, 4]\\n\\n.. autoclass:: URLSafeSerializer\\n\\n.. autoclass:: URLSafeTimedSerializer\\n\\n[end of docs/url_safe.rst]\",\n \"filename\": \"docs/url_safe.rst\",\n \"id\": \"21\"\n },\n {\n \"content\": \".. module:: itsdangerous.encoding\\n\\nEncoding Utilities\\n==================\\n\\n.. autofunction:: base64_encode\\n\\n.. autofunction:: base64_decode\\n\\n[end of docs/encoding.rst]\",\n \"filename\": \"docs/encoding.rst\",\n \"id\": \"22\"\n },\n {\n \"content\": \"# Minimal makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nSOURCEDIR = .\\nBUILDDIR = _build\\n\\n# Put it first so that \\\"make\\\" without argument is like \\\"make help\\\".\\nhelp:\\n\\t@$(SPHINXBUILD) -M help \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n.PHONY: help Makefile\\n\\n# Catch-all target: route all unknown targets to Sphinx using the new\\n# \\\"make mode\\\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\\n%: Makefile\\n\\t@$(SPHINXBUILD) -M $@ \\\"$(SOURCEDIR)\\\" \\\"$(BUILDDIR)\\\" $(SPHINXOPTS) $(O)\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"23\"\n },\n {\n \"content\": \"from pallets_sphinx_themes import get_version\\nfrom pallets_sphinx_themes import ProjectLink\\n\\n# Project --------------------------------------------------------------\\n\\nproject = \\\"ItsDangerous\\\"\\ncopyright = \\\"2011 Pallets\\\"\\nauthor = \\\"Pallets\\\"\\nrelease, version = get_version(\\\"itsdangerous\\\")\\n\\n# General --------------------------------------------------------------\\n\\ndefault_role = \\\"code\\\"\\nextensions = [\\n \\\"sphinx.ext.autodoc\\\",\\n \\\"sphinx.ext.extlinks\\\",\\n \\\"sphinx.ext.intersphinx\\\",\\n \\\"sphinxcontrib.log_cabinet\\\",\\n \\\"pallets_sphinx_themes\\\",\\n]\\nautoclass_content = \\\"both\\\"\\nautodoc_member_order = \\\"bysource\\\"\\nautodoc_typehints = \\\"description\\\"\\nautodoc_preserve_defaults = True\\nextlinks = {\\n \\\"issue\\\": (\\\"https://github.com/pallets/itsdangerous/issues/%s\\\", \\\"#%s\\\"),\\n \\\"pr\\\": (\\\"https://github.com/pallets/itsdangerous/pull/%s\\\", \\\"#%s\\\"),\\n}\\nintersphinx_mapping = {\\n \\\"python\\\": (\\\"https://docs.python.org/3/\\\", None),\\n}\\n\\n# HTML -----------------------------------------------------------------\\n\\nhtml_theme = \\\"flask\\\"\\nhtml_theme_options = {\\\"index_sidebar_logo\\\": False}\\nhtml_context = {\\n \\\"project_links\\\": [\\n ProjectLink(\\\"Donate\\\", \\\"https://palletsprojects.com/donate\\\"),\\n ProjectLink(\\\"PyPI Releases\\\", \\\"https://pypi.org/project/itsdangerous/\\\"),\\n ProjectLink(\\\"Source Code\\\", \\\"https://github.com/pallets/itsdangerous/\\\"),\\n ProjectLink(\\\"Issue Tracker\\\", \\\"https://github.com/pallets/itsdangerous/issues/\\\"),\\n ProjectLink(\\\"Chat\\\", \\\"https://discord.gg/pallets\\\"),\\n ]\\n}\\nhtml_sidebars = {\\n \\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n \\\"**\\\": [\\\"localtoc.html\\\", \\\"relations.html\\\", \\\"searchbox.html\\\", \\\"ethicalads.html\\\"],\\n}\\nsinglehtml_sidebars = {\\\"index\\\": [\\\"project.html\\\", \\\"localtoc.html\\\", \\\"ethicalads.html\\\"]}\\nhtml_static_path = [\\\"_static\\\"]\\nhtml_favicon = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_logo = \\\"_static/itsdangerous-logo-sidebar.png\\\"\\nhtml_title = f\\\"{project} Documentation ({version})\\\"\\nhtml_show_sourcelink = False\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"24\"\n },\n {\n \"content\": \"@ECHO OFF\\n\\npushd %~dp0\\n\\nREM Command file for Sphinx documentation\\n\\nif \\\"%SPHINXBUILD%\\\" == \\\"\\\" (\\n\\tset SPHINXBUILD=sphinx-build\\n)\\nset SOURCEDIR=.\\nset BUILDDIR=_build\\n\\nif \\\"%1\\\" == \\\"\\\" goto help\\n\\n%SPHINXBUILD% >NUL 2>NUL\\nif errorlevel 9009 (\\n\\techo.\\n\\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\\n\\techo.installed, then set the SPHINXBUILD environment variable to point\\n\\techo.to the full path of the 'sphinx-build' executable. Alternatively you\\n\\techo.may add the Sphinx directory to PATH.\\n\\techo.\\n\\techo.If you don't have Sphinx installed, grab it from\\n\\techo.http://sphinx-doc.org/\\n\\texit /b 1\\n)\\n\\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\ngoto end\\n\\n:help\\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\\n\\n:end\\npopd\\n\\n[end of docs/make.bat]\",\n \"filename\": \"docs/make.bat\",\n \"id\": \"25\"\n },\n {\n \"content\": \".. module:: itsdangerous.timed\\n\\nSigning With Timestamps\\n=======================\\n\\nIf you want to expire signatures you can use the\\n:class:`TimestampSigner` class which adds timestamp information and\\nsigns it. On unsigning you can validate that the timestamp is not older\\nthan a given age.\\n\\n.. code-block:: python\\n\\n from itsdangerous import TimestampSigner\\n s = TimestampSigner('secret-key')\\n string = s.sign('foo')\\n\\n.. code-block:: python\\n\\n s.unsign(string, max_age=5)\\n Traceback (most recent call last):\\n ...\\n itsdangerous.exc.SignatureExpired: Signature age 15 > 5 seconds\\n\\n.. autoclass:: TimestampSigner\\n :members:\\n\\n.. autoclass:: TimedSerializer\\n :members:\\n\\n[end of docs/timed.rst]\",\n \"filename\": \"docs/timed.rst\",\n \"id\": \"26\"\n },\n {\n \"content\": \"BSD-3-Clause License\\n====================\\n\\n.. literalinclude:: ../LICENSE.txt\\n :language: text\\n\\n[end of docs/license.rst]\",\n \"filename\": \"docs/license.rst\",\n \"id\": \"27\"\n },\n {\n \"content\": \"Changes\\n=======\\n\\n.. include:: ../CHANGES.rst\\n\\n[end of docs/changes.rst]\",\n \"filename\": \"docs/changes.rst\",\n \"id\": \"28\"\n },\n {\n \"content\": \".. module:: itsdangerous.exc\\n\\nExceptions\\n==========\\n\\n.. autoexception:: BadData\\n :members:\\n\\n.. autoexception:: BadSignature\\n :members:\\n\\n.. autoexception:: BadTimeSignature\\n :members:\\n\\n.. autoexception:: SignatureExpired\\n :members:\\n\\n.. autoexception:: BadHeader\\n :members:\\n\\n.. autoexception:: BadPayload\\n :members:\\n\\n[end of docs/exceptions.rst]\",\n \"filename\": \"docs/exceptions.rst\",\n \"id\": \"29\"\n },\n {\n \"content\": \"#!/bin/bash\\nset -e\\npython3 -m venv --upgrade-deps .venv\\n. .venv/bin/activate\\npip install -r requirements/dev.txt\\npip install -e .\\npre-commit install --install-hooks\\n\\n[end of .devcontainer/on-create-command.sh]\",\n \"filename\": \".devcontainer/on-create-command.sh\",\n \"id\": \"30\"\n },\n {\n \"content\": \"{\\n \\\"name\\\": \\\"pallets/itsdangerous\\\",\\n \\\"image\\\": \\\"mcr.microsoft.com/devcontainers/python:3\\\",\\n \\\"customizations\\\": {\\n \\\"vscode\\\": {\\n \\\"settings\\\": {\\n \\\"python.defaultInterpreterPath\\\": \\\"${workspaceFolder}/.venv\\\",\\n \\\"python.terminal.activateEnvInCurrentTerminal\\\": true,\\n \\\"python.terminal.launchArgs\\\": [\\n \\\"-X\\\",\\n \\\"dev\\\"\\n ]\\n }\\n }\\n },\\n \\\"onCreateCommand\\\": \\\".devcontainer/on-create-command.sh\\\"\\n}\\n\\n[end of .devcontainer/devcontainer.json]\",\n \"filename\": \".devcontainer/devcontainer.json\",\n \"id\": \"31\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo-sidebar.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo-sidebar.png\",\n \"id\": \"32\"\n },\n {\n \"content\": \"None\\n[end of docs/_static/itsdangerous-logo.png]\",\n \"filename\": \"docs/_static/itsdangerous-logo.png\",\n \"id\": \"33\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport json as _json\\nimport typing as t\\n\\n\\nclass _CompactJSON:\\n \\\"\\\"\\\"Wrapper around json module that strips whitespace.\\\"\\\"\\\"\\n\\n @staticmethod\\n def loads(payload: str | bytes) -> t.Any:\\n return _json.loads(payload)\\n\\n @staticmethod\\n def dumps(obj: t.Any, **kwargs: t.Any) -> str:\\n kwargs.setdefault(\\\"ensure_ascii\\\", False)\\n kwargs.setdefault(\\\"separators\\\", (\\\",\\\", \\\":\\\"))\\n return _json.dumps(obj, **kwargs)\\n\\n[end of src/itsdangerous/_json.py]\",\n \"filename\": \"src/itsdangerous/_json.py\",\n \"id\": \"34\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport time\\nimport typing as t\\nfrom datetime import datetime\\nfrom datetime import timezone\\n\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import bytes_to_int\\nfrom .encoding import int_to_bytes\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\nfrom .exc import BadTimeSignature\\nfrom .exc import SignatureExpired\\nfrom .serializer import _TSerialized\\nfrom .serializer import Serializer\\nfrom .signer import Signer\\n\\n\\nclass TimestampSigner(Signer):\\n \\\"\\\"\\\"Works like the regular :class:`.Signer` but also records the time\\n of the signing and can be used to expire signatures. The\\n :meth:`unsign` method can raise :exc:`.SignatureExpired` if the\\n unsigning failed because the signature is expired.\\n \\\"\\\"\\\"\\n\\n def get_timestamp(self) -> int:\\n \\\"\\\"\\\"Returns the current timestamp. The function must return an\\n integer.\\n \\\"\\\"\\\"\\n return int(time.time())\\n\\n def timestamp_to_datetime(self, ts: int) -> datetime:\\n \\\"\\\"\\\"Convert the timestamp from :meth:`get_timestamp` into an\\n aware :class`datetime.datetime` in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n return datetime.fromtimestamp(ts, tz=timezone.utc)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string and also attaches time information.\\\"\\\"\\\"\\n value = want_bytes(value)\\n timestamp = base64_encode(int_to_bytes(self.get_timestamp()))\\n sep = want_bytes(self.sep)\\n value = value + sep + timestamp\\n return value + sep + self.get_signature(value)\\n\\n # Ignore overlapping signatures check, return_timestamp is the only\\n # parameter that affects the return type.\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[False] = False,\\n ) -> bytes: ...\\n\\n @t.overload\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: t.Literal[True] = True,\\n ) -> tuple[bytes, datetime]: ...\\n\\n def unsign(\\n self,\\n signed_value: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n ) -> tuple[bytes, datetime] | bytes:\\n \\\"\\\"\\\"Works like the regular :meth:`.Signer.unsign` but can also\\n validate the time. See the base docstring of the class for\\n the general behavior. If ``return_timestamp`` is ``True`` the\\n timestamp of the signature will be returned as an aware\\n :class:`datetime.datetime` object in UTC.\\n\\n .. versionchanged:: 2.0\\n The timestamp is returned as a timezone-aware ``datetime``\\n in UTC rather than a naive ``datetime`` assumed to be UTC.\\n \\\"\\\"\\\"\\n try:\\n result = super().unsign(signed_value)\\n sig_error = None\\n except BadSignature as e:\\n sig_error = e\\n result = e.payload or b\\\"\\\"\\n\\n sep = want_bytes(self.sep)\\n\\n # If there is no timestamp in the result there is something\\n # seriously wrong. In case there was a signature error, we raise\\n # that one directly, otherwise we have a weird situation in\\n # which we shouldn't have come except someone uses a time-based\\n # serializer on non-timestamp data, so catch that.\\n if sep not in result:\\n if sig_error:\\n raise sig_error\\n\\n raise BadTimeSignature(\\\"timestamp missing\\\", payload=result)\\n\\n value, ts_bytes = result.rsplit(sep, 1)\\n ts_int: int | None = None\\n ts_dt: datetime | None = None\\n\\n try:\\n ts_int = bytes_to_int(base64_decode(ts_bytes))\\n except Exception:\\n pass\\n\\n # Signature is *not* okay. Raise a proper error now that we have\\n # split the value and the timestamp.\\n if sig_error is not None:\\n if ts_int is not None:\\n try:\\n ts_dt = self.timestamp_to_datetime(ts_int)\\n except (ValueError, OSError, OverflowError) as exc:\\n # Windows raises OSError\\n # 32-bit raises OverflowError\\n raise BadTimeSignature(\\n \\\"Malformed timestamp\\\", payload=value\\n ) from exc\\n\\n raise BadTimeSignature(str(sig_error), payload=value, date_signed=ts_dt)\\n\\n # Signature was okay but the timestamp is actually not there or\\n # malformed. Should not happen, but we handle it anyway.\\n if ts_int is None:\\n raise BadTimeSignature(\\\"Malformed timestamp\\\", payload=value)\\n\\n # Check timestamp is not older than max_age\\n if max_age is not None:\\n age = self.get_timestamp() - ts_int\\n\\n if age > max_age:\\n raise SignatureExpired(\\n f\\\"Signature age {age} > {max_age} seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if age < 0:\\n raise SignatureExpired(\\n f\\\"Signature age {age} < 0 seconds\\\",\\n payload=value,\\n date_signed=self.timestamp_to_datetime(ts_int),\\n )\\n\\n if return_timestamp:\\n return value, self.timestamp_to_datetime(ts_int)\\n\\n return value\\n\\n def validate(self, signed_value: str | bytes, max_age: int | None = None) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\\"\\\"\\\"\\n try:\\n self.unsign(signed_value, max_age=max_age)\\n return True\\n except BadSignature:\\n return False\\n\\n\\nclass TimedSerializer(Serializer[_TSerialized]):\\n \\\"\\\"\\\"Uses :class:`TimestampSigner` instead of the default\\n :class:`.Signer`.\\n \\\"\\\"\\\"\\n\\n default_signer: type[TimestampSigner] = TimestampSigner\\n\\n def iter_unsigners(\\n self, salt: str | bytes | None = None\\n ) -> cabc.Iterator[TimestampSigner]:\\n return t.cast(\\\"cabc.Iterator[TimestampSigner]\\\", super().iter_unsigners(salt))\\n\\n # TODO: Signature is incompatible because parameters were added\\n # before salt.\\n\\n def loads( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n return_timestamp: bool = False,\\n salt: str | bytes | None = None,\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`, raises :exc:`.BadSignature` if the\\n signature validation fails. If a ``max_age`` is provided it will\\n ensure the signature is not older than that time in seconds. In\\n case the signature is outdated, :exc:`.SignatureExpired` is\\n raised. All arguments are forwarded to the signer's\\n :meth:`~TimestampSigner.unsign` method.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n base64d, timestamp = signer.unsign(\\n s, max_age=max_age, return_timestamp=True\\n )\\n payload = self.load_payload(base64d)\\n\\n if return_timestamp:\\n return payload, timestamp\\n\\n return payload\\n except SignatureExpired:\\n # The signature was unsigned successfully but was\\n # expired. Do not try the next signer.\\n raise\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def loads_unsafe( # type: ignore[override]\\n self,\\n s: str | bytes,\\n max_age: int | None = None,\\n salt: str | bytes | None = None,\\n ) -> tuple[bool, t.Any]:\\n return self._loads_unsafe_impl(s, salt, load_kwargs={\\\"max_age\\\": max_age})\\n\\n[end of src/itsdangerous/timed.py]\",\n \"filename\": \"src/itsdangerous/timed.py\",\n \"id\": \"35\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport base64\\nimport string\\nimport struct\\nimport typing as t\\n\\nfrom .exc import BadData\\n\\n\\ndef want_bytes(\\n s: str | bytes, encoding: str = \\\"utf-8\\\", errors: str = \\\"strict\\\"\\n) -> bytes:\\n if isinstance(s, str):\\n s = s.encode(encoding, errors)\\n\\n return s\\n\\n\\ndef base64_encode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 encode a string of bytes or text. The resulting bytes are\\n safe to use in URLs.\\n \\\"\\\"\\\"\\n string = want_bytes(string)\\n return base64.urlsafe_b64encode(string).rstrip(b\\\"=\\\")\\n\\n\\ndef base64_decode(string: str | bytes) -> bytes:\\n \\\"\\\"\\\"Base64 decode a URL-safe string of bytes or text. The result is\\n bytes.\\n \\\"\\\"\\\"\\n string = want_bytes(string, encoding=\\\"ascii\\\", errors=\\\"ignore\\\")\\n string += b\\\"=\\\" * (-len(string) % 4)\\n\\n try:\\n return base64.urlsafe_b64decode(string)\\n except (TypeError, ValueError) as e:\\n raise BadData(\\\"Invalid base64-encoded data\\\") from e\\n\\n\\n# The alphabet used by base64.urlsafe_*\\n_base64_alphabet = f\\\"{string.ascii_letters}{string.digits}-_=\\\".encode(\\\"ascii\\\")\\n\\n_int64_struct = struct.Struct(\\\">Q\\\")\\n_int_to_bytes = _int64_struct.pack\\n_bytes_to_int = t.cast(\\\"t.Callable[[bytes], tuple[int]]\\\", _int64_struct.unpack)\\n\\n\\ndef int_to_bytes(num: int) -> bytes:\\n return _int_to_bytes(num).lstrip(b\\\"\\\\x00\\\")\\n\\n\\ndef bytes_to_int(bytestr: bytes) -> int:\\n return _bytes_to_int(bytestr.rjust(8, b\\\"\\\\x00\\\"))[0]\\n\\n[end of src/itsdangerous/encoding.py]\",\n \"filename\": \"src/itsdangerous/encoding.py\",\n \"id\": \"36\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\n\\nfrom .encoding import base64_decode as base64_decode\\nfrom .encoding import base64_encode as base64_encode\\nfrom .encoding import want_bytes as want_bytes\\nfrom .exc import BadData as BadData\\nfrom .exc import BadHeader as BadHeader\\nfrom .exc import BadPayload as BadPayload\\nfrom .exc import BadSignature as BadSignature\\nfrom .exc import BadTimeSignature as BadTimeSignature\\nfrom .exc import SignatureExpired as SignatureExpired\\nfrom .serializer import Serializer as Serializer\\nfrom .signer import HMACAlgorithm as HMACAlgorithm\\nfrom .signer import NoneAlgorithm as NoneAlgorithm\\nfrom .signer import Signer as Signer\\nfrom .timed import TimedSerializer as TimedSerializer\\nfrom .timed import TimestampSigner as TimestampSigner\\nfrom .url_safe import URLSafeSerializer as URLSafeSerializer\\nfrom .url_safe import URLSafeTimedSerializer as URLSafeTimedSerializer\\n\\n\\ndef __getattr__(name: str) -> t.Any:\\n if name == \\\"__version__\\\":\\n import importlib.metadata\\n import warnings\\n\\n warnings.warn(\\n \\\"The '__version__' attribute is deprecated and will be removed in\\\"\\n \\\" ItsDangerous 2.3. Use feature detection or\\\"\\n \\\" 'importlib.metadata.version(\\\\\\\"itsdangerous\\\\\\\")' instead.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n return importlib.metadata.version(\\\"itsdangerous\\\")\\n\\n raise AttributeError(name)\\n\\n[end of src/itsdangerous/__init__.py]\",\n \"filename\": \"src/itsdangerous/__init__.py\",\n \"id\": \"37\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nimport zlib\\n\\nfrom ._json import _CompactJSON\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .exc import BadPayload\\nfrom .serializer import _PDataSerializer\\nfrom .serializer import Serializer\\nfrom .timed import TimedSerializer\\n\\n\\nclass URLSafeSerializerMixin(Serializer[str]):\\n \\\"\\\"\\\"Mixed in with a regular serializer it will attempt to zlib\\n compress the string to make it shorter if necessary. It will also\\n base64 encode the string so that it can safely be placed in a URL.\\n \\\"\\\"\\\"\\n\\n default_serializer: _PDataSerializer[str] = _CompactJSON\\n\\n def load_payload(\\n self,\\n payload: bytes,\\n *args: t.Any,\\n serializer: t.Any | None = None,\\n **kwargs: t.Any,\\n ) -> t.Any:\\n decompress = False\\n\\n if payload.startswith(b\\\".\\\"):\\n payload = payload[1:]\\n decompress = True\\n\\n try:\\n json = base64_decode(payload)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not base64 decode the payload because of an exception\\\",\\n original_error=e,\\n ) from e\\n\\n if decompress:\\n try:\\n json = zlib.decompress(json)\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not zlib decompress the payload before decoding the payload\\\",\\n original_error=e,\\n ) from e\\n\\n return super().load_payload(json, *args, **kwargs)\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n json = super().dump_payload(obj)\\n is_compressed = False\\n compressed = zlib.compress(json)\\n\\n if len(compressed) < (len(json) - 1):\\n json = compressed\\n is_compressed = True\\n\\n base64d = base64_encode(json)\\n\\n if is_compressed:\\n base64d = b\\\".\\\" + base64d\\n\\n return base64d\\n\\n\\nclass URLSafeSerializer(URLSafeSerializerMixin, Serializer[str]):\\n \\\"\\\"\\\"Works like :class:`.Serializer` but dumps and loads into a URL\\n safe string consisting of the upper and lowercase character of the\\n alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n\\nclass URLSafeTimedSerializer(URLSafeSerializerMixin, TimedSerializer[str]):\\n \\\"\\\"\\\"Works like :class:`.TimedSerializer` but dumps and loads into a\\n URL safe string consisting of the upper and lowercase character of\\n the alphabet as well as ``'_'``, ``'-'`` and ``'.'``.\\n \\\"\\\"\\\"\\n\\n[end of src/itsdangerous/url_safe.py]\",\n \"filename\": \"src/itsdangerous/url_safe.py\",\n \"id\": \"38\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport typing as t\\nfrom datetime import datetime\\n\\n\\nclass BadData(Exception):\\n \\\"\\\"\\\"Raised if bad data of any sort was encountered. This is the base\\n for all exceptions that ItsDangerous defines.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str):\\n super().__init__(message)\\n self.message = message\\n\\n def __str__(self) -> str:\\n return self.message\\n\\n\\nclass BadSignature(BadData):\\n \\\"\\\"\\\"Raised if a signature does not match.\\\"\\\"\\\"\\n\\n def __init__(self, message: str, payload: t.Any | None = None):\\n super().__init__(message)\\n\\n #: The payload that failed the signature test. In some\\n #: situations you might still want to inspect this, even if\\n #: you know it was tampered with.\\n #:\\n #: .. versionadded:: 0.14\\n self.payload: t.Any | None = payload\\n\\n\\nclass BadTimeSignature(BadSignature):\\n \\\"\\\"\\\"Raised if a time-based signature is invalid. This is a subclass\\n of :class:`BadSignature`.\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n date_signed: datetime | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the signature expired this exposes the date of when the\\n #: signature was created. This can be helpful in order to\\n #: tell the user how long a link has been gone stale.\\n #:\\n #: .. versionchanged:: 2.0\\n #: The datetime value is timezone-aware rather than naive.\\n #:\\n #: .. versionadded:: 0.14\\n self.date_signed = date_signed\\n\\n\\nclass SignatureExpired(BadTimeSignature):\\n \\\"\\\"\\\"Raised if a signature timestamp is older than ``max_age``. This\\n is a subclass of :exc:`BadTimeSignature`.\\n \\\"\\\"\\\"\\n\\n\\nclass BadHeader(BadSignature):\\n \\\"\\\"\\\"Raised if a signed header is invalid in some form. This only\\n happens for serializers that have a header that goes with the\\n signature.\\n\\n .. versionadded:: 0.24\\n \\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n message: str,\\n payload: t.Any | None = None,\\n header: t.Any | None = None,\\n original_error: Exception | None = None,\\n ):\\n super().__init__(message, payload)\\n\\n #: If the header is actually available but just malformed it\\n #: might be stored here.\\n self.header: t.Any | None = header\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n\\nclass BadPayload(BadData):\\n \\\"\\\"\\\"Raised if a payload is invalid. This could happen if the payload\\n is loaded despite an invalid signature, or if there is a mismatch\\n between the serializer and deserializer. The original exception\\n that occurred during loading is stored on as :attr:`original_error`.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n\\n def __init__(self, message: str, original_error: Exception | None = None):\\n super().__init__(message)\\n\\n #: If available, the error that indicates why the payload was\\n #: not valid. This might be ``None``.\\n self.original_error: Exception | None = original_error\\n\\n[end of src/itsdangerous/exc.py]\",\n \"filename\": \"src/itsdangerous/exc.py\",\n \"id\": \"39\"\n },\n {\n \"content\": \"[end of src/itsdangerous/py.typed]\",\n \"filename\": \"src/itsdangerous/py.typed\",\n \"id\": \"40\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport json\\nimport typing as t\\n\\nfrom .encoding import want_bytes\\nfrom .exc import BadPayload\\nfrom .exc import BadSignature\\nfrom .signer import _make_keys_list\\nfrom .signer import Signer\\n\\nif t.TYPE_CHECKING:\\n import typing_extensions as te\\n\\n # This should be either be str or bytes. To avoid having to specify the\\n # bound type, it falls back to a union if structural matching fails.\\n _TSerialized = te.TypeVar(\\n \\\"_TSerialized\\\", bound=t.Union[str, bytes], default=t.Union[str, bytes]\\n )\\nelse:\\n # Still available at runtime on Python < 3.13, but without the default.\\n _TSerialized = t.TypeVar(\\\"_TSerialized\\\", bound=t.Union[str, bytes])\\n\\n\\nclass _PDataSerializer(t.Protocol[_TSerialized]):\\n def loads(self, payload: _TSerialized, /) -> t.Any: ...\\n # A signature with additional arguments is not handled correctly by type\\n # checkers right now, so an overload is used below for serializers that\\n # don't match this strict protocol.\\n def dumps(self, obj: t.Any, /) -> _TSerialized: ...\\n\\n\\n# Use TypeIs once it's available in typing_extensions or 3.13.\\ndef is_text_serializer(\\n serializer: _PDataSerializer[t.Any],\\n) -> te.TypeGuard[_PDataSerializer[str]]:\\n \\\"\\\"\\\"Checks whether a serializer generates text or binary.\\\"\\\"\\\"\\n return isinstance(serializer.dumps({}), str)\\n\\n\\nclass Serializer(t.Generic[_TSerialized]):\\n \\\"\\\"\\\"A serializer wraps a :class:`~itsdangerous.signer.Signer` to\\n enable serializing and securely signing data other than bytes. It\\n can unsign to verify that the data hasn't been changed.\\n\\n The serializer provides :meth:`dumps` and :meth:`loads`, similar to\\n :mod:`json`, and by default uses :mod:`json` internally to serialize\\n the data to bytes.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param serializer: An object that provides ``dumps`` and ``loads``\\n methods for serializing data to a string. Defaults to\\n :attr:`default_serializer`, which defaults to :mod:`json`.\\n :param serializer_kwargs: Keyword arguments to pass when calling\\n ``serializer.dumps``.\\n :param signer: A ``Signer`` class to instantiate when signing data.\\n Defaults to :attr:`default_signer`, which defaults to\\n :class:`~itsdangerous.signer.Signer`.\\n :param signer_kwargs: Keyword arguments to pass when instantiating\\n the ``Signer`` class.\\n :param fallback_signers: List of signer parameters to try when\\n unsigning with the default signer fails. Each item can be a dict\\n of ``signer_kwargs``, a ``Signer`` class, or a tuple of\\n ``(signer, signer_kwargs)``. Defaults to\\n :attr:`default_fallback_signers`.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 2.0\\n Removed the default SHA-512 fallback signer from\\n ``default_fallback_signers``.\\n\\n .. versionchanged:: 1.1\\n Added support for ``fallback_signers`` and configured a default\\n SHA-512 fallback. This fallback is for users who used the yanked\\n 1.0.0 release which defaulted to SHA-512.\\n\\n .. versionchanged:: 0.14\\n The ``signer`` and ``signer_kwargs`` parameters were added to\\n the constructor.\\n \\\"\\\"\\\"\\n\\n #: The default serialization module to use to serialize data to a\\n #: string internally. The default is :mod:`json`, but can be changed\\n #: to any object that provides ``dumps`` and ``loads`` methods.\\n default_serializer: _PDataSerializer[t.Any] = json\\n\\n #: The default ``Signer`` class to instantiate when signing data.\\n #: The default is :class:`itsdangerous.signer.Signer`.\\n default_signer: type[Signer] = Signer\\n\\n #: The default fallback signers to try when unsigning fails.\\n default_fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = []\\n\\n # Serializer[str] if no data serializer is provided, or if it returns str.\\n @t.overload\\n def __init__(\\n self: Serializer[str],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: None | _PDataSerializer[str] = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer positional argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Serializer[bytes] with a bytes data serializer keyword argument.\\n @t.overload\\n def __init__(\\n self: Serializer[bytes],\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: _PDataSerializer[bytes],\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a positional argument. If the strict signature of\\n # _PDataSerializer doesn't match, fall back to a union, requiring the user\\n # to specify the type.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n # Fall back with a keyword argument.\\n @t.overload\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n *,\\n serializer: t.Any,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ): ...\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous\\\",\\n serializer: t.Any | None = None,\\n serializer_kwargs: dict[str, t.Any] | None = None,\\n signer: type[Signer] | None = None,\\n signer_kwargs: dict[str, t.Any] | None = None,\\n fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ]\\n | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n # if salt is None then the signer's default is used\\n\\n self.salt = salt\\n\\n if serializer is None:\\n serializer = self.default_serializer\\n\\n self.serializer: _PDataSerializer[_TSerialized] = serializer\\n self.is_text_serializer: bool = is_text_serializer(serializer)\\n\\n if signer is None:\\n signer = self.default_signer\\n\\n self.signer: type[Signer] = signer\\n self.signer_kwargs: dict[str, t.Any] = signer_kwargs or {}\\n\\n if fallback_signers is None:\\n fallback_signers = list(self.default_fallback_signers)\\n\\n self.fallback_signers: list[\\n dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]\\n ] = fallback_signers\\n self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def load_payload(\\n self, payload: bytes, serializer: _PDataSerializer[t.Any] | None = None\\n ) -> t.Any:\\n \\\"\\\"\\\"Loads the encoded object. This function raises\\n :class:`.BadPayload` if the payload is not valid. The\\n ``serializer`` parameter can be used to override the serializer\\n stored on the class. The encoded ``payload`` should always be\\n bytes.\\n \\\"\\\"\\\"\\n if serializer is None:\\n use_serializer = self.serializer\\n is_text = self.is_text_serializer\\n else:\\n use_serializer = serializer\\n is_text = is_text_serializer(serializer)\\n\\n try:\\n if is_text:\\n return use_serializer.loads(payload.decode(\\\"utf-8\\\")) # type: ignore[arg-type]\\n\\n return use_serializer.loads(payload) # type: ignore[arg-type]\\n except Exception as e:\\n raise BadPayload(\\n \\\"Could not load the payload because an exception\\\"\\n \\\" occurred on unserializing the data.\\\",\\n original_error=e,\\n ) from e\\n\\n def dump_payload(self, obj: t.Any) -> bytes:\\n \\\"\\\"\\\"Dumps the encoded object. The return value is always bytes.\\n If the internal serializer returns text, the value will be\\n encoded as UTF-8.\\n \\\"\\\"\\\"\\n return want_bytes(self.serializer.dumps(obj, **self.serializer_kwargs))\\n\\n def make_signer(self, salt: str | bytes | None = None) -> Signer:\\n \\\"\\\"\\\"Creates a new instance of the signer to be used. The default\\n implementation uses the :class:`.Signer` base class.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n return self.signer(self.secret_keys, salt=salt, **self.signer_kwargs)\\n\\n def iter_unsigners(self, salt: str | bytes | None = None) -> cabc.Iterator[Signer]:\\n \\\"\\\"\\\"Iterates over all signers to be tried for unsigning. Starts\\n with the configured signer, then constructs each signer\\n specified in ``fallback_signers``.\\n \\\"\\\"\\\"\\n if salt is None:\\n salt = self.salt\\n\\n yield self.make_signer(salt)\\n\\n for fallback in self.fallback_signers:\\n if isinstance(fallback, dict):\\n kwargs = fallback\\n fallback = self.signer\\n elif isinstance(fallback, tuple):\\n fallback, kwargs = fallback\\n else:\\n kwargs = self.signer_kwargs\\n\\n for secret_key in self.secret_keys:\\n yield fallback(secret_key, salt=salt, **kwargs)\\n\\n def dumps(self, obj: t.Any, salt: str | bytes | None = None) -> _TSerialized:\\n \\\"\\\"\\\"Returns a signed string serialized with the internal\\n serializer. The return value can be either a byte or unicode\\n string depending on the format of the internal serializer.\\n \\\"\\\"\\\"\\n payload = want_bytes(self.dump_payload(obj))\\n rv = self.make_signer(salt).sign(payload)\\n\\n if self.is_text_serializer:\\n return rv.decode(\\\"utf-8\\\") # type: ignore[return-value]\\n\\n return rv # type: ignore[return-value]\\n\\n def dump(self, obj: t.Any, f: t.IO[t.Any], salt: str | bytes | None = None) -> None:\\n \\\"\\\"\\\"Like :meth:`dumps` but dumps into a file. The file handle has\\n to be compatible with what the internal serializer expects.\\n \\\"\\\"\\\"\\n f.write(self.dumps(obj, salt))\\n\\n def loads(\\n self, s: str | bytes, salt: str | bytes | None = None, **kwargs: t.Any\\n ) -> t.Any:\\n \\\"\\\"\\\"Reverse of :meth:`dumps`. Raises :exc:`.BadSignature` if the\\n signature validation fails.\\n \\\"\\\"\\\"\\n s = want_bytes(s)\\n last_exception = None\\n\\n for signer in self.iter_unsigners(salt):\\n try:\\n return self.load_payload(signer.unsign(s))\\n except BadSignature as err:\\n last_exception = err\\n\\n raise t.cast(BadSignature, last_exception)\\n\\n def load(self, f: t.IO[t.Any], salt: str | bytes | None = None) -> t.Any:\\n \\\"\\\"\\\"Like :meth:`loads` but loads from a file.\\\"\\\"\\\"\\n return self.loads(f.read(), salt)\\n\\n def loads_unsafe(\\n self, s: str | bytes, salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads` but without verifying the signature. This\\n is potentially very dangerous to use depending on how your\\n serializer works. The return value is ``(signature_valid,\\n payload)`` instead of just the payload. The first item will be a\\n boolean that indicates if the signature is valid. This function\\n never fails.\\n\\n Use it for debugging only and if you know that your serializer\\n module is not exploitable (for example, do not use it with a\\n pickle serializer).\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self._loads_unsafe_impl(s, salt)\\n\\n def _loads_unsafe_impl(\\n self,\\n s: str | bytes,\\n salt: str | bytes | None,\\n load_kwargs: dict[str, t.Any] | None = None,\\n load_payload_kwargs: dict[str, t.Any] | None = None,\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Low level helper function to implement :meth:`loads_unsafe`\\n in serializer subclasses.\\n \\\"\\\"\\\"\\n if load_kwargs is None:\\n load_kwargs = {}\\n\\n try:\\n return True, self.loads(s, salt=salt, **load_kwargs)\\n except BadSignature as e:\\n if e.payload is None:\\n return False, None\\n\\n if load_payload_kwargs is None:\\n load_payload_kwargs = {}\\n\\n try:\\n return (\\n False,\\n self.load_payload(e.payload, **load_payload_kwargs),\\n )\\n except BadPayload:\\n return False, None\\n\\n def load_unsafe(\\n self, f: t.IO[t.Any], salt: str | bytes | None = None\\n ) -> tuple[bool, t.Any]:\\n \\\"\\\"\\\"Like :meth:`loads_unsafe` but loads from a file.\\n\\n .. versionadded:: 0.15\\n \\\"\\\"\\\"\\n return self.loads_unsafe(f.read(), salt=salt)\\n\\n[end of src/itsdangerous/serializer.py]\",\n \"filename\": \"src/itsdangerous/serializer.py\",\n \"id\": \"41\"\n },\n {\n \"content\": \"from __future__ import annotations\\n\\nimport collections.abc as cabc\\nimport hashlib\\nimport hmac\\nimport typing as t\\n\\nfrom .encoding import _base64_alphabet\\nfrom .encoding import base64_decode\\nfrom .encoding import base64_encode\\nfrom .encoding import want_bytes\\nfrom .exc import BadSignature\\n\\n\\nclass SigningAlgorithm:\\n \\\"\\\"\\\"Subclasses must implement :meth:`get_signature` to provide\\n signature generation functionality.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given key and value.\\\"\\\"\\\"\\n raise NotImplementedError()\\n\\n def verify_signature(self, key: bytes, value: bytes, sig: bytes) -> bool:\\n \\\"\\\"\\\"Verifies the given signature matches the expected\\n signature.\\n \\\"\\\"\\\"\\n return hmac.compare_digest(sig, self.get_signature(key, value))\\n\\n\\nclass NoneAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides an algorithm that does not perform any signing and\\n returns an empty signature.\\n \\\"\\\"\\\"\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n return b\\\"\\\"\\n\\n\\ndef _lazy_sha1(string: bytes = b\\\"\\\") -> t.Any:\\n \\\"\\\"\\\"Don't access ``hashlib.sha1`` until runtime. FIPS builds may not include\\n SHA-1, in which case the import and use as a default would fail before the\\n developer can configure something else.\\n \\\"\\\"\\\"\\n return hashlib.sha1(string)\\n\\n\\nclass HMACAlgorithm(SigningAlgorithm):\\n \\\"\\\"\\\"Provides signature generation using HMACs.\\\"\\\"\\\"\\n\\n #: The digest method to use with the MAC algorithm. This defaults to\\n #: SHA1, but can be changed to any other function in the hashlib\\n #: module.\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n def __init__(self, digest_method: t.Any = None):\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n def get_signature(self, key: bytes, value: bytes) -> bytes:\\n mac = hmac.new(key, msg=value, digestmod=self.digest_method)\\n return mac.digest()\\n\\n\\ndef _make_keys_list(\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n) -> list[bytes]:\\n if isinstance(secret_key, (str, bytes)):\\n return [want_bytes(secret_key)]\\n\\n return [want_bytes(s) for s in secret_key] # pyright: ignore\\n\\n\\nclass Signer:\\n \\\"\\\"\\\"A signer securely signs bytes, then unsigns them to verify that\\n the value hasn't been changed.\\n\\n The secret key should be a random string of ``bytes`` and should not\\n be saved to code or version control. Different salts should be used\\n to distinguish signing in different contexts. See :doc:`/concepts`\\n for information about the security of the secret key and salt.\\n\\n :param secret_key: The secret key to sign and verify with. Can be a\\n list of keys, oldest to newest, to support key rotation.\\n :param salt: Extra key to combine with ``secret_key`` to distinguish\\n signatures in different contexts.\\n :param sep: Separator between the signature and value.\\n :param key_derivation: How to derive the signing key from the secret\\n key and salt. Possible values are ``concat``, ``django-concat``,\\n or ``hmac``. Defaults to :attr:`default_key_derivation`, which\\n defaults to ``django-concat``.\\n :param digest_method: Hash function to use when generating the HMAC\\n signature. Defaults to :attr:`default_digest_method`, which\\n defaults to :func:`hashlib.sha1`. Note that the security of the\\n hash alone doesn't apply when used intermediately in HMAC.\\n :param algorithm: A :class:`SigningAlgorithm` instance to use\\n instead of building a default :class:`HMACAlgorithm` with the\\n ``digest_method``.\\n\\n .. versionchanged:: 2.0\\n Added support for key rotation by passing a list to\\n ``secret_key``.\\n\\n .. versionchanged:: 0.18\\n ``algorithm`` was added as an argument to the class constructor.\\n\\n .. versionchanged:: 0.14\\n ``key_derivation`` and ``digest_method`` were added as arguments\\n to the class constructor.\\n \\\"\\\"\\\"\\n\\n #: The default digest method to use for the signer. The default is\\n #: :func:`hashlib.sha1`, but can be changed to any :mod:`hashlib` or\\n #: compatible object. Note that the security of the hash alone\\n #: doesn't apply when used intermediately in HMAC.\\n #:\\n #: .. versionadded:: 0.14\\n default_digest_method: t.Any = staticmethod(_lazy_sha1)\\n\\n #: The default scheme to use to derive the signing key from the\\n #: secret key and salt. The default is ``django-concat``. Possible\\n #: values are ``concat``, ``django-concat``, and ``hmac``.\\n #:\\n #: .. versionadded:: 0.14\\n default_key_derivation: str = \\\"django-concat\\\"\\n\\n def __init__(\\n self,\\n secret_key: str | bytes | cabc.Iterable[str] | cabc.Iterable[bytes],\\n salt: str | bytes | None = b\\\"itsdangerous.Signer\\\",\\n sep: str | bytes = b\\\".\\\",\\n key_derivation: str | None = None,\\n digest_method: t.Any | None = None,\\n algorithm: SigningAlgorithm | None = None,\\n ):\\n #: The list of secret keys to try for verifying signatures, from\\n #: oldest to newest. The newest (last) key is used for signing.\\n #:\\n #: This allows a key rotation system to keep a list of allowed\\n #: keys and remove expired ones.\\n self.secret_keys: list[bytes] = _make_keys_list(secret_key)\\n self.sep: bytes = want_bytes(sep)\\n\\n if self.sep in _base64_alphabet:\\n raise ValueError(\\n \\\"The given separator cannot be used because it may be\\\"\\n \\\" contained in the signature itself. ASCII letters,\\\"\\n \\\" digits, and '-_=' must not be used.\\\"\\n )\\n\\n if salt is not None:\\n salt = want_bytes(salt)\\n else:\\n salt = b\\\"itsdangerous.Signer\\\"\\n\\n self.salt = salt\\n\\n if key_derivation is None:\\n key_derivation = self.default_key_derivation\\n\\n self.key_derivation: str = key_derivation\\n\\n if digest_method is None:\\n digest_method = self.default_digest_method\\n\\n self.digest_method: t.Any = digest_method\\n\\n if algorithm is None:\\n algorithm = HMACAlgorithm(self.digest_method)\\n\\n self.algorithm: SigningAlgorithm = algorithm\\n\\n @property\\n def secret_key(self) -> bytes:\\n \\\"\\\"\\\"The newest (last) entry in the :attr:`secret_keys` list. This\\n is for compatibility from before key rotation support was added.\\n \\\"\\\"\\\"\\n return self.secret_keys[-1]\\n\\n def derive_key(self, secret_key: str | bytes | None = None) -> bytes:\\n \\\"\\\"\\\"This method is called to derive the key. The default key\\n derivation choices can be overridden here. Key derivation is not\\n intended to be used as a security method to make a complex key\\n out of a short password. Instead you should use large random\\n secret keys.\\n\\n :param secret_key: A specific secret key to derive from.\\n Defaults to the last item in :attr:`secret_keys`.\\n\\n .. versionchanged:: 2.0\\n Added the ``secret_key`` parameter.\\n \\\"\\\"\\\"\\n if secret_key is None:\\n secret_key = self.secret_keys[-1]\\n else:\\n secret_key = want_bytes(secret_key)\\n\\n if self.key_derivation == \\\"concat\\\":\\n return t.cast(bytes, self.digest_method(self.salt + secret_key).digest())\\n elif self.key_derivation == \\\"django-concat\\\":\\n return t.cast(\\n bytes, self.digest_method(self.salt + b\\\"signer\\\" + secret_key).digest()\\n )\\n elif self.key_derivation == \\\"hmac\\\":\\n mac = hmac.new(secret_key, digestmod=self.digest_method)\\n mac.update(self.salt)\\n return mac.digest()\\n elif self.key_derivation == \\\"none\\\":\\n return secret_key\\n else:\\n raise TypeError(\\\"Unknown key derivation method\\\")\\n\\n def get_signature(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Returns the signature for the given value.\\\"\\\"\\\"\\n value = want_bytes(value)\\n key = self.derive_key()\\n sig = self.algorithm.get_signature(key, value)\\n return base64_encode(sig)\\n\\n def sign(self, value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Signs the given string.\\\"\\\"\\\"\\n value = want_bytes(value)\\n return value + self.sep + self.get_signature(value)\\n\\n def verify_signature(self, value: str | bytes, sig: str | bytes) -> bool:\\n \\\"\\\"\\\"Verifies the signature for the given value.\\\"\\\"\\\"\\n try:\\n sig = base64_decode(sig)\\n except Exception:\\n return False\\n\\n value = want_bytes(value)\\n\\n for secret_key in reversed(self.secret_keys):\\n key = self.derive_key(secret_key)\\n\\n if self.algorithm.verify_signature(key, value, sig):\\n return True\\n\\n return False\\n\\n def unsign(self, signed_value: str | bytes) -> bytes:\\n \\\"\\\"\\\"Unsigns the given string.\\\"\\\"\\\"\\n signed_value = want_bytes(signed_value)\\n\\n if self.sep not in signed_value:\\n raise BadSignature(f\\\"No {self.sep!r} found in value\\\")\\n\\n value, sig = signed_value.rsplit(self.sep, 1)\\n\\n if self.verify_signature(value, sig):\\n return value\\n\\n raise BadSignature(f\\\"Signature {sig!r} does not match\\\", payload=value)\\n\\n def validate(self, signed_value: str | bytes) -> bool:\\n \\\"\\\"\\\"Only validates the given signed value. Returns ``True`` if\\n the signature exists and is valid.\\n \\\"\\\"\\\"\\n try:\\n self.unsign(signed_value)\\n return True\\n except BadSignature:\\n return False\\n\\n[end of src/itsdangerous/signer.py]\",\n \"filename\": \"src/itsdangerous/signer.py\",\n \"id\": \"42\"\n }\n]","isConversational":false}}},{"rowIdx":79,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 79,\n \"num_files\": 14,\n \"repo_id\": \"repo_0079\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"python:\n version: 3\n\n[end of readthedocs.yml]","filename":"readthedocs.yml","id":"0"},{"content":"ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, Pexpect development team\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\n\n Permission to use, copy, modify, and/or distribute this software for any\n purpose with or without fee is hereby granted, provided that the above\n copyright notice and this permission notice appear in all copies.\n \n THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"[build-system]\nrequires = [\"flit_core >=2,<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.metadata]\nmodule = \"ptyprocess\"\nauthor = \"Thomas Kluyver\"\nauthor-email = \"thomas@kluyver.me.uk\"\nhome-page = \"https://github.com/pexpect/ptyprocess\"\ndescription-file = \"README.rst\"\nrequires-python = \">=3.7\"\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: ISC License (ISCL)\",\n \"Operating System :: POSIX\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Topic :: Terminals\"\n]\n\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"Launch a subprocess in a pseudo terminal (pty), and interact with both the\nprocess and its pty.\n\nSometimes, piping stdin and stdout is not enough. There might be a password\nprompt that doesn't read from stdin, output that changes when it's going to a\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\nIf you need to automate these things, running the process in a pseudo terminal\n(pty) is the answer.\n\nInterface:\n\n.. code:: python\n\n from ptyprocess import PtyProcessUnicode\n p = PtyProcessUnicode.spawn(['python'])\n p.read(20)\n p.write('6+6\\n')\n p.read(20)\n\n[end of README.rst]","filename":"README.rst","id":"3"},{"content":"Ptyprocess\n==========\n\n.. include:: ../README.rst\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n\n api\n\nWhat is a pty?\n--------------\n\nA pty is a kernel-level object which processes can write data to and read data\nfrom, a bit like a pipe.\n\nUnlike a pipe, data moves through a single pty in both directions. When you use\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\nto three pipes are created for the process's standard streams (stdin, stdout\nand stderr). When you run a program using ptyprocess, all three of its standard\nstreams are connected to a single pty:\n\n.. image:: images/pty_vs_popen.png\n\nA pty also does more than a pipe. It keeps track of the window size (rows and\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\nSIGINT to be sent to the child process.\n\nMany command line programs behave differently if they detect that stdin or stdout\nis connected to a terminal instead of a pipe (using \n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\nthat they're being used interactively by a human user.\nThey may format output differently (e.g. ``ls`` lists files in columns)\nor prompt the user to confirm actions.\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\n\n.. seealso::\n\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\n Detailed article by Linus Akesson\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"4"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = _build\n\n# User-friendly check for sphinx-build\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\nendif\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" xml to make Docutils-native XML files\"\n\t@echo \" pseudoxml to make pseudoxml-XML files for display purposes\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\trm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\nlatexpdfja:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through platex and dvipdfmx...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\nxml:\n\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\n\t@echo\n\t@echo \"Build finished. The XML files are in $(BUILDDIR)/xml.\"\n\npseudoxml:\n\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\n\t@echo\n\t@echo \"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\"\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"5"},{"content":"# -*- coding: utf-8 -*-\n#\n# Ptyprocess documentation build configuration file, created by\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\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\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.insert(0, os.path.abspath('..'))\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.viewcode',\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'Ptyprocess'\ncopyright = u'2014, Thomas Kluyver'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.7'\n# The full version, including alpha/beta/rc tags.\nrelease = version #+ '.2'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\n\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#html_extra_path = []\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'Ptyprocessdoc'\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\n [u'Thomas Kluyver'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {'http://docs.python.org/': None}\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"6"},{"content":"Ptyprocess API\n==============\n\n.. module:: ptyprocess\n\n.. autoclass:: PtyProcess\n\n .. automethod:: spawn\n\n .. automethod:: read\n\n .. automethod:: readline\n\n .. automethod:: write\n\n .. automethod:: sendcontrol\n\n .. automethod:: sendeof\n\n .. automethod:: sendintr\n\n .. automethod:: getecho\n\n .. automethod:: waitnoecho\n\n .. automethod:: setecho\n\n .. automethod:: getwinsize\n\n .. automethod:: setwinsize\n\n .. automethod:: eof\n\n .. automethod:: isalive\n\n .. automethod:: wait\n\n .. automethod:: kill\n\n .. automethod:: terminate\n\n .. automethod:: close\n\n.. autoclass:: PtyProcessUnicode\n\n[end of docs/api.rst]","filename":"docs/api.rst","id":"7"},{"content":"try:\n from shutil import which # Python >= 3.3\nexcept ImportError:\n import os, sys\n \n # This is copied from Python 3.4.1\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\n \"\"\"Given a command, mode, and a PATH string, return the path which\n conforms to the given mode on the PATH, or None if there is no such\n file.\n \n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\n of os.environ.get(\"PATH\"), or can be overridden with a custom search\n path.\n \n \"\"\"\n # Check that a given file can be accessed with the correct mode.\n # Additionally check that `file` is not a directory, as on Windows\n # directories pass the os.access check.\n def _access_check(fn, mode):\n return (os.path.exists(fn) and os.access(fn, mode)\n and not os.path.isdir(fn))\n \n # If we're given a path with a directory part, look it up directly rather\n # than referring to PATH directories. This includes checking relative to the\n # current directory, e.g. ./script\n if os.path.dirname(cmd):\n if _access_check(cmd, mode):\n return cmd\n return None\n \n if path is None:\n path = os.environ.get(\"PATH\", os.defpath)\n if not path:\n return None\n path = path.split(os.pathsep)\n \n if sys.platform == \"win32\":\n # The current directory takes precedence on Windows.\n if not os.curdir in path:\n path.insert(0, os.curdir)\n \n # PATHEXT is necessary to check on Windows.\n pathext = os.environ.get(\"PATHEXT\", \"\").split(os.pathsep)\n # See if the given file matches any of the expected path extensions.\n # This will allow us to short circuit when given \"python.exe\".\n # If it does match, only test that one, otherwise we have to try\n # others.\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\n files = [cmd]\n else:\n files = [cmd + ext for ext in pathext]\n else:\n # On other platforms you don't have things like PATHEXT to tell you\n # what file suffixes are executable, so just pass on cmd as-is.\n files = [cmd]\n \n seen = set()\n for dir in path:\n normdir = os.path.normcase(dir)\n if not normdir in seen:\n seen.add(normdir)\n for thefile in files:\n name = os.path.join(dir, thefile)\n if _access_check(name, mode):\n return name\n return None\n\n\nclass PtyProcessError(Exception):\n \"\"\"Generic error class for this package.\"\"\"\n\n[end of ptyprocess/util.py]","filename":"ptyprocess/util.py","id":"8"},{"content":"\"\"\"Substitute for the forkpty system call, to support Solaris.\n\"\"\"\nimport os\nimport errno\n\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\nfrom .util import PtyProcessError\n\ndef fork_pty():\n '''This implements a substitute for the forkpty system call. This\n should be more portable than the pty.fork() function. Specifically,\n this should work on Solaris.\n\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\n resolve the issue with Python's pty.fork() not supporting Solaris,\n particularly ssh. Based on patch to posixmodule.c authored by Noah\n Spurrier::\n\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\n\n '''\n\n parent_fd, child_fd = os.openpty()\n if parent_fd < 0 or child_fd < 0:\n raise OSError(\"os.openpty() failed\")\n\n pid = os.fork()\n if pid == CHILD:\n # Child.\n os.close(parent_fd)\n pty_make_controlling_tty(child_fd)\n\n os.dup2(child_fd, STDIN_FILENO)\n os.dup2(child_fd, STDOUT_FILENO)\n os.dup2(child_fd, STDERR_FILENO)\n\n else:\n # Parent.\n os.close(child_fd)\n\n return pid, parent_fd\n\ndef pty_make_controlling_tty(tty_fd):\n '''This makes the pseudo-terminal the controlling tty. This should be\n more portable than the pty.fork() function. Specifically, this should\n work on Solaris. '''\n\n child_name = os.ttyname(tty_fd)\n\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\n # if there was no controlling tty to begin with, such as when\n # executed by a cron(1) job.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n os.setsid()\n\n # Verify we are disconnected from controlling tty by attempting to open\n # it again. We expect that OSError of ENXIO should always be raised.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n raise PtyProcessError(\"OSError of errno.ENXIO should be raised.\")\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n # Verify we can open child pty.\n fd = os.open(child_name, os.O_RDWR)\n os.close(fd)\n\n # Verify we now have a controlling tty.\n fd = os.open(\"/dev/tty\", os.O_WRONLY)\n os.close(fd)\n\n[end of ptyprocess/_fork_pty.py]","filename":"ptyprocess/_fork_pty.py","id":"9"},{"content":"import codecs\nimport errno\nimport fcntl\nimport io\nimport os\nimport pty\nimport resource\nimport signal\nimport struct\nimport sys\nimport termios\nimport time\n\ntry:\n import builtins # Python 3\nexcept ImportError:\n import __builtin__ as builtins # Python 2\n\n# Constants\nfrom pty import (STDIN_FILENO, CHILD)\n\nfrom .util import which, PtyProcessError\n\n_platform = sys.platform.lower()\n\n# Solaris uses internal __fork_pty(). All others use pty.fork().\n_is_solaris = (\n _platform.startswith('solaris') or\n _platform.startswith('sunos'))\n\nif _is_solaris:\n use_native_pty_fork = False\n from . import _fork_pty\nelse:\n use_native_pty_fork = True\n\nPY3 = sys.version_info[0] >= 3\n\nif PY3:\n def _byte(i):\n return bytes([i])\nelse:\n def _byte(i):\n return chr(i)\n \n class FileNotFoundError(OSError): pass\n class TimeoutError(OSError): pass\n\n_EOF, _INTR = None, None\n\ndef _make_eof_intr():\n \"\"\"Set constants _EOF and _INTR.\n \n This avoids doing potentially costly operations on module load.\n \"\"\"\n global _EOF, _INTR\n if (_EOF is not None) and (_INTR is not None):\n return\n\n # inherit EOF and INTR definitions from controlling process.\n try:\n from termios import VEOF, VINTR\n fd = None\n for name in 'stdin', 'stdout':\n stream = getattr(sys, '__%s__' % name, None)\n if stream is None or not hasattr(stream, 'fileno'):\n continue\n try:\n fd = stream.fileno()\n except ValueError:\n continue\n if fd is None:\n # no fd, raise ValueError to fallback on CEOF, CINTR\n raise ValueError(\"No stream has a fileno\")\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\n except (ImportError, OSError, IOError, ValueError, termios.error):\n # unless the controlling process is also not a terminal,\n # such as cron(1), or when stdin and stdout are both closed.\n # Fall-back to using CEOF and CINTR. There\n try:\n from termios import CEOF, CINTR\n (intr, eof) = (CINTR, CEOF)\n except ImportError:\n # ^C, ^D\n (intr, eof) = (3, 4)\n \n _INTR = _byte(intr)\n _EOF = _byte(eof)\n\n# setecho and setwinsize are pulled out here because on some platforms, we need\n# to do this from the child before we exec()\n \ndef _setecho(fd, state):\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\n\n try:\n attr = termios.tcgetattr(fd)\n except termios.error as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n if state:\n attr[3] = attr[3] | termios.ECHO\n else:\n attr[3] = attr[3] & ~termios.ECHO\n\n try:\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\n # blocked on some platforms. TCSADRAIN would probably be ideal.\n termios.tcsetattr(fd, termios.TCSANOW, attr)\n except IOError as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\ndef _setwinsize(fd, rows, cols):\n # Some very old platforms have a bug that causes the value for\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\n # around this, but it caused problems with newer platforms so has been\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\n # Note, assume ws_xpixel and ws_ypixel are zero.\n s = struct.pack('HHHH', rows, cols, 0, 0)\n fcntl.ioctl(fd, TIOCSWINSZ, s)\n\nclass PtyProcess(object):\n '''This class represents a process running in a pseudoterminal.\n \n The main constructor is the :meth:`spawn` classmethod.\n '''\n string_type = bytes\n if PY3:\n linesep = os.linesep.encode('ascii')\n crlf = '\\r\\n'.encode('ascii')\n\n @staticmethod\n def write_to_stdout(b):\n try:\n return sys.stdout.buffer.write(b)\n except AttributeError:\n # If stdout has been replaced, it may not have .buffer\n return sys.stdout.write(b.decode('ascii', 'replace'))\n else:\n linesep = os.linesep\n crlf = '\\r\\n'\n write_to_stdout = sys.stdout.write\n\n encoding = None\n \n argv = None\n env = None\n launch_dir = None\n\n def __init__(self, pid, fd):\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\n self.pid = pid\n self.fd = fd\n readf = io.open(fd, 'rb', buffering=0)\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\n self.fileobj = io.BufferedRWPair(readf, writef)\n\n self.terminated = False\n self.closed = False\n self.exitstatus = None\n self.signalstatus = None\n # status returned by os.waitpid\n self.status = None\n self.flag_eof = False\n # Used by close() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterclose = 0.1\n # Used by terminate() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterterminate = 0.1\n\n @classmethod\n def spawn(\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\n dimensions=(24, 80), pass_fds=()):\n '''Start the given command in a child process in a pseudo terminal.\n\n This does all the fork/exec type of stuff for a pty, and returns an\n instance of PtyProcess.\n\n If preexec_fn is supplied, it will be called with no arguments in the\n child process before exec-ing the specified command.\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\n\n Dimensions of the psuedoterminal used for the subprocess can be\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\n\n By default, all file descriptors except 0, 1 and 2 are closed. This\n behavior can be overridden with pass_fds, a list of file descriptors to\n keep open between the parent and the child.\n '''\n # Note that it is difficult for this method to fail.\n # You cannot detect if the child process cannot start.\n # So the only way you can tell if the child process started\n # or not is to try to read from the file descriptor. If you get\n # EOF immediately then it means that the child is already dead.\n # That may not necessarily be bad because you may have spawned a child\n # that performs some task; creates no stdout output; and then dies.\n\n if not isinstance(argv, (list, tuple)):\n raise TypeError(\"Expected a list or tuple for argv, got %r\" % argv)\n\n # Shallow copy of argv so we can modify it\n argv = argv[:]\n command = argv[0]\n\n command_with_path = which(command)\n if command_with_path is None:\n raise FileNotFoundError('The command was not found or was not ' +\n 'executable: %s.' % command)\n command = command_with_path\n argv[0] = command\n\n # [issue #119] To prevent the case where exec fails and the user is\n # stuck interacting with a python child process instead of whatever\n # was expected, we implement the solution from\n # http://stackoverflow.com/a/3703179 to pass the exception to the\n # parent process\n\n # [issue #119] 1. Before forking, open a pipe in the parent process.\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\n\n if use_native_pty_fork:\n pid, fd = pty.fork()\n else:\n # Use internal fork_pty, for Solaris\n pid, fd = _fork_pty.fork_pty()\n\n # Some platforms must call setwinsize() and setecho() from the\n # child process, and others from the master process. We do both,\n # allowing IOError for either.\n\n if pid == CHILD:\n # set window size\n try:\n _setwinsize(STDIN_FILENO, *dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # disable echo if spawn argument echo was unset\n if not echo:\n try:\n _setecho(STDIN_FILENO, False)\n except (IOError, termios.error) as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # [issue #119] 3. The child closes the reading end and sets the\n # close-on-exec flag for the writing end.\n os.close(exec_err_pipe_read)\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\n\n # Do not allow child to inherit open file descriptors from parent,\n # with the exception of the exec_err_pipe_write of the pipe\n # and pass_fds.\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\n # occasionally raises out of range error\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\n os.closerange(pair[0]+1, pair[1])\n\n if cwd is not None:\n os.chdir(cwd)\n\n if preexec_fn is not None:\n try:\n preexec_fn()\n except Exception as e:\n ename = type(e).__name__\n tosend = '{}:0:{}'.format(ename, str(e))\n if PY3:\n tosend = tosend.encode('utf-8')\n\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(1)\n\n try:\n if env is None:\n os.execv(command, argv)\n else:\n os.execvpe(command, argv, env)\n except OSError as err:\n # [issue #119] 5. If exec fails, the child writes the error\n # code back to the parent using the pipe, then exits.\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\n if PY3:\n tosend = tosend.encode('utf-8')\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(os.EX_OSERR)\n\n # Parent\n inst = cls(pid, fd)\n \n # Set some informational attributes\n inst.argv = argv\n if env is not None:\n inst.env = env\n if cwd is not None:\n inst.launch_dir = cwd\n\n # [issue #119] 2. After forking, the parent closes the writing end\n # of the pipe and reads from the reading end.\n os.close(exec_err_pipe_write)\n exec_err_data = os.read(exec_err_pipe_read, 4096)\n os.close(exec_err_pipe_read)\n\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\n # child successfully performed exec, since close-on-exec made\n # successful exec close the writing end of the pipe. Or, if exec\n # failed, the parent reads the error code and can proceed\n # accordingly. Either way, the parent blocks until the child calls\n # exec.\n if len(exec_err_data) != 0:\n try:\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\n\n exception = exctype(errmsg.decode('utf-8', 'replace'))\n if exctype is OSError:\n exception.errno = int(errno_s)\n except:\n raise Exception('Subprocess failed, got bad error data: %r'\n % exec_err_data)\n else:\n raise exception\n\n try:\n inst.setwinsize(*dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\n raise\n\n return inst\n\n def __repr__(self):\n clsname = type(self).__name__\n if self.argv is not None:\n args = [repr(self.argv)]\n if self.env is not None:\n args.append(\"env=%r\" % self.env)\n if self.launch_dir is not None:\n args.append(\"cwd=%r\" % self.launch_dir)\n \n return \"{}.spawn({})\".format(clsname, \", \".join(args))\n \n else:\n return \"{}(pid={}, fd={})\".format(clsname, self.pid, self.fd)\n\n @staticmethod\n def _coerce_send_string(s):\n if not isinstance(s, bytes):\n return s.encode('utf-8')\n return s\n\n @staticmethod\n def _coerce_read_string(s):\n return s\n\n def __del__(self):\n '''This makes sure that no system resources are left open. Python only\n garbage collects Python objects. OS file descriptors are not Python\n objects, so they must be handled explicitly. If the child file\n descriptor was opened outside of this class (passed to the constructor)\n then this does not close it. '''\n\n if not self.closed:\n # It is possible for __del__ methods to execute during the\n # teardown of the Python VM itself. Thus self.close() may\n # trigger an exception because os.close may be None.\n try:\n self.close()\n # which exception, shouldn't we catch explicitly .. ?\n except:\n pass\n\n\n def fileno(self):\n '''This returns the file descriptor of the pty for the child.\n '''\n return self.fd\n\n def close(self, force=True):\n '''This closes the connection with the child application. Note that\n calling close() more than once is valid. This emulates standard Python\n behavior with files. Set force to True if you want to make sure that\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\n and SIGINT). '''\n if not self.closed:\n self.flush()\n self.fileobj.close() # Closes the file descriptor\n # Give kernel time to update process status.\n time.sleep(self.delayafterclose)\n if self.isalive():\n if not self.terminate(force):\n raise PtyProcessError('Could not terminate the child.')\n self.fd = -1\n self.closed = True\n #self.pid = None\n\n def flush(self):\n '''This does nothing. It is here to support the interface for a\n File-like object. '''\n\n pass\n\n def isatty(self):\n '''This returns True if the file descriptor is open and connected to a\n tty(-like) device, else False.\n\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\n the child pty may not appear as a terminal device. This means\n methods such as setecho(), setwinsize(), getwinsize() may raise an\n IOError. '''\n\n return os.isatty(self.fd)\n\n def waitnoecho(self, timeout=None):\n '''Wait until the terminal ECHO flag is set False.\n\n This returns True if the echo mode is off, or False if echo was not\n disabled before the timeout. This can be used to detect when the\n child is waiting for a password. Usually a child application will turn\n off echo mode when it is waiting for the user to enter a password. For\n example, instead of expecting the \"password:\" prompt you can wait for\n the child to turn echo off::\n\n p = pexpect.spawn('ssh user@example.com')\n p.waitnoecho()\n p.sendline(mypassword)\n\n If ``timeout=None`` then this method to block until ECHO flag is False.\n '''\n\n if timeout is not None:\n end_time = time.time() + timeout\n while True:\n if not self.getecho():\n return True\n if timeout < 0 and timeout is not None:\n return False\n if timeout is not None:\n timeout = end_time - time.time()\n time.sleep(0.1)\n\n def getecho(self):\n '''Returns True if terminal echo is on, or False if echo is off.\n\n Child applications that are expecting you to enter a password often\n disable echo. See also :meth:`waitnoecho`.\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n\n try:\n attr = termios.tcgetattr(self.fd)\n except termios.error as err:\n errmsg = 'getecho() may not be called on this platform'\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n self.echo = bool(attr[3] & termios.ECHO)\n return self.echo\n\n def setecho(self, state):\n '''Enable or disable terminal echo.\n\n Anything the child sent before the echo will be lost, so you should be\n sure that your input buffer is empty before you call setecho().\n For example, the following will work as expected::\n\n p = pexpect.spawn('cat') # Echo is on by default.\n p.sendline('1234') # We expect see this twice from the child...\n p.expect(['1234']) # ... once from the tty echo...\n p.expect(['1234']) # ... and again from cat itself.\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n The following WILL NOT WORK because the lines sent before the setecho\n will be lost::\n\n p = pexpect.spawn('cat')\n p.sendline('1234')\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['1234'])\n p.expect(['1234'])\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n _setecho(self.fd, state)\n\n self.echo = state\n\n def read(self, size=1024):\n \"\"\"Read and return at most ``size`` bytes from the pty.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\n with the vagaries of EOF on platforms that do strange things, like IRIX\n or older Solaris systems. It handles the errno=EIO pattern used on\n Linux, and the empty-string return used on BSD platforms and (seemingly)\n on recent Solaris.\n \"\"\"\n try:\n s = self.fileobj.read1(size)\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n try:\n s = self.fileobj.readline()\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def _writeb(self, b, flush=True):\n n = self.fileobj.write(b)\n if flush:\n self.fileobj.flush()\n return n\n\n def write(self, s, flush=True):\n \"\"\"Write bytes to the pseudoterminal.\n \n Returns the number of bytes written.\n \"\"\"\n return self._writeb(s, flush=flush)\n\n def sendcontrol(self, char):\n '''Helper method for sending control characters to the terminal.\n\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\a'``)::\n\n child.sendcontrol('g')\n\n See also, :meth:`sendintr` and :meth:`sendeof`.\n '''\n char = char.lower()\n a = ord(char)\n if 97 <= a <= 122:\n a = a - ord('a') + 1\n byte = _byte(a)\n return self._writeb(byte), byte\n d = {'@': 0, '`': 0,\n '[': 27, '{': 27,\n '\\\\': 28, '|': 28,\n ']': 29, '}': 29,\n '^': 30, '~': 30,\n '_': 31,\n '?': 127}\n if char not in d:\n return 0, b''\n\n byte = _byte(d[char])\n return self._writeb(byte), byte\n\n def sendeof(self):\n '''Sends an EOF (typically Ctrl-D) through the terminal.\n\n This sends a character which causes\n the pending parent output buffer to be sent to the waiting child\n program without waiting for end-of-line. If it is the first character\n of the line, the read() in the user program returns 0, which signifies\n end-of-file. This means to work as expected a sendeof() has to be\n called at the beginning of a line. This method does not send a newline.\n It is the responsibility of the caller to ensure the eof is sent at the\n beginning of a line.\n '''\n return self._writeb(_EOF), _EOF\n\n def sendintr(self):\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\n\n This will normally trigger the kernel to send SIGINT to the current\n foreground process group. Processes can turn off this translation, in\n which case they can read the raw data sent, e.g. ``b'\\\\x03'`` for Ctrl-C.\n\n See also the :meth:`kill` method, which sends a signal directly to the\n immediate child process in the terminal (which is not necessarily the\n foreground process).\n '''\n return self._writeb(_INTR), _INTR\n\n def eof(self):\n '''This returns True if the EOF exception was ever raised.\n '''\n\n return self.flag_eof\n\n def terminate(self, force=False):\n '''This forces a child process to terminate. It starts nicely with\n SIGHUP and SIGINT. If \"force\" is True then moves onto SIGKILL. This\n returns True if the child was terminated. This returns False if the\n child could not be terminated. '''\n\n if not self.isalive():\n return True\n try:\n self.kill(signal.SIGHUP)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGCONT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGINT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n if force:\n self.kill(signal.SIGKILL)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n return False\n except OSError:\n # I think there are kernel timing issues that sometimes cause\n # this to happen. I think isalive() reports True, but the\n # process is dead to the kernel.\n # Make one last attempt to see if the kernel is up to date.\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n\n def wait(self):\n '''This waits until the child exits. This is a blocking call. This will\n not read any data from the child, so this will block forever if the\n child has unread output and has terminated. In other words, the child\n may have printed output then called exit(), but, the child is\n technically still alive until its output is read by the parent. '''\n\n if self.isalive():\n pid, status = os.waitpid(self.pid, 0)\n else:\n return self.exitstatus\n self.exitstatus = os.WEXITSTATUS(status)\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status): # pragma: no cover\n # You can't call wait() on a child process in the stopped state.\n raise PtyProcessError('Called wait() on a stopped child ' +\n 'process. This is not supported. Is some other ' +\n 'process attempting job control with our child pid?')\n return self.exitstatus\n\n def isalive(self):\n '''This tests if the child process is running or not. This is\n non-blocking. If the child was terminated then this will read the\n exitstatus or signalstatus of the child. This returns True if the child\n process appears to be running or False if not. It can take literally\n SECONDS for Solaris to return the right status. '''\n\n if self.terminated:\n return False\n\n if self.flag_eof:\n # This is for Linux, which requires the blocking form\n # of waitpid to get the status of a defunct process.\n # This is super-lame. The flag_eof would have been set\n # in read_nonblocking(), so this should be safe.\n waitpid_options = 0\n else:\n waitpid_options = os.WNOHANG\n\n try:\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e:\n # No child processes\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'where \"terminated\" is 0, but there was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # I have to do this twice for Solaris.\n # I can't even believe that I figured this out...\n # If waitpid() returns 0 it means that no child process\n # wishes to report, and the value of status is undefined.\n if pid == 0:\n try:\n ### os.WNOHANG) # Solaris!\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e: # pragma: no cover\n # This should never happen...\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'that should never happen. There was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # If pid is still 0 after two calls to waitpid() then the process\n # really is alive. This seems to work on all platforms, except for\n # Irix which seems to require a blocking call on waitpid or select,\n # so I let read_nonblocking take care of this situation\n # (unfortunately, this requires waiting through the timeout).\n if pid == 0:\n return True\n\n if pid == 0:\n return True\n\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status):\n raise PtyProcessError('isalive() encountered condition ' +\n 'where child process is stopped. This is not ' +\n 'supported. Is some other process attempting ' +\n 'job control with our child pid?')\n return False\n\n def kill(self, sig):\n \"\"\"Send the given signal to the child application.\n\n In keeping with UNIX tradition it has a misleading name. It does not\n necessarily kill the child unless you send the right signal. See the\n :mod:`signal` module for constants representing signal numbers.\n \"\"\"\n\n # Same as os.kill, but the pid is given for you.\n if self.isalive():\n os.kill(self.pid, sig)\n\n def getwinsize(self):\n \"\"\"Return the window size of the pseudoterminal as a tuple (rows, cols).\n \"\"\"\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\n s = struct.pack('HHHH', 0, 0, 0, 0)\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\n return struct.unpack('HHHH', x)[0:2]\n\n def setwinsize(self, rows, cols):\n \"\"\"Set the terminal window size of the child tty.\n\n This will cause a SIGWINCH signal to be sent to the child. This does not\n change the physical window size. It changes the size reported to\n TTY-aware applications like vi or curses -- applications that respond to\n the SIGWINCH signal.\n \"\"\"\n return _setwinsize(self.fd, rows, cols)\n\n\nclass PtyProcessUnicode(PtyProcess):\n \"\"\"Unicode wrapper around a process running in a pseudoterminal.\n\n This class exposes a similar interface to :class:`PtyProcess`, but its read\n methods return unicode, and its :meth:`write` accepts unicode.\n \"\"\"\n if PY3:\n string_type = str\n else:\n string_type = unicode # analysis:ignore\n\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\n super(PtyProcessUnicode, self).__init__(pid, fd)\n self.encoding = encoding\n self.codec_errors = codec_errors\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\n\n def read(self, size=1024):\n \"\"\"Read at most ``size`` bytes from the pty, return them as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n\n The size argument still refers to bytes, not unicode code points.\n \"\"\"\n b = super(PtyProcessUnicode, self).read(size)\n return self.decoder.decode(b, final=False)\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n b = super(PtyProcessUnicode, self).readline()\n return self.decoder.decode(b, final=False)\n\n def write(self, s):\n \"\"\"Write the unicode string ``s`` to the pseudoterminal.\n\n Returns the number of bytes written.\n \"\"\"\n b = s.encode(self.encoding)\n return super(PtyProcessUnicode, self).write(b)\n\n[end of ptyprocess/ptyprocess.py]","filename":"ptyprocess/ptyprocess.py","id":"10"},{"content":"\"\"\"Run a subprocess in a pseudo terminal\"\"\"\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\n\n__version__ = '0.7.0'\n\n[end of ptyprocess/__init__.py]","filename":"ptyprocess/__init__.py","id":"11"},{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\n\n<svg\n xmlns:dc=\"http://purl.org/dc/elements/1.1/\"\n xmlns:cc=\"http://creativecommons.org/ns#\"\n xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n xmlns:svg=\"http://www.w3.org/2000/svg\"\n xmlns=\"http://www.w3.org/2000/svg\"\n xmlns:sodipodi=\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\"\n xmlns:inkscape=\"http://www.inkscape.org/namespaces/inkscape\"\n width=\"554.44196\"\n height=\"327.38452\"\n id=\"svg2\"\n version=\"1.1\"\n inkscape:version=\"0.48.4 r9939\"\n sodipodi:docname=\"pty_vs_popen.svg\">\n <defs\n id=\"defs4\">\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM\"\n style=\"overflow:visible\">\n <path\n id=\"path3838\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3783\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(1.1,0,0,1.1,1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Tail\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Tail\"\n style=\"overflow:visible\">\n <g\n id=\"g3801\"\n transform=\"scale(-1.2,-1.2)\">\n <path\n id=\"path3803\"\n d=\"M -3.8048674,-3.9585227 0.54352094,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3805\"\n d=\"M -1.2866832,-3.9585227 3.0617053,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3807\"\n d=\"M 1.3053582,-3.9585227 5.6537466,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3809\"\n d=\"M -3.8048674,4.1775838 0.54352094,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3811\"\n d=\"M -1.2866832,4.1775838 3.0617053,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3813\"\n d=\"M 1.3053582,4.1775838 5.6537466,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n </g>\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3765\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(0.8,0,0,0.8,10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3786\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3768\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(-0.8,0,0,-0.8,-10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-9\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-2\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-6\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-27\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM-5\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3838-7\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10742\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10744\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10746\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10748\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10750\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10752\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10754\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10756\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10758\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10760\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n </defs>\n <sodipodi:namedview\n id=\"base\"\n pagecolor=\"#ffffff\"\n bordercolor=\"#666666\"\n borderopacity=\"1.0\"\n inkscape:pageopacity=\"0.0\"\n inkscape:pageshadow=\"2\"\n inkscape:zoom=\"0.98994949\"\n inkscape:cx=\"77.797977\"\n inkscape:cy=\"137.24456\"\n inkscape:document-units=\"px\"\n inkscape:current-layer=\"layer1\"\n showgrid=\"false\"\n inkscape:window-width=\"1301\"\n inkscape:window-height=\"744\"\n inkscape:window-x=\"65\"\n inkscape:window-y=\"24\"\n inkscape:window-maximized=\"1\"\n fit-margin-top=\"1\"\n fit-margin-left=\"1\"\n fit-margin-right=\"1\"\n fit-margin-bottom=\"1\"\n units=\"cm\" />\n <metadata\n id=\"metadata7\">\n <rdf:RDF>\n <cc:Work\n rdf:about=\"\">\n <dc:format>image/svg+xml</dc:format>\n <dc:type\n rdf:resource=\"http://purl.org/dc/dcmitype/StillImage\" />\n <dc:title></dc:title>\n </cc:Work>\n </rdf:RDF>\n </metadata>\n <g\n inkscape:label=\"Layer 1\"\n inkscape:groupmode=\"layer\"\n id=\"layer1\"\n transform=\"translate(-40.758533,29.820888)\">\n <g\n id=\"g11880\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591\"\n y=\"240.97427\"\n x=\"138.65004\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.97427\"\n x=\"138.65004\"\n id=\"tspan10593\"\n sodipodi:role=\"line\">Child</tspan></text>\n <g\n id=\"g10626\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991\"\n d=\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7\"\n d=\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\"\n id=\"path2991-7-8\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5637\"\n d=\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5641\"\n d=\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5643\"\n d=\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245\"\n y=\"240.57648\"\n x=\"90\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.57648\"\n x=\"90\"\n id=\"tspan6247\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8\"\n y=\"213.07455\"\n x=\"184.47076\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"213.07455\"\n x=\"184.47076\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8\"\n y=\"262.00311\"\n x=\"192.32663\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"262.00311\"\n x=\"192.32663\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(18,0)\"\n id=\"g11773\">\n <g\n id=\"g11763\">\n <rect\n y=\"120.8597\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308\"\n y=\"129.96561\"\n x=\"63.277264\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"129.96561\"\n x=\"63.277264\"\n id=\"tspan6310\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g11768\">\n <rect\n y=\"135.43114\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304\"\n y=\"144.58977\"\n x=\"64.540932\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"144.58977\"\n x=\"64.540932\"\n id=\"tspan6306\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(54,-16)\"\n id=\"g10674\">\n <g\n id=\"g10664\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(86.857134,-15.571435)\"\n id=\"g10674-6\">\n <g\n id=\"g10664-6\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0-5\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-9\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7-6\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669-5\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5-3\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6-1\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726\"\n y=\"139.6479\"\n x=\"135.03683\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"139.6479\"\n x=\"135.03683\"\n id=\"tspan10728\"\n sodipodi:role=\"line\">Popen</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-89\"\n y=\"158.43169\"\n x=\"234.46947\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-24\"\n style=\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\"\n y=\"158.43169\"\n x=\"234.46947\"\n sodipodi:role=\"line\">pipes</tspan></text>\n </g>\n <g\n id=\"g11847\"\n transform=\"translate(-10,0.39179)\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328-0\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-8\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591-3\"\n y=\"240.5825\"\n x=\"372.50137\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.5825\"\n x=\"372.50137\"\n id=\"tspan10593-2\"\n sodipodi:role=\"line\">Child</tspan></text>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path11075\"\n d=\"m 397.80427,110.64896 0,-52.85714\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\" />\n <g\n id=\"g10626-5\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2-4\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334-0\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336-9\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-4\"\n d=\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7-87\"\n d=\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331-7\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\"\n id=\"path2991-7-8-4\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-6\"\n y=\"240.18468\"\n x=\"323.85132\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.18468\"\n x=\"323.85132\"\n id=\"tspan6247-3\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-6\"\n y=\"207.68279\"\n x=\"410.10779\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-2\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"207.68279\"\n x=\"410.10779\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8-1\"\n y=\"261.61133\"\n x=\"426.17795\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298-3\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"261.61133\"\n x=\"426.17795\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(227.5656,-301.02546)\"\n id=\"g11065\">\n <g\n id=\"g11055\">\n <rect\n y=\"421.34998\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55\"\n style=\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6\"\n y=\"431.01376\"\n x=\"159.1624\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"431.01376\"\n x=\"159.1624\"\n id=\"tspan6310-7-9\"\n sodipodi:role=\"line\">slave</tspan></text>\n </g>\n <g\n id=\"g11060\">\n <rect\n y=\"407.25223\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55-9\"\n style=\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6-7\"\n y=\"416.68555\"\n x=\"155.16631\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"416.68555\"\n x=\"155.16631\"\n id=\"tspan6310-7-9-7\"\n sodipodi:role=\"line\">master</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726-9\"\n y=\"116.71899\"\n x=\"429.1268\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"116.71899\"\n x=\"429.1268\"\n id=\"tspan10728-7\"\n sodipodi:role=\"line\">Pseudoterminal</tspan><tspan\n id=\"tspan11761\"\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"136.71899\"\n x=\"429.1268\"\n sodipodi:role=\"line\">(pty)</tspan></text>\n </g>\n </g>\n</svg>\n\n[end of docs/images/pty_vs_popen.svg]","filename":"docs/images/pty_vs_popen.svg","id":"12"},{"content":"None\n[end of docs/images/pty_vs_popen.png]","filename":"docs/images/pty_vs_popen.png","id":"13"}],"string":"[\n {\n \"content\": \"python:\\n version: 3\\n\\n[end of readthedocs.yml]\",\n \"filename\": \"readthedocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"ISC LICENSE\\n\\n This license is approved by the OSI and FSF as GPL-compatible.\\n http://opensource.org/licenses/isc-license.txt\\n\\n Copyright (c) 2013-2014, Pexpect development team\\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\\n\\n Permission to use, copy, modify, and/or distribute this software for any\\n purpose with or without fee is hereby granted, provided that the above\\n copyright notice and this permission notice appear in all copies.\\n \\n THE SOFTWARE IS PROVIDED \\\"AS IS\\\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"flit_core >=2,<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.metadata]\\nmodule = \\\"ptyprocess\\\"\\nauthor = \\\"Thomas Kluyver\\\"\\nauthor-email = \\\"thomas@kluyver.me.uk\\\"\\nhome-page = \\\"https://github.com/pexpect/ptyprocess\\\"\\ndescription-file = \\\"README.rst\\\"\\nrequires-python = \\\">=3.7\\\"\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: ISC License (ISCL)\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Topic :: Terminals\\\"\\n]\\n\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"Launch a subprocess in a pseudo terminal (pty), and interact with both the\\nprocess and its pty.\\n\\nSometimes, piping stdin and stdout is not enough. There might be a password\\nprompt that doesn't read from stdin, output that changes when it's going to a\\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\\nIf you need to automate these things, running the process in a pseudo terminal\\n(pty) is the answer.\\n\\nInterface:\\n\\n.. code:: python\\n\\n from ptyprocess import PtyProcessUnicode\\n p = PtyProcessUnicode.spawn(['python'])\\n p.read(20)\\n p.write('6+6\\\\n')\\n p.read(20)\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"3\"\n },\n {\n \"content\": \"Ptyprocess\\n==========\\n\\n.. include:: ../README.rst\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n\\n api\\n\\nWhat is a pty?\\n--------------\\n\\nA pty is a kernel-level object which processes can write data to and read data\\nfrom, a bit like a pipe.\\n\\nUnlike a pipe, data moves through a single pty in both directions. When you use\\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\\nto three pipes are created for the process's standard streams (stdin, stdout\\nand stderr). When you run a program using ptyprocess, all three of its standard\\nstreams are connected to a single pty:\\n\\n.. image:: images/pty_vs_popen.png\\n\\nA pty also does more than a pipe. It keeps track of the window size (rows and\\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\\nSIGINT to be sent to the child process.\\n\\nMany command line programs behave differently if they detect that stdin or stdout\\nis connected to a terminal instead of a pipe (using \\n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\\nthat they're being used interactively by a human user.\\nThey may format output differently (e.g. ``ls`` lists files in columns)\\nor prompt the user to confirm actions.\\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\\n\\n.. seealso::\\n\\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\\n Detailed article by Linus Akesson\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"4\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = _build\\n\\n# User-friendly check for sphinx-build\\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\\nendif\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n# the i18n builder cannot share the environment and doctrees with the others\\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n\\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" singlehtml to make a single large HTML file\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" devhelp to make HTML files and a Devhelp project\\\"\\n\\t@echo \\\" epub to make an epub\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" latexpdf to make LaTeX files and run them through pdflatex\\\"\\n\\t@echo \\\" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\\\"\\n\\t@echo \\\" text to make text files\\\"\\n\\t@echo \\\" man to make manual pages\\\"\\n\\t@echo \\\" texinfo to make Texinfo files\\\"\\n\\t@echo \\\" info to make Texinfo files and run them through makeinfo\\\"\\n\\t@echo \\\" gettext to make PO message catalogs\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" xml to make Docutils-native XML files\\\"\\n\\t@echo \\\" pseudoxml to make pseudoxml-XML files for display purposes\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\trm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\nsinglehtml:\\n\\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\\\"\\n\\ndevhelp:\\n\\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\\n\\t@echo\\n\\t@echo \\\"Build finished.\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# devhelp\\\"\\n\\nepub:\\n\\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\\n\\t@echo\\n\\t@echo \\\"Build finished. The epub file is in $(BUILDDIR)/epub.\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through (pdf)latex\\\" \\\\\\n\\t \\\"(use \\\\`make latexpdf' here to do that automatically).\\\"\\n\\nlatexpdf:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through pdflatex...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\nlatexpdfja:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through platex and dvipdfmx...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\ntext:\\n\\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\\n\\t@echo\\n\\t@echo \\\"Build finished. The text files are in $(BUILDDIR)/text.\\\"\\n\\nman:\\n\\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\\n\\t@echo\\n\\t@echo \\\"Build finished. The manual pages are in $(BUILDDIR)/man.\\\"\\n\\ntexinfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo\\n\\t@echo \\\"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through makeinfo\\\" \\\\\\n\\t \\\"(use \\\\`make info' here to do that automatically).\\\"\\n\\ninfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo \\\"Running Texinfo files through makeinfo...\\\"\\n\\tmake -C $(BUILDDIR)/texinfo info\\n\\t@echo \\\"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\\\"\\n\\ngettext:\\n\\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\\n\\t@echo\\n\\t@echo \\\"Build finished. The message catalogs are in $(BUILDDIR)/locale.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\nxml:\\n\\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\\n\\t@echo\\n\\t@echo \\\"Build finished. The XML files are in $(BUILDDIR)/xml.\\\"\\n\\npseudoxml:\\n\\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\\n\\t@echo\\n\\t@echo \\\"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\\\"\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n#\\n# Ptyprocess documentation build configuration file, created by\\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\\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\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.insert(0, os.path.abspath('..'))\\n\\n# -- General configuration ------------------------------------------------\\n\\n# If your documentation needs a minimal Sphinx version, state it here.\\n#needs_sphinx = '1.0'\\n\\n# Add any Sphinx extension module names here, as strings. They can be\\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\\n# ones.\\nextensions = [\\n 'sphinx.ext.autodoc',\\n 'sphinx.ext.intersphinx',\\n 'sphinx.ext.viewcode',\\n]\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['_templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8-sig'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = u'Ptyprocess'\\ncopyright = u'2014, Thomas Kluyver'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.7'\\n# The full version, including alpha/beta/rc tags.\\nrelease = version #+ '.2'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of patterns, relative to source directory, that match files and\\n# directories to ignore when looking for source files.\\nexclude_patterns = ['_build']\\n\\n# The reST default role (used for this markup: `text`) to use for all\\n# documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n# If true, keep warnings as \\\"system message\\\" paragraphs in the built documents.\\n#keep_warnings = False\\n\\n\\n# -- Options for HTML output ----------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. See the documentation for\\n# a list of builtin themes.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['_static']\\n\\n# Add any extra paths that contain custom files (such as robots.txt or\\n# .htaccess) here, relative to this directory. These files are copied\\n# directly to the root of the documentation.\\n#html_extra_path = []\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_domain_indices = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, \\\"Created using Sphinx\\\" is shown in the HTML footer. Default is True.\\n#html_show_sphinx = True\\n\\n# If true, \\\"(C) Copyright ...\\\" is shown in the HTML footer. Default is True.\\n#html_show_copyright = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# This is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = None\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'Ptyprocessdoc'\\n\\n\\n# -- Options for LaTeX output ---------------------------------------------\\n\\nlatex_elements = {\\n# The paper size ('letterpaper' or 'a4paper').\\n#'papersize': 'letterpaper',\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#'pointsize': '10pt',\\n\\n# Additional stuff for the LaTeX preamble.\\n#'preamble': '',\\n}\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title,\\n# author, documentclass [howto, manual, or own class]).\\nlatex_documents = [\\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# If true, show page references after internal links.\\n#latex_show_pagerefs = False\\n\\n# If true, show URL addresses after external links.\\n#latex_show_urls = False\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_domain_indices = True\\n\\n\\n# -- Options for manual page output ---------------------------------------\\n\\n# One entry per manual page. List of tuples\\n# (source start file, name, description, authors, manual section).\\nman_pages = [\\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\\n [u'Thomas Kluyver'], 1)\\n]\\n\\n# If true, show URL addresses after external links.\\n#man_show_urls = False\\n\\n\\n# -- Options for Texinfo output -------------------------------------------\\n\\n# Grouping the document tree into Texinfo files. List of tuples\\n# (source start file, target name, title, author,\\n# dir menu entry, description, category)\\ntexinfo_documents = [\\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\\n 'Miscellaneous'),\\n]\\n\\n# Documents to append as an appendix to all manuals.\\n#texinfo_appendices = []\\n\\n# If false, no module index is generated.\\n#texinfo_domain_indices = True\\n\\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\\n#texinfo_show_urls = 'footnote'\\n\\n# If true, do not generate a @detailmenu in the \\\"Top\\\" node's menu.\\n#texinfo_no_detailmenu = False\\n\\n\\n# Example configuration for intersphinx: refer to the Python standard library.\\nintersphinx_mapping = {'http://docs.python.org/': None}\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Ptyprocess API\\n==============\\n\\n.. module:: ptyprocess\\n\\n.. autoclass:: PtyProcess\\n\\n .. automethod:: spawn\\n\\n .. automethod:: read\\n\\n .. automethod:: readline\\n\\n .. automethod:: write\\n\\n .. automethod:: sendcontrol\\n\\n .. automethod:: sendeof\\n\\n .. automethod:: sendintr\\n\\n .. automethod:: getecho\\n\\n .. automethod:: waitnoecho\\n\\n .. automethod:: setecho\\n\\n .. automethod:: getwinsize\\n\\n .. automethod:: setwinsize\\n\\n .. automethod:: eof\\n\\n .. automethod:: isalive\\n\\n .. automethod:: wait\\n\\n .. automethod:: kill\\n\\n .. automethod:: terminate\\n\\n .. automethod:: close\\n\\n.. autoclass:: PtyProcessUnicode\\n\\n[end of docs/api.rst]\",\n \"filename\": \"docs/api.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"try:\\n from shutil import which # Python >= 3.3\\nexcept ImportError:\\n import os, sys\\n \\n # This is copied from Python 3.4.1\\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\\n \\\"\\\"\\\"Given a command, mode, and a PATH string, return the path which\\n conforms to the given mode on the PATH, or None if there is no such\\n file.\\n \\n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\\n of os.environ.get(\\\"PATH\\\"), or can be overridden with a custom search\\n path.\\n \\n \\\"\\\"\\\"\\n # Check that a given file can be accessed with the correct mode.\\n # Additionally check that `file` is not a directory, as on Windows\\n # directories pass the os.access check.\\n def _access_check(fn, mode):\\n return (os.path.exists(fn) and os.access(fn, mode)\\n and not os.path.isdir(fn))\\n \\n # If we're given a path with a directory part, look it up directly rather\\n # than referring to PATH directories. This includes checking relative to the\\n # current directory, e.g. ./script\\n if os.path.dirname(cmd):\\n if _access_check(cmd, mode):\\n return cmd\\n return None\\n \\n if path is None:\\n path = os.environ.get(\\\"PATH\\\", os.defpath)\\n if not path:\\n return None\\n path = path.split(os.pathsep)\\n \\n if sys.platform == \\\"win32\\\":\\n # The current directory takes precedence on Windows.\\n if not os.curdir in path:\\n path.insert(0, os.curdir)\\n \\n # PATHEXT is necessary to check on Windows.\\n pathext = os.environ.get(\\\"PATHEXT\\\", \\\"\\\").split(os.pathsep)\\n # See if the given file matches any of the expected path extensions.\\n # This will allow us to short circuit when given \\\"python.exe\\\".\\n # If it does match, only test that one, otherwise we have to try\\n # others.\\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\\n files = [cmd]\\n else:\\n files = [cmd + ext for ext in pathext]\\n else:\\n # On other platforms you don't have things like PATHEXT to tell you\\n # what file suffixes are executable, so just pass on cmd as-is.\\n files = [cmd]\\n \\n seen = set()\\n for dir in path:\\n normdir = os.path.normcase(dir)\\n if not normdir in seen:\\n seen.add(normdir)\\n for thefile in files:\\n name = os.path.join(dir, thefile)\\n if _access_check(name, mode):\\n return name\\n return None\\n\\n\\nclass PtyProcessError(Exception):\\n \\\"\\\"\\\"Generic error class for this package.\\\"\\\"\\\"\\n\\n[end of ptyprocess/util.py]\",\n \"filename\": \"ptyprocess/util.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Substitute for the forkpty system call, to support Solaris.\\n\\\"\\\"\\\"\\nimport os\\nimport errno\\n\\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\\nfrom .util import PtyProcessError\\n\\ndef fork_pty():\\n '''This implements a substitute for the forkpty system call. This\\n should be more portable than the pty.fork() function. Specifically,\\n this should work on Solaris.\\n\\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\\n resolve the issue with Python's pty.fork() not supporting Solaris,\\n particularly ssh. Based on patch to posixmodule.c authored by Noah\\n Spurrier::\\n\\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\\n\\n '''\\n\\n parent_fd, child_fd = os.openpty()\\n if parent_fd < 0 or child_fd < 0:\\n raise OSError(\\\"os.openpty() failed\\\")\\n\\n pid = os.fork()\\n if pid == CHILD:\\n # Child.\\n os.close(parent_fd)\\n pty_make_controlling_tty(child_fd)\\n\\n os.dup2(child_fd, STDIN_FILENO)\\n os.dup2(child_fd, STDOUT_FILENO)\\n os.dup2(child_fd, STDERR_FILENO)\\n\\n else:\\n # Parent.\\n os.close(child_fd)\\n\\n return pid, parent_fd\\n\\ndef pty_make_controlling_tty(tty_fd):\\n '''This makes the pseudo-terminal the controlling tty. This should be\\n more portable than the pty.fork() function. Specifically, this should\\n work on Solaris. '''\\n\\n child_name = os.ttyname(tty_fd)\\n\\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\\n # if there was no controlling tty to begin with, such as when\\n # executed by a cron(1) job.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n os.setsid()\\n\\n # Verify we are disconnected from controlling tty by attempting to open\\n # it again. We expect that OSError of ENXIO should always be raised.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n raise PtyProcessError(\\\"OSError of errno.ENXIO should be raised.\\\")\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n # Verify we can open child pty.\\n fd = os.open(child_name, os.O_RDWR)\\n os.close(fd)\\n\\n # Verify we now have a controlling tty.\\n fd = os.open(\\\"/dev/tty\\\", os.O_WRONLY)\\n os.close(fd)\\n\\n[end of ptyprocess/_fork_pty.py]\",\n \"filename\": \"ptyprocess/_fork_pty.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"import codecs\\nimport errno\\nimport fcntl\\nimport io\\nimport os\\nimport pty\\nimport resource\\nimport signal\\nimport struct\\nimport sys\\nimport termios\\nimport time\\n\\ntry:\\n import builtins # Python 3\\nexcept ImportError:\\n import __builtin__ as builtins # Python 2\\n\\n# Constants\\nfrom pty import (STDIN_FILENO, CHILD)\\n\\nfrom .util import which, PtyProcessError\\n\\n_platform = sys.platform.lower()\\n\\n# Solaris uses internal __fork_pty(). All others use pty.fork().\\n_is_solaris = (\\n _platform.startswith('solaris') or\\n _platform.startswith('sunos'))\\n\\nif _is_solaris:\\n use_native_pty_fork = False\\n from . import _fork_pty\\nelse:\\n use_native_pty_fork = True\\n\\nPY3 = sys.version_info[0] >= 3\\n\\nif PY3:\\n def _byte(i):\\n return bytes([i])\\nelse:\\n def _byte(i):\\n return chr(i)\\n \\n class FileNotFoundError(OSError): pass\\n class TimeoutError(OSError): pass\\n\\n_EOF, _INTR = None, None\\n\\ndef _make_eof_intr():\\n \\\"\\\"\\\"Set constants _EOF and _INTR.\\n \\n This avoids doing potentially costly operations on module load.\\n \\\"\\\"\\\"\\n global _EOF, _INTR\\n if (_EOF is not None) and (_INTR is not None):\\n return\\n\\n # inherit EOF and INTR definitions from controlling process.\\n try:\\n from termios import VEOF, VINTR\\n fd = None\\n for name in 'stdin', 'stdout':\\n stream = getattr(sys, '__%s__' % name, None)\\n if stream is None or not hasattr(stream, 'fileno'):\\n continue\\n try:\\n fd = stream.fileno()\\n except ValueError:\\n continue\\n if fd is None:\\n # no fd, raise ValueError to fallback on CEOF, CINTR\\n raise ValueError(\\\"No stream has a fileno\\\")\\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\\n except (ImportError, OSError, IOError, ValueError, termios.error):\\n # unless the controlling process is also not a terminal,\\n # such as cron(1), or when stdin and stdout are both closed.\\n # Fall-back to using CEOF and CINTR. There\\n try:\\n from termios import CEOF, CINTR\\n (intr, eof) = (CINTR, CEOF)\\n except ImportError:\\n # ^C, ^D\\n (intr, eof) = (3, 4)\\n \\n _INTR = _byte(intr)\\n _EOF = _byte(eof)\\n\\n# setecho and setwinsize are pulled out here because on some platforms, we need\\n# to do this from the child before we exec()\\n \\ndef _setecho(fd, state):\\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\\n\\n try:\\n attr = termios.tcgetattr(fd)\\n except termios.error as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n if state:\\n attr[3] = attr[3] | termios.ECHO\\n else:\\n attr[3] = attr[3] & ~termios.ECHO\\n\\n try:\\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\\n # blocked on some platforms. TCSADRAIN would probably be ideal.\\n termios.tcsetattr(fd, termios.TCSANOW, attr)\\n except IOError as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\ndef _setwinsize(fd, rows, cols):\\n # Some very old platforms have a bug that causes the value for\\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\\n # around this, but it caused problems with newer platforms so has been\\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\\n # Note, assume ws_xpixel and ws_ypixel are zero.\\n s = struct.pack('HHHH', rows, cols, 0, 0)\\n fcntl.ioctl(fd, TIOCSWINSZ, s)\\n\\nclass PtyProcess(object):\\n '''This class represents a process running in a pseudoterminal.\\n \\n The main constructor is the :meth:`spawn` classmethod.\\n '''\\n string_type = bytes\\n if PY3:\\n linesep = os.linesep.encode('ascii')\\n crlf = '\\\\r\\\\n'.encode('ascii')\\n\\n @staticmethod\\n def write_to_stdout(b):\\n try:\\n return sys.stdout.buffer.write(b)\\n except AttributeError:\\n # If stdout has been replaced, it may not have .buffer\\n return sys.stdout.write(b.decode('ascii', 'replace'))\\n else:\\n linesep = os.linesep\\n crlf = '\\\\r\\\\n'\\n write_to_stdout = sys.stdout.write\\n\\n encoding = None\\n \\n argv = None\\n env = None\\n launch_dir = None\\n\\n def __init__(self, pid, fd):\\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\\n self.pid = pid\\n self.fd = fd\\n readf = io.open(fd, 'rb', buffering=0)\\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\\n self.fileobj = io.BufferedRWPair(readf, writef)\\n\\n self.terminated = False\\n self.closed = False\\n self.exitstatus = None\\n self.signalstatus = None\\n # status returned by os.waitpid\\n self.status = None\\n self.flag_eof = False\\n # Used by close() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterclose = 0.1\\n # Used by terminate() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterterminate = 0.1\\n\\n @classmethod\\n def spawn(\\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\\n dimensions=(24, 80), pass_fds=()):\\n '''Start the given command in a child process in a pseudo terminal.\\n\\n This does all the fork/exec type of stuff for a pty, and returns an\\n instance of PtyProcess.\\n\\n If preexec_fn is supplied, it will be called with no arguments in the\\n child process before exec-ing the specified command.\\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\\n\\n Dimensions of the psuedoterminal used for the subprocess can be\\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\\n\\n By default, all file descriptors except 0, 1 and 2 are closed. This\\n behavior can be overridden with pass_fds, a list of file descriptors to\\n keep open between the parent and the child.\\n '''\\n # Note that it is difficult for this method to fail.\\n # You cannot detect if the child process cannot start.\\n # So the only way you can tell if the child process started\\n # or not is to try to read from the file descriptor. If you get\\n # EOF immediately then it means that the child is already dead.\\n # That may not necessarily be bad because you may have spawned a child\\n # that performs some task; creates no stdout output; and then dies.\\n\\n if not isinstance(argv, (list, tuple)):\\n raise TypeError(\\\"Expected a list or tuple for argv, got %r\\\" % argv)\\n\\n # Shallow copy of argv so we can modify it\\n argv = argv[:]\\n command = argv[0]\\n\\n command_with_path = which(command)\\n if command_with_path is None:\\n raise FileNotFoundError('The command was not found or was not ' +\\n 'executable: %s.' % command)\\n command = command_with_path\\n argv[0] = command\\n\\n # [issue #119] To prevent the case where exec fails and the user is\\n # stuck interacting with a python child process instead of whatever\\n # was expected, we implement the solution from\\n # http://stackoverflow.com/a/3703179 to pass the exception to the\\n # parent process\\n\\n # [issue #119] 1. Before forking, open a pipe in the parent process.\\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\\n\\n if use_native_pty_fork:\\n pid, fd = pty.fork()\\n else:\\n # Use internal fork_pty, for Solaris\\n pid, fd = _fork_pty.fork_pty()\\n\\n # Some platforms must call setwinsize() and setecho() from the\\n # child process, and others from the master process. We do both,\\n # allowing IOError for either.\\n\\n if pid == CHILD:\\n # set window size\\n try:\\n _setwinsize(STDIN_FILENO, *dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # disable echo if spawn argument echo was unset\\n if not echo:\\n try:\\n _setecho(STDIN_FILENO, False)\\n except (IOError, termios.error) as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # [issue #119] 3. The child closes the reading end and sets the\\n # close-on-exec flag for the writing end.\\n os.close(exec_err_pipe_read)\\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\\n\\n # Do not allow child to inherit open file descriptors from parent,\\n # with the exception of the exec_err_pipe_write of the pipe\\n # and pass_fds.\\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\\n # occasionally raises out of range error\\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\\n os.closerange(pair[0]+1, pair[1])\\n\\n if cwd is not None:\\n os.chdir(cwd)\\n\\n if preexec_fn is not None:\\n try:\\n preexec_fn()\\n except Exception as e:\\n ename = type(e).__name__\\n tosend = '{}:0:{}'.format(ename, str(e))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(1)\\n\\n try:\\n if env is None:\\n os.execv(command, argv)\\n else:\\n os.execvpe(command, argv, env)\\n except OSError as err:\\n # [issue #119] 5. If exec fails, the child writes the error\\n # code back to the parent using the pipe, then exits.\\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(os.EX_OSERR)\\n\\n # Parent\\n inst = cls(pid, fd)\\n \\n # Set some informational attributes\\n inst.argv = argv\\n if env is not None:\\n inst.env = env\\n if cwd is not None:\\n inst.launch_dir = cwd\\n\\n # [issue #119] 2. After forking, the parent closes the writing end\\n # of the pipe and reads from the reading end.\\n os.close(exec_err_pipe_write)\\n exec_err_data = os.read(exec_err_pipe_read, 4096)\\n os.close(exec_err_pipe_read)\\n\\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\\n # child successfully performed exec, since close-on-exec made\\n # successful exec close the writing end of the pipe. Or, if exec\\n # failed, the parent reads the error code and can proceed\\n # accordingly. Either way, the parent blocks until the child calls\\n # exec.\\n if len(exec_err_data) != 0:\\n try:\\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\\n\\n exception = exctype(errmsg.decode('utf-8', 'replace'))\\n if exctype is OSError:\\n exception.errno = int(errno_s)\\n except:\\n raise Exception('Subprocess failed, got bad error data: %r'\\n % exec_err_data)\\n else:\\n raise exception\\n\\n try:\\n inst.setwinsize(*dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\\n raise\\n\\n return inst\\n\\n def __repr__(self):\\n clsname = type(self).__name__\\n if self.argv is not None:\\n args = [repr(self.argv)]\\n if self.env is not None:\\n args.append(\\\"env=%r\\\" % self.env)\\n if self.launch_dir is not None:\\n args.append(\\\"cwd=%r\\\" % self.launch_dir)\\n \\n return \\\"{}.spawn({})\\\".format(clsname, \\\", \\\".join(args))\\n \\n else:\\n return \\\"{}(pid={}, fd={})\\\".format(clsname, self.pid, self.fd)\\n\\n @staticmethod\\n def _coerce_send_string(s):\\n if not isinstance(s, bytes):\\n return s.encode('utf-8')\\n return s\\n\\n @staticmethod\\n def _coerce_read_string(s):\\n return s\\n\\n def __del__(self):\\n '''This makes sure that no system resources are left open. Python only\\n garbage collects Python objects. OS file descriptors are not Python\\n objects, so they must be handled explicitly. If the child file\\n descriptor was opened outside of this class (passed to the constructor)\\n then this does not close it. '''\\n\\n if not self.closed:\\n # It is possible for __del__ methods to execute during the\\n # teardown of the Python VM itself. Thus self.close() may\\n # trigger an exception because os.close may be None.\\n try:\\n self.close()\\n # which exception, shouldn't we catch explicitly .. ?\\n except:\\n pass\\n\\n\\n def fileno(self):\\n '''This returns the file descriptor of the pty for the child.\\n '''\\n return self.fd\\n\\n def close(self, force=True):\\n '''This closes the connection with the child application. Note that\\n calling close() more than once is valid. This emulates standard Python\\n behavior with files. Set force to True if you want to make sure that\\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\\n and SIGINT). '''\\n if not self.closed:\\n self.flush()\\n self.fileobj.close() # Closes the file descriptor\\n # Give kernel time to update process status.\\n time.sleep(self.delayafterclose)\\n if self.isalive():\\n if not self.terminate(force):\\n raise PtyProcessError('Could not terminate the child.')\\n self.fd = -1\\n self.closed = True\\n #self.pid = None\\n\\n def flush(self):\\n '''This does nothing. It is here to support the interface for a\\n File-like object. '''\\n\\n pass\\n\\n def isatty(self):\\n '''This returns True if the file descriptor is open and connected to a\\n tty(-like) device, else False.\\n\\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\\n the child pty may not appear as a terminal device. This means\\n methods such as setecho(), setwinsize(), getwinsize() may raise an\\n IOError. '''\\n\\n return os.isatty(self.fd)\\n\\n def waitnoecho(self, timeout=None):\\n '''Wait until the terminal ECHO flag is set False.\\n\\n This returns True if the echo mode is off, or False if echo was not\\n disabled before the timeout. This can be used to detect when the\\n child is waiting for a password. Usually a child application will turn\\n off echo mode when it is waiting for the user to enter a password. For\\n example, instead of expecting the \\\"password:\\\" prompt you can wait for\\n the child to turn echo off::\\n\\n p = pexpect.spawn('ssh user@example.com')\\n p.waitnoecho()\\n p.sendline(mypassword)\\n\\n If ``timeout=None`` then this method to block until ECHO flag is False.\\n '''\\n\\n if timeout is not None:\\n end_time = time.time() + timeout\\n while True:\\n if not self.getecho():\\n return True\\n if timeout < 0 and timeout is not None:\\n return False\\n if timeout is not None:\\n timeout = end_time - time.time()\\n time.sleep(0.1)\\n\\n def getecho(self):\\n '''Returns True if terminal echo is on, or False if echo is off.\\n\\n Child applications that are expecting you to enter a password often\\n disable echo. See also :meth:`waitnoecho`.\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n\\n try:\\n attr = termios.tcgetattr(self.fd)\\n except termios.error as err:\\n errmsg = 'getecho() may not be called on this platform'\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n self.echo = bool(attr[3] & termios.ECHO)\\n return self.echo\\n\\n def setecho(self, state):\\n '''Enable or disable terminal echo.\\n\\n Anything the child sent before the echo will be lost, so you should be\\n sure that your input buffer is empty before you call setecho().\\n For example, the following will work as expected::\\n\\n p = pexpect.spawn('cat') # Echo is on by default.\\n p.sendline('1234') # We expect see this twice from the child...\\n p.expect(['1234']) # ... once from the tty echo...\\n p.expect(['1234']) # ... and again from cat itself.\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n The following WILL NOT WORK because the lines sent before the setecho\\n will be lost::\\n\\n p = pexpect.spawn('cat')\\n p.sendline('1234')\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['1234'])\\n p.expect(['1234'])\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n _setecho(self.fd, state)\\n\\n self.echo = state\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read and return at most ``size`` bytes from the pty.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\\n with the vagaries of EOF on platforms that do strange things, like IRIX\\n or older Solaris systems. It handles the errno=EIO pattern used on\\n Linux, and the empty-string return used on BSD platforms and (seemingly)\\n on recent Solaris.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.read1(size)\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.readline()\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def _writeb(self, b, flush=True):\\n n = self.fileobj.write(b)\\n if flush:\\n self.fileobj.flush()\\n return n\\n\\n def write(self, s, flush=True):\\n \\\"\\\"\\\"Write bytes to the pseudoterminal.\\n \\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n return self._writeb(s, flush=flush)\\n\\n def sendcontrol(self, char):\\n '''Helper method for sending control characters to the terminal.\\n\\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\\\\\a'``)::\\n\\n child.sendcontrol('g')\\n\\n See also, :meth:`sendintr` and :meth:`sendeof`.\\n '''\\n char = char.lower()\\n a = ord(char)\\n if 97 <= a <= 122:\\n a = a - ord('a') + 1\\n byte = _byte(a)\\n return self._writeb(byte), byte\\n d = {'@': 0, '`': 0,\\n '[': 27, '{': 27,\\n '\\\\\\\\': 28, '|': 28,\\n ']': 29, '}': 29,\\n '^': 30, '~': 30,\\n '_': 31,\\n '?': 127}\\n if char not in d:\\n return 0, b''\\n\\n byte = _byte(d[char])\\n return self._writeb(byte), byte\\n\\n def sendeof(self):\\n '''Sends an EOF (typically Ctrl-D) through the terminal.\\n\\n This sends a character which causes\\n the pending parent output buffer to be sent to the waiting child\\n program without waiting for end-of-line. If it is the first character\\n of the line, the read() in the user program returns 0, which signifies\\n end-of-file. This means to work as expected a sendeof() has to be\\n called at the beginning of a line. This method does not send a newline.\\n It is the responsibility of the caller to ensure the eof is sent at the\\n beginning of a line.\\n '''\\n return self._writeb(_EOF), _EOF\\n\\n def sendintr(self):\\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\\n\\n This will normally trigger the kernel to send SIGINT to the current\\n foreground process group. Processes can turn off this translation, in\\n which case they can read the raw data sent, e.g. ``b'\\\\\\\\x03'`` for Ctrl-C.\\n\\n See also the :meth:`kill` method, which sends a signal directly to the\\n immediate child process in the terminal (which is not necessarily the\\n foreground process).\\n '''\\n return self._writeb(_INTR), _INTR\\n\\n def eof(self):\\n '''This returns True if the EOF exception was ever raised.\\n '''\\n\\n return self.flag_eof\\n\\n def terminate(self, force=False):\\n '''This forces a child process to terminate. It starts nicely with\\n SIGHUP and SIGINT. If \\\"force\\\" is True then moves onto SIGKILL. This\\n returns True if the child was terminated. This returns False if the\\n child could not be terminated. '''\\n\\n if not self.isalive():\\n return True\\n try:\\n self.kill(signal.SIGHUP)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGCONT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGINT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n if force:\\n self.kill(signal.SIGKILL)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n return False\\n except OSError:\\n # I think there are kernel timing issues that sometimes cause\\n # this to happen. I think isalive() reports True, but the\\n # process is dead to the kernel.\\n # Make one last attempt to see if the kernel is up to date.\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n\\n def wait(self):\\n '''This waits until the child exits. This is a blocking call. This will\\n not read any data from the child, so this will block forever if the\\n child has unread output and has terminated. In other words, the child\\n may have printed output then called exit(), but, the child is\\n technically still alive until its output is read by the parent. '''\\n\\n if self.isalive():\\n pid, status = os.waitpid(self.pid, 0)\\n else:\\n return self.exitstatus\\n self.exitstatus = os.WEXITSTATUS(status)\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status): # pragma: no cover\\n # You can't call wait() on a child process in the stopped state.\\n raise PtyProcessError('Called wait() on a stopped child ' +\\n 'process. This is not supported. Is some other ' +\\n 'process attempting job control with our child pid?')\\n return self.exitstatus\\n\\n def isalive(self):\\n '''This tests if the child process is running or not. This is\\n non-blocking. If the child was terminated then this will read the\\n exitstatus or signalstatus of the child. This returns True if the child\\n process appears to be running or False if not. It can take literally\\n SECONDS for Solaris to return the right status. '''\\n\\n if self.terminated:\\n return False\\n\\n if self.flag_eof:\\n # This is for Linux, which requires the blocking form\\n # of waitpid to get the status of a defunct process.\\n # This is super-lame. The flag_eof would have been set\\n # in read_nonblocking(), so this should be safe.\\n waitpid_options = 0\\n else:\\n waitpid_options = os.WNOHANG\\n\\n try:\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e:\\n # No child processes\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where \\\"terminated\\\" is 0, but there was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # I have to do this twice for Solaris.\\n # I can't even believe that I figured this out...\\n # If waitpid() returns 0 it means that no child process\\n # wishes to report, and the value of status is undefined.\\n if pid == 0:\\n try:\\n ### os.WNOHANG) # Solaris!\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e: # pragma: no cover\\n # This should never happen...\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'that should never happen. There was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # If pid is still 0 after two calls to waitpid() then the process\\n # really is alive. This seems to work on all platforms, except for\\n # Irix which seems to require a blocking call on waitpid or select,\\n # so I let read_nonblocking take care of this situation\\n # (unfortunately, this requires waiting through the timeout).\\n if pid == 0:\\n return True\\n\\n if pid == 0:\\n return True\\n\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status):\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where child process is stopped. This is not ' +\\n 'supported. Is some other process attempting ' +\\n 'job control with our child pid?')\\n return False\\n\\n def kill(self, sig):\\n \\\"\\\"\\\"Send the given signal to the child application.\\n\\n In keeping with UNIX tradition it has a misleading name. It does not\\n necessarily kill the child unless you send the right signal. See the\\n :mod:`signal` module for constants representing signal numbers.\\n \\\"\\\"\\\"\\n\\n # Same as os.kill, but the pid is given for you.\\n if self.isalive():\\n os.kill(self.pid, sig)\\n\\n def getwinsize(self):\\n \\\"\\\"\\\"Return the window size of the pseudoterminal as a tuple (rows, cols).\\n \\\"\\\"\\\"\\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\\n s = struct.pack('HHHH', 0, 0, 0, 0)\\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\\n return struct.unpack('HHHH', x)[0:2]\\n\\n def setwinsize(self, rows, cols):\\n \\\"\\\"\\\"Set the terminal window size of the child tty.\\n\\n This will cause a SIGWINCH signal to be sent to the child. This does not\\n change the physical window size. It changes the size reported to\\n TTY-aware applications like vi or curses -- applications that respond to\\n the SIGWINCH signal.\\n \\\"\\\"\\\"\\n return _setwinsize(self.fd, rows, cols)\\n\\n\\nclass PtyProcessUnicode(PtyProcess):\\n \\\"\\\"\\\"Unicode wrapper around a process running in a pseudoterminal.\\n\\n This class exposes a similar interface to :class:`PtyProcess`, but its read\\n methods return unicode, and its :meth:`write` accepts unicode.\\n \\\"\\\"\\\"\\n if PY3:\\n string_type = str\\n else:\\n string_type = unicode # analysis:ignore\\n\\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\\n super(PtyProcessUnicode, self).__init__(pid, fd)\\n self.encoding = encoding\\n self.codec_errors = codec_errors\\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read at most ``size`` bytes from the pty, return them as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n\\n The size argument still refers to bytes, not unicode code points.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).read(size)\\n return self.decoder.decode(b, final=False)\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).readline()\\n return self.decoder.decode(b, final=False)\\n\\n def write(self, s):\\n \\\"\\\"\\\"Write the unicode string ``s`` to the pseudoterminal.\\n\\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n b = s.encode(self.encoding)\\n return super(PtyProcessUnicode, self).write(b)\\n\\n[end of ptyprocess/ptyprocess.py]\",\n \"filename\": \"ptyprocess/ptyprocess.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Run a subprocess in a pseudo terminal\\\"\\\"\\\"\\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\\n\\n__version__ = '0.7.0'\\n\\n[end of ptyprocess/__init__.py]\",\n \"filename\": \"ptyprocess/__init__.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"no\\\"?>\\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\\n\\n<svg\\n xmlns:dc=\\\"http://purl.org/dc/elements/1.1/\\\"\\n xmlns:cc=\\\"http://creativecommons.org/ns#\\\"\\n xmlns:rdf=\\\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\\\"\\n xmlns:svg=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns:sodipodi=\\\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\\\"\\n xmlns:inkscape=\\\"http://www.inkscape.org/namespaces/inkscape\\\"\\n width=\\\"554.44196\\\"\\n height=\\\"327.38452\\\"\\n id=\\\"svg2\\\"\\n version=\\\"1.1\\\"\\n inkscape:version=\\\"0.48.4 r9939\\\"\\n sodipodi:docname=\\\"pty_vs_popen.svg\\\">\\n <defs\\n id=\\\"defs4\\\">\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3838\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3783\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(1.1,0,0,1.1,1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Tail\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Tail\\\"\\n style=\\\"overflow:visible\\\">\\n <g\\n id=\\\"g3801\\\"\\n transform=\\\"scale(-1.2,-1.2)\\\">\\n <path\\n id=\\\"path3803\\\"\\n d=\\\"M -3.8048674,-3.9585227 0.54352094,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3805\\\"\\n d=\\\"M -1.2866832,-3.9585227 3.0617053,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3807\\\"\\n d=\\\"M 1.3053582,-3.9585227 5.6537466,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3809\\\"\\n d=\\\"M -3.8048674,4.1775838 0.54352094,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3811\\\"\\n d=\\\"M -1.2866832,4.1775838 3.0617053,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3813\\\"\\n d=\\\"M 1.3053582,4.1775838 5.6537466,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </g>\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3765\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(0.8,0,0,0.8,10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3786\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3768\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(-0.8,0,0,-0.8,-10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-9\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-2\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-6\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-27\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM-5\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3838-7\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10742\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10744\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10746\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10748\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10750\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10752\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10754\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10756\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10758\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10760\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n </defs>\\n <sodipodi:namedview\\n id=\\\"base\\\"\\n pagecolor=\\\"#ffffff\\\"\\n bordercolor=\\\"#666666\\\"\\n borderopacity=\\\"1.0\\\"\\n inkscape:pageopacity=\\\"0.0\\\"\\n inkscape:pageshadow=\\\"2\\\"\\n inkscape:zoom=\\\"0.98994949\\\"\\n inkscape:cx=\\\"77.797977\\\"\\n inkscape:cy=\\\"137.24456\\\"\\n inkscape:document-units=\\\"px\\\"\\n inkscape:current-layer=\\\"layer1\\\"\\n showgrid=\\\"false\\\"\\n inkscape:window-width=\\\"1301\\\"\\n inkscape:window-height=\\\"744\\\"\\n inkscape:window-x=\\\"65\\\"\\n inkscape:window-y=\\\"24\\\"\\n inkscape:window-maximized=\\\"1\\\"\\n fit-margin-top=\\\"1\\\"\\n fit-margin-left=\\\"1\\\"\\n fit-margin-right=\\\"1\\\"\\n fit-margin-bottom=\\\"1\\\"\\n units=\\\"cm\\\" />\\n <metadata\\n id=\\\"metadata7\\\">\\n <rdf:RDF>\\n <cc:Work\\n rdf:about=\\\"\\\">\\n <dc:format>image/svg+xml</dc:format>\\n <dc:type\\n rdf:resource=\\\"http://purl.org/dc/dcmitype/StillImage\\\" />\\n <dc:title></dc:title>\\n </cc:Work>\\n </rdf:RDF>\\n </metadata>\\n <g\\n inkscape:label=\\\"Layer 1\\\"\\n inkscape:groupmode=\\\"layer\\\"\\n id=\\\"layer1\\\"\\n transform=\\\"translate(-40.758533,29.820888)\\\">\\n <g\\n id=\\\"g11880\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591\\\"\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n id=\\\"tspan10593\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <g\\n id=\\\"g10626\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991\\\"\\n d=\\\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7\\\"\\n d=\\\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\\\"\\n id=\\\"path2991-7-8\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5637\\\"\\n d=\\\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5641\\\"\\n d=\\\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5643\\\"\\n d=\\\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n id=\\\"tspan6247\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(18,0)\\\"\\n id=\\\"g11773\\\">\\n <g\\n id=\\\"g11763\\\">\\n <rect\\n y=\\\"120.8597\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308\\\"\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n id=\\\"tspan6310\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g11768\\\">\\n <rect\\n y=\\\"135.43114\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304\\\"\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n id=\\\"tspan6306\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(54,-16)\\\"\\n id=\\\"g10674\\\">\\n <g\\n id=\\\"g10664\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(86.857134,-15.571435)\\\"\\n id=\\\"g10674-6\\\">\\n <g\\n id=\\\"g10664-6\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0-5\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-9\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7-6\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669-5\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5-3\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6-1\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n id=\\\"tspan10728\\\"\\n sodipodi:role=\\\"line\\\">Popen</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-89\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-24\\\"\\n style=\\\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n sodipodi:role=\\\"line\\\">pipes</tspan></text>\\n </g>\\n <g\\n id=\\\"g11847\\\"\\n transform=\\\"translate(-10,0.39179)\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328-0\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-8\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591-3\\\"\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n id=\\\"tspan10593-2\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path11075\\\"\\n d=\\\"m 397.80427,110.64896 0,-52.85714\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\\\" />\\n <g\\n id=\\\"g10626-5\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2-4\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334-0\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336-9\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-4\\\"\\n d=\\\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7-87\\\"\\n d=\\\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331-7\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\\\"\\n id=\\\"path2991-7-8-4\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-6\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n id=\\\"tspan6247-3\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-6\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-2\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8-1\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298-3\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(227.5656,-301.02546)\\\"\\n id=\\\"g11065\\\">\\n <g\\n id=\\\"g11055\\\">\\n <rect\\n y=\\\"421.34998\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55\\\"\\n style=\\\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6\\\"\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n id=\\\"tspan6310-7-9\\\"\\n sodipodi:role=\\\"line\\\">slave</tspan></text>\\n </g>\\n <g\\n id=\\\"g11060\\\">\\n <rect\\n y=\\\"407.25223\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55-9\\\"\\n style=\\\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6-7\\\"\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n id=\\\"tspan6310-7-9-7\\\"\\n sodipodi:role=\\\"line\\\">master</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726-9\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n id=\\\"tspan10728-7\\\"\\n sodipodi:role=\\\"line\\\">Pseudoterminal</tspan><tspan\\n id=\\\"tspan11761\\\"\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"136.71899\\\"\\n x=\\\"429.1268\\\"\\n sodipodi:role=\\\"line\\\">(pty)</tspan></text>\\n </g>\\n </g>\\n</svg>\\n\\n[end of docs/images/pty_vs_popen.svg]\",\n \"filename\": \"docs/images/pty_vs_popen.svg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"None\\n[end of docs/images/pty_vs_popen.png]\",\n \"filename\": \"docs/images/pty_vs_popen.png\",\n \"id\": \"13\"\n }\n]","isConversational":false}}},{"rowIdx":80,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 80,\n \"num_files\": 14,\n \"repo_id\": \"repo_0080\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"python:\n version: 3\n\n[end of readthedocs.yml]","filename":"readthedocs.yml","id":"0"},{"content":"ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, Pexpect development team\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\n\n Permission to use, copy, modify, and/or distribute this software for any\n purpose with or without fee is hereby granted, provided that the above\n copyright notice and this permission notice appear in all copies.\n \n THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"[build-system]\nrequires = [\"flit_core >=2,<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.metadata]\nmodule = \"ptyprocess\"\nauthor = \"Thomas Kluyver\"\nauthor-email = \"thomas@kluyver.me.uk\"\nhome-page = \"https://github.com/pexpect/ptyprocess\"\ndescription-file = \"README.rst\"\nrequires-python = \">=3.7\"\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: ISC License (ISCL)\",\n \"Operating System :: POSIX\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Topic :: Terminals\"\n]\n\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"Launch a subprocess in a pseudo terminal (pty), and interact with both the\nprocess and its pty.\n\nSometimes, piping stdin and stdout is not enough. There might be a password\nprompt that doesn't read from stdin, output that changes when it's going to a\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\nIf you need to automate these things, running the process in a pseudo terminal\n(pty) is the answer.\n\nInterface:\n\n.. code:: python\n\n from ptyprocess import PtyProcessUnicode\n p = PtyProcessUnicode.spawn(['python'])\n p.read(20)\n p.write('6+6\\n')\n p.read(20)\n\n[end of README.rst]","filename":"README.rst","id":"3"},{"content":"Ptyprocess\n==========\n\n.. include:: ../README.rst\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n\n api\n\nWhat is a pty?\n--------------\n\nA pty is a kernel-level object which processes can write data to and read data\nfrom, a bit like a pipe.\n\nUnlike a pipe, data moves through a single pty in both directions. When you use\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\nto three pipes are created for the process's standard streams (stdin, stdout\nand stderr). When you run a program using ptyprocess, all three of its standard\nstreams are connected to a single pty:\n\n.. image:: images/pty_vs_popen.png\n\nA pty also does more than a pipe. It keeps track of the window size (rows and\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\nSIGINT to be sent to the child process.\n\nMany command line programs behave differently if they detect that stdin or stdout\nis connected to a terminal instead of a pipe (using \n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\nthat they're being used interactively by a human user.\nThey may format output differently (e.g. ``ls`` lists files in columns)\nor prompt the user to confirm actions.\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\n\n.. seealso::\n\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\n Detailed article by Linus Akesson\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"4"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = _build\n\n# User-friendly check for sphinx-build\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\nendif\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" xml to make Docutils-native XML files\"\n\t@echo \" pseudoxml to make pseudoxml-XML files for display purposes\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\trm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\nlatexpdfja:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through platex and dvipdfmx...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\nxml:\n\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\n\t@echo\n\t@echo \"Build finished. The XML files are in $(BUILDDIR)/xml.\"\n\npseudoxml:\n\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\n\t@echo\n\t@echo \"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\"\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"5"},{"content":"# -*- coding: utf-8 -*-\n#\n# Ptyprocess documentation build configuration file, created by\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\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\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.insert(0, os.path.abspath('..'))\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.viewcode',\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'Ptyprocess'\ncopyright = u'2014, Thomas Kluyver'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.7'\n# The full version, including alpha/beta/rc tags.\nrelease = version #+ '.2'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\n\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#html_extra_path = []\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'Ptyprocessdoc'\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\n [u'Thomas Kluyver'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {'http://docs.python.org/': None}\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"6"},{"content":"Ptyprocess API\n==============\n\n.. module:: ptyprocess\n\n.. autoclass:: PtyProcess\n\n .. automethod:: spawn\n\n .. automethod:: read\n\n .. automethod:: readline\n\n .. automethod:: write\n\n .. automethod:: sendcontrol\n\n .. automethod:: sendeof\n\n .. automethod:: sendintr\n\n .. automethod:: getecho\n\n .. automethod:: waitnoecho\n\n .. automethod:: setecho\n\n .. automethod:: getwinsize\n\n .. automethod:: setwinsize\n\n .. automethod:: eof\n\n .. automethod:: isalive\n\n .. automethod:: wait\n\n .. automethod:: kill\n\n .. automethod:: terminate\n\n .. automethod:: close\n\n.. autoclass:: PtyProcessUnicode\n\n[end of docs/api.rst]","filename":"docs/api.rst","id":"7"},{"content":"try:\n from shutil import which # Python >= 3.3\nexcept ImportError:\n import os, sys\n \n # This is copied from Python 3.4.1\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\n \"\"\"Given a command, mode, and a PATH string, return the path which\n conforms to the given mode on the PATH, or None if there is no such\n file.\n \n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\n of os.environ.get(\"PATH\"), or can be overridden with a custom search\n path.\n \n \"\"\"\n # Check that a given file can be accessed with the correct mode.\n # Additionally check that `file` is not a directory, as on Windows\n # directories pass the os.access check.\n def _access_check(fn, mode):\n return (os.path.exists(fn) and os.access(fn, mode)\n and not os.path.isdir(fn))\n \n # If we're given a path with a directory part, look it up directly rather\n # than referring to PATH directories. This includes checking relative to the\n # current directory, e.g. ./script\n if os.path.dirname(cmd):\n if _access_check(cmd, mode):\n return cmd\n return None\n \n if path is None:\n path = os.environ.get(\"PATH\", os.defpath)\n if not path:\n return None\n path = path.split(os.pathsep)\n \n if sys.platform == \"win32\":\n # The current directory takes precedence on Windows.\n if not os.curdir in path:\n path.insert(0, os.curdir)\n \n # PATHEXT is necessary to check on Windows.\n pathext = os.environ.get(\"PATHEXT\", \"\").split(os.pathsep)\n # See if the given file matches any of the expected path extensions.\n # This will allow us to short circuit when given \"python.exe\".\n # If it does match, only test that one, otherwise we have to try\n # others.\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\n files = [cmd]\n else:\n files = [cmd + ext for ext in pathext]\n else:\n # On other platforms you don't have things like PATHEXT to tell you\n # what file suffixes are executable, so just pass on cmd as-is.\n files = [cmd]\n \n seen = set()\n for dir in path:\n normdir = os.path.normcase(dir)\n if not normdir in seen:\n seen.add(normdir)\n for thefile in files:\n name = os.path.join(dir, thefile)\n if _access_check(name, mode):\n return name\n return None\n\n\nclass PtyProcessError(Exception):\n \"\"\"Generic error class for this package.\"\"\"\n\n[end of ptyprocess/util.py]","filename":"ptyprocess/util.py","id":"8"},{"content":"\"\"\"Substitute for the forkpty system call, to support Solaris.\n\"\"\"\nimport os\nimport errno\n\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\nfrom .util import PtyProcessError\n\ndef fork_pty():\n '''This implements a substitute for the forkpty system call. This\n should be more portable than the pty.fork() function. Specifically,\n this should work on Solaris.\n\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\n resolve the issue with Python's pty.fork() not supporting Solaris,\n particularly ssh. Based on patch to posixmodule.c authored by Noah\n Spurrier::\n\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\n\n '''\n\n parent_fd, child_fd = os.openpty()\n if parent_fd < 0 or child_fd < 0:\n raise OSError(\"os.openpty() failed\")\n\n pid = os.fork()\n if pid == CHILD:\n # Child.\n os.close(parent_fd)\n pty_make_controlling_tty(child_fd)\n\n os.dup2(child_fd, STDIN_FILENO)\n os.dup2(child_fd, STDOUT_FILENO)\n os.dup2(child_fd, STDERR_FILENO)\n\n else:\n # Parent.\n os.close(child_fd)\n\n return pid, parent_fd\n\ndef pty_make_controlling_tty(tty_fd):\n '''This makes the pseudo-terminal the controlling tty. This should be\n more portable than the pty.fork() function. Specifically, this should\n work on Solaris. '''\n\n child_name = os.ttyname(tty_fd)\n\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\n # if there was no controlling tty to begin with, such as when\n # executed by a cron(1) job.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n os.setsid()\n\n # Verify we are disconnected from controlling tty by attempting to open\n # it again. We expect that OSError of ENXIO should always be raised.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n raise PtyProcessError(\"OSError of errno.ENXIO should be raised.\")\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n # Verify we can open child pty.\n fd = os.open(child_name, os.O_RDWR)\n os.close(fd)\n\n # Verify we now have a controlling tty.\n fd = os.open(\"/dev/tty\", os.O_WRONLY)\n os.close(fd)\n\n[end of ptyprocess/_fork_pty.py]","filename":"ptyprocess/_fork_pty.py","id":"9"},{"content":"import codecs\nimport errno\nimport fcntl\nimport io\nimport os\nimport pty\nimport resource\nimport signal\nimport struct\nimport sys\nimport termios\nimport time\n\ntry:\n import builtins # Python 3\nexcept ImportError:\n import __builtin__ as builtins # Python 2\n\n# Constants\nfrom pty import (STDIN_FILENO, CHILD)\n\nfrom .util import which, PtyProcessError\n\n_platform = sys.platform.lower()\n\n# Solaris uses internal __fork_pty(). All others use pty.fork().\n_is_solaris = (\n _platform.startswith('solaris') or\n _platform.startswith('sunos'))\n\nif _is_solaris:\n use_native_pty_fork = False\n from . import _fork_pty\nelse:\n use_native_pty_fork = True\n\nPY3 = sys.version_info[0] >= 3\n\nif PY3:\n def _byte(i):\n return bytes([i])\nelse:\n def _byte(i):\n return chr(i)\n \n class FileNotFoundError(OSError): pass\n class TimeoutError(OSError): pass\n\n_EOF, _INTR = None, None\n\ndef _make_eof_intr():\n \"\"\"Set constants _EOF and _INTR.\n \n This avoids doing potentially costly operations on module load.\n \"\"\"\n global _EOF, _INTR\n if (_EOF is not None) and (_INTR is not None):\n return\n\n # inherit EOF and INTR definitions from controlling process.\n try:\n from termios import VEOF, VINTR\n fd = None\n for name in 'stdin', 'stdout':\n stream = getattr(sys, '__%s__' % name, None)\n if stream is None or not hasattr(stream, 'fileno'):\n continue\n try:\n fd = stream.fileno()\n except ValueError:\n continue\n if fd is None:\n # no fd, raise ValueError to fallback on CEOF, CINTR\n raise ValueError(\"No stream has a fileno\")\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\n except (ImportError, OSError, IOError, ValueError, termios.error):\n # unless the controlling process is also not a terminal,\n # such as cron(1), or when stdin and stdout are both closed.\n # Fall-back to using CEOF and CINTR. There\n try:\n from termios import CEOF, CINTR\n (intr, eof) = (CINTR, CEOF)\n except ImportError:\n # ^C, ^D\n (intr, eof) = (3, 4)\n \n _INTR = _byte(intr)\n _EOF = _byte(eof)\n\n# setecho and setwinsize are pulled out here because on some platforms, we need\n# to do this from the child before we exec()\n \ndef _setecho(fd, state):\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\n\n try:\n attr = termios.tcgetattr(fd)\n except termios.error as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n if state:\n attr[3] = attr[3] | termios.ECHO\n else:\n attr[3] = attr[3] & ~termios.ECHO\n\n try:\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\n # blocked on some platforms. TCSADRAIN would probably be ideal.\n termios.tcsetattr(fd, termios.TCSANOW, attr)\n except IOError as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\ndef _setwinsize(fd, rows, cols):\n # Some very old platforms have a bug that causes the value for\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\n # around this, but it caused problems with newer platforms so has been\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\n # Note, assume ws_xpixel and ws_ypixel are zero.\n s = struct.pack('HHHH', rows, cols, 0, 0)\n fcntl.ioctl(fd, TIOCSWINSZ, s)\n\nclass PtyProcess(object):\n '''This class represents a process running in a pseudoterminal.\n \n The main constructor is the :meth:`spawn` classmethod.\n '''\n string_type = bytes\n if PY3:\n linesep = os.linesep.encode('ascii')\n crlf = '\\r\\n'.encode('ascii')\n\n @staticmethod\n def write_to_stdout(b):\n try:\n return sys.stdout.buffer.write(b)\n except AttributeError:\n # If stdout has been replaced, it may not have .buffer\n return sys.stdout.write(b.decode('ascii', 'replace'))\n else:\n linesep = os.linesep\n crlf = '\\r\\n'\n write_to_stdout = sys.stdout.write\n\n encoding = None\n \n argv = None\n env = None\n launch_dir = None\n\n def __init__(self, pid, fd):\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\n self.pid = pid\n self.fd = fd\n readf = io.open(fd, 'rb', buffering=0)\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\n self.fileobj = io.BufferedRWPair(readf, writef)\n\n self.terminated = False\n self.closed = False\n self.exitstatus = None\n self.signalstatus = None\n # status returned by os.waitpid\n self.status = None\n self.flag_eof = False\n # Used by close() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterclose = 0.1\n # Used by terminate() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterterminate = 0.1\n\n @classmethod\n def spawn(\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\n dimensions=(24, 80), pass_fds=()):\n '''Start the given command in a child process in a pseudo terminal.\n\n This does all the fork/exec type of stuff for a pty, and returns an\n instance of PtyProcess.\n\n If preexec_fn is supplied, it will be called with no arguments in the\n child process before exec-ing the specified command.\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\n\n Dimensions of the psuedoterminal used for the subprocess can be\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\n\n By default, all file descriptors except 0, 1 and 2 are closed. This\n behavior can be overridden with pass_fds, a list of file descriptors to\n keep open between the parent and the child.\n '''\n # Note that it is difficult for this method to fail.\n # You cannot detect if the child process cannot start.\n # So the only way you can tell if the child process started\n # or not is to try to read from the file descriptor. If you get\n # EOF immediately then it means that the child is already dead.\n # That may not necessarily be bad because you may have spawned a child\n # that performs some task; creates no stdout output; and then dies.\n\n if not isinstance(argv, (list, tuple)):\n raise TypeError(\"Expected a list or tuple for argv, got %r\" % argv)\n\n # Shallow copy of argv so we can modify it\n argv = argv[:]\n command = argv[0]\n\n command_with_path = which(command)\n if command_with_path is None:\n raise FileNotFoundError('The command was not found or was not ' +\n 'executable: %s.' % command)\n command = command_with_path\n argv[0] = command\n\n # [issue #119] To prevent the case where exec fails and the user is\n # stuck interacting with a python child process instead of whatever\n # was expected, we implement the solution from\n # http://stackoverflow.com/a/3703179 to pass the exception to the\n # parent process\n\n # [issue #119] 1. Before forking, open a pipe in the parent process.\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\n\n if use_native_pty_fork:\n pid, fd = pty.fork()\n else:\n # Use internal fork_pty, for Solaris\n pid, fd = _fork_pty.fork_pty()\n\n # Some platforms must call setwinsize() and setecho() from the\n # child process, and others from the master process. We do both,\n # allowing IOError for either.\n\n if pid == CHILD:\n # set window size\n try:\n _setwinsize(STDIN_FILENO, *dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # disable echo if spawn argument echo was unset\n if not echo:\n try:\n _setecho(STDIN_FILENO, False)\n except (IOError, termios.error) as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # [issue #119] 3. The child closes the reading end and sets the\n # close-on-exec flag for the writing end.\n os.close(exec_err_pipe_read)\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\n\n # Do not allow child to inherit open file descriptors from parent,\n # with the exception of the exec_err_pipe_write of the pipe\n # and pass_fds.\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\n # occasionally raises out of range error\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\n os.closerange(pair[0]+1, pair[1])\n\n if cwd is not None:\n os.chdir(cwd)\n\n if preexec_fn is not None:\n try:\n preexec_fn()\n except Exception as e:\n ename = type(e).__name__\n tosend = '{}:0:{}'.format(ename, str(e))\n if PY3:\n tosend = tosend.encode('utf-8')\n\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(1)\n\n try:\n if env is None:\n os.execv(command, argv)\n else:\n os.execvpe(command, argv, env)\n except OSError as err:\n # [issue #119] 5. If exec fails, the child writes the error\n # code back to the parent using the pipe, then exits.\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\n if PY3:\n tosend = tosend.encode('utf-8')\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(os.EX_OSERR)\n\n # Parent\n inst = cls(pid, fd)\n \n # Set some informational attributes\n inst.argv = argv\n if env is not None:\n inst.env = env\n if cwd is not None:\n inst.launch_dir = cwd\n\n # [issue #119] 2. After forking, the parent closes the writing end\n # of the pipe and reads from the reading end.\n os.close(exec_err_pipe_write)\n exec_err_data = os.read(exec_err_pipe_read, 4096)\n os.close(exec_err_pipe_read)\n\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\n # child successfully performed exec, since close-on-exec made\n # successful exec close the writing end of the pipe. Or, if exec\n # failed, the parent reads the error code and can proceed\n # accordingly. Either way, the parent blocks until the child calls\n # exec.\n if len(exec_err_data) != 0:\n try:\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\n\n exception = exctype(errmsg.decode('utf-8', 'replace'))\n if exctype is OSError:\n exception.errno = int(errno_s)\n except:\n raise Exception('Subprocess failed, got bad error data: %r'\n % exec_err_data)\n else:\n raise exception\n\n try:\n inst.setwinsize(*dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\n raise\n\n return inst\n\n def __repr__(self):\n clsname = type(self).__name__\n if self.argv is not None:\n args = [repr(self.argv)]\n if self.env is not None:\n args.append(\"env=%r\" % self.env)\n if self.launch_dir is not None:\n args.append(\"cwd=%r\" % self.launch_dir)\n \n return \"{}.spawn({})\".format(clsname, \", \".join(args))\n \n else:\n return \"{}(pid={}, fd={})\".format(clsname, self.pid, self.fd)\n\n @staticmethod\n def _coerce_send_string(s):\n if not isinstance(s, bytes):\n return s.encode('utf-8')\n return s\n\n @staticmethod\n def _coerce_read_string(s):\n return s\n\n def __del__(self):\n '''This makes sure that no system resources are left open. Python only\n garbage collects Python objects. OS file descriptors are not Python\n objects, so they must be handled explicitly. If the child file\n descriptor was opened outside of this class (passed to the constructor)\n then this does not close it. '''\n\n if not self.closed:\n # It is possible for __del__ methods to execute during the\n # teardown of the Python VM itself. Thus self.close() may\n # trigger an exception because os.close may be None.\n try:\n self.close()\n # which exception, shouldn't we catch explicitly .. ?\n except:\n pass\n\n\n def fileno(self):\n '''This returns the file descriptor of the pty for the child.\n '''\n return self.fd\n\n def close(self, force=True):\n '''This closes the connection with the child application. Note that\n calling close() more than once is valid. This emulates standard Python\n behavior with files. Set force to True if you want to make sure that\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\n and SIGINT). '''\n if not self.closed:\n self.flush()\n self.fileobj.close() # Closes the file descriptor\n # Give kernel time to update process status.\n time.sleep(self.delayafterclose)\n if self.isalive():\n if not self.terminate(force):\n raise PtyProcessError('Could not terminate the child.')\n self.fd = -1\n self.closed = True\n #self.pid = None\n\n def flush(self):\n '''This does nothing. It is here to support the interface for a\n File-like object. '''\n\n pass\n\n def isatty(self):\n '''This returns True if the file descriptor is open and connected to a\n tty(-like) device, else False.\n\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\n the child pty may not appear as a terminal device. This means\n methods such as setecho(), setwinsize(), getwinsize() may raise an\n IOError. '''\n\n return os.isatty(self.fd)\n\n def waitnoecho(self, timeout=None):\n '''Wait until the terminal ECHO flag is set False.\n\n This returns True if the echo mode is off, or False if echo was not\n disabled before the timeout. This can be used to detect when the\n child is waiting for a password. Usually a child application will turn\n off echo mode when it is waiting for the user to enter a password. For\n example, instead of expecting the \"password:\" prompt you can wait for\n the child to turn echo off::\n\n p = pexpect.spawn('ssh user@example.com')\n p.waitnoecho()\n p.sendline(mypassword)\n\n If ``timeout=None`` then this method to block until ECHO flag is False.\n '''\n\n if timeout is not None:\n end_time = time.time() + timeout\n while True:\n if not self.getecho():\n return True\n if timeout < 0 and timeout is not None:\n return False\n if timeout is not None:\n timeout = end_time - time.time()\n time.sleep(0.1)\n\n def getecho(self):\n '''Returns True if terminal echo is on, or False if echo is off.\n\n Child applications that are expecting you to enter a password often\n disable echo. See also :meth:`waitnoecho`.\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n\n try:\n attr = termios.tcgetattr(self.fd)\n except termios.error as err:\n errmsg = 'getecho() may not be called on this platform'\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n self.echo = bool(attr[3] & termios.ECHO)\n return self.echo\n\n def setecho(self, state):\n '''Enable or disable terminal echo.\n\n Anything the child sent before the echo will be lost, so you should be\n sure that your input buffer is empty before you call setecho().\n For example, the following will work as expected::\n\n p = pexpect.spawn('cat') # Echo is on by default.\n p.sendline('1234') # We expect see this twice from the child...\n p.expect(['1234']) # ... once from the tty echo...\n p.expect(['1234']) # ... and again from cat itself.\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n The following WILL NOT WORK because the lines sent before the setecho\n will be lost::\n\n p = pexpect.spawn('cat')\n p.sendline('1234')\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['1234'])\n p.expect(['1234'])\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n _setecho(self.fd, state)\n\n self.echo = state\n\n def read(self, size=1024):\n \"\"\"Read and return at most ``size`` bytes from the pty.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\n with the vagaries of EOF on platforms that do strange things, like IRIX\n or older Solaris systems. It handles the errno=EIO pattern used on\n Linux, and the empty-string return used on BSD platforms and (seemingly)\n on recent Solaris.\n \"\"\"\n try:\n s = self.fileobj.read1(size)\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n try:\n s = self.fileobj.readline()\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def _writeb(self, b, flush=True):\n n = self.fileobj.write(b)\n if flush:\n self.fileobj.flush()\n return n\n\n def write(self, s, flush=True):\n \"\"\"Write bytes to the pseudoterminal.\n \n Returns the number of bytes written.\n \"\"\"\n return self._writeb(s, flush=flush)\n\n def sendcontrol(self, char):\n '''Helper method for sending control characters to the terminal.\n\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\a'``)::\n\n child.sendcontrol('g')\n\n See also, :meth:`sendintr` and :meth:`sendeof`.\n '''\n char = char.lower()\n a = ord(char)\n if 97 <= a <= 122:\n a = a - ord('a') + 1\n byte = _byte(a)\n return self._writeb(byte), byte\n d = {'@': 0, '`': 0,\n '[': 27, '{': 27,\n '\\\\': 28, '|': 28,\n ']': 29, '}': 29,\n '^': 30, '~': 30,\n '_': 31,\n '?': 127}\n if char not in d:\n return 0, b''\n\n byte = _byte(d[char])\n return self._writeb(byte), byte\n\n def sendeof(self):\n '''Sends an EOF (typically Ctrl-D) through the terminal.\n\n This sends a character which causes\n the pending parent output buffer to be sent to the waiting child\n program without waiting for end-of-line. If it is the first character\n of the line, the read() in the user program returns 0, which signifies\n end-of-file. This means to work as expected a sendeof() has to be\n called at the beginning of a line. This method does not send a newline.\n It is the responsibility of the caller to ensure the eof is sent at the\n beginning of a line.\n '''\n return self._writeb(_EOF), _EOF\n\n def sendintr(self):\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\n\n This will normally trigger the kernel to send SIGINT to the current\n foreground process group. Processes can turn off this translation, in\n which case they can read the raw data sent, e.g. ``b'\\\\x03'`` for Ctrl-C.\n\n See also the :meth:`kill` method, which sends a signal directly to the\n immediate child process in the terminal (which is not necessarily the\n foreground process).\n '''\n return self._writeb(_INTR), _INTR\n\n def eof(self):\n '''This returns True if the EOF exception was ever raised.\n '''\n\n return self.flag_eof\n\n def terminate(self, force=False):\n '''This forces a child process to terminate. It starts nicely with\n SIGHUP and SIGINT. If \"force\" is True then moves onto SIGKILL. This\n returns True if the child was terminated. This returns False if the\n child could not be terminated. '''\n\n if not self.isalive():\n return True\n try:\n self.kill(signal.SIGHUP)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGCONT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGINT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n if force:\n self.kill(signal.SIGKILL)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n return False\n except OSError:\n # I think there are kernel timing issues that sometimes cause\n # this to happen. I think isalive() reports True, but the\n # process is dead to the kernel.\n # Make one last attempt to see if the kernel is up to date.\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n\n def wait(self):\n '''This waits until the child exits. This is a blocking call. This will\n not read any data from the child, so this will block forever if the\n child has unread output and has terminated. In other words, the child\n may have printed output then called exit(), but, the child is\n technically still alive until its output is read by the parent. '''\n\n if self.isalive():\n pid, status = os.waitpid(self.pid, 0)\n else:\n return self.exitstatus\n self.exitstatus = os.WEXITSTATUS(status)\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status): # pragma: no cover\n # You can't call wait() on a child process in the stopped state.\n raise PtyProcessError('Called wait() on a stopped child ' +\n 'process. This is not supported. Is some other ' +\n 'process attempting job control with our child pid?')\n return self.exitstatus\n\n def isalive(self):\n '''This tests if the child process is running or not. This is\n non-blocking. If the child was terminated then this will read the\n exitstatus or signalstatus of the child. This returns True if the child\n process appears to be running or False if not. It can take literally\n SECONDS for Solaris to return the right status. '''\n\n if self.terminated:\n return False\n\n if self.flag_eof:\n # This is for Linux, which requires the blocking form\n # of waitpid to get the status of a defunct process.\n # This is super-lame. The flag_eof would have been set\n # in read_nonblocking(), so this should be safe.\n waitpid_options = 0\n else:\n waitpid_options = os.WNOHANG\n\n try:\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e:\n # No child processes\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'where \"terminated\" is 0, but there was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # I have to do this twice for Solaris.\n # I can't even believe that I figured this out...\n # If waitpid() returns 0 it means that no child process\n # wishes to report, and the value of status is undefined.\n if pid == 0:\n try:\n ### os.WNOHANG) # Solaris!\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e: # pragma: no cover\n # This should never happen...\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'that should never happen. There was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # If pid is still 0 after two calls to waitpid() then the process\n # really is alive. This seems to work on all platforms, except for\n # Irix which seems to require a blocking call on waitpid or select,\n # so I let read_nonblocking take care of this situation\n # (unfortunately, this requires waiting through the timeout).\n if pid == 0:\n return True\n\n if pid == 0:\n return True\n\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status):\n raise PtyProcessError('isalive() encountered condition ' +\n 'where child process is stopped. This is not ' +\n 'supported. Is some other process attempting ' +\n 'job control with our child pid?')\n return False\n\n def kill(self, sig):\n \"\"\"Send the given signal to the child application.\n\n In keeping with UNIX tradition it has a misleading name. It does not\n necessarily kill the child unless you send the right signal. See the\n :mod:`signal` module for constants representing signal numbers.\n \"\"\"\n\n # Same as os.kill, but the pid is given for you.\n if self.isalive():\n os.kill(self.pid, sig)\n\n def getwinsize(self):\n \"\"\"Return the window size of the pseudoterminal as a tuple (rows, cols).\n \"\"\"\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\n s = struct.pack('HHHH', 0, 0, 0, 0)\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\n return struct.unpack('HHHH', x)[0:2]\n\n def setwinsize(self, rows, cols):\n \"\"\"Set the terminal window size of the child tty.\n\n This will cause a SIGWINCH signal to be sent to the child. This does not\n change the physical window size. It changes the size reported to\n TTY-aware applications like vi or curses -- applications that respond to\n the SIGWINCH signal.\n \"\"\"\n return _setwinsize(self.fd, rows, cols)\n\n\nclass PtyProcessUnicode(PtyProcess):\n \"\"\"Unicode wrapper around a process running in a pseudoterminal.\n\n This class exposes a similar interface to :class:`PtyProcess`, but its read\n methods return unicode, and its :meth:`write` accepts unicode.\n \"\"\"\n if PY3:\n string_type = str\n else:\n string_type = unicode # analysis:ignore\n\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\n super(PtyProcessUnicode, self).__init__(pid, fd)\n self.encoding = encoding\n self.codec_errors = codec_errors\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\n\n def read(self, size=1024):\n \"\"\"Read at most ``size`` bytes from the pty, return them as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n\n The size argument still refers to bytes, not unicode code points.\n \"\"\"\n b = super(PtyProcessUnicode, self).read(size)\n return self.decoder.decode(b, final=False)\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n b = super(PtyProcessUnicode, self).readline()\n return self.decoder.decode(b, final=False)\n\n def write(self, s):\n \"\"\"Write the unicode string ``s`` to the pseudoterminal.\n\n Returns the number of bytes written.\n \"\"\"\n b = s.encode(self.encoding)\n return super(PtyProcessUnicode, self).write(b)\n\n[end of ptyprocess/ptyprocess.py]","filename":"ptyprocess/ptyprocess.py","id":"10"},{"content":"\"\"\"Run a subprocess in a pseudo terminal\"\"\"\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\n\n__version__ = '0.7.0'\n\n[end of ptyprocess/__init__.py]","filename":"ptyprocess/__init__.py","id":"11"},{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\n\n<svg\n xmlns:dc=\"http://purl.org/dc/elements/1.1/\"\n xmlns:cc=\"http://creativecommons.org/ns#\"\n xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n xmlns:svg=\"http://www.w3.org/2000/svg\"\n xmlns=\"http://www.w3.org/2000/svg\"\n xmlns:sodipodi=\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\"\n xmlns:inkscape=\"http://www.inkscape.org/namespaces/inkscape\"\n width=\"554.44196\"\n height=\"327.38452\"\n id=\"svg2\"\n version=\"1.1\"\n inkscape:version=\"0.48.4 r9939\"\n sodipodi:docname=\"pty_vs_popen.svg\">\n <defs\n id=\"defs4\">\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM\"\n style=\"overflow:visible\">\n <path\n id=\"path3838\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3783\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(1.1,0,0,1.1,1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Tail\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Tail\"\n style=\"overflow:visible\">\n <g\n id=\"g3801\"\n transform=\"scale(-1.2,-1.2)\">\n <path\n id=\"path3803\"\n d=\"M -3.8048674,-3.9585227 0.54352094,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3805\"\n d=\"M -1.2866832,-3.9585227 3.0617053,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3807\"\n d=\"M 1.3053582,-3.9585227 5.6537466,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3809\"\n d=\"M -3.8048674,4.1775838 0.54352094,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3811\"\n d=\"M -1.2866832,4.1775838 3.0617053,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3813\"\n d=\"M 1.3053582,4.1775838 5.6537466,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n </g>\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3765\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(0.8,0,0,0.8,10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3786\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3768\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(-0.8,0,0,-0.8,-10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-9\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-2\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-6\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-27\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM-5\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3838-7\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10742\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10744\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10746\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10748\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10750\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10752\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10754\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10756\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10758\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10760\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n </defs>\n <sodipodi:namedview\n id=\"base\"\n pagecolor=\"#ffffff\"\n bordercolor=\"#666666\"\n borderopacity=\"1.0\"\n inkscape:pageopacity=\"0.0\"\n inkscape:pageshadow=\"2\"\n inkscape:zoom=\"0.98994949\"\n inkscape:cx=\"77.797977\"\n inkscape:cy=\"137.24456\"\n inkscape:document-units=\"px\"\n inkscape:current-layer=\"layer1\"\n showgrid=\"false\"\n inkscape:window-width=\"1301\"\n inkscape:window-height=\"744\"\n inkscape:window-x=\"65\"\n inkscape:window-y=\"24\"\n inkscape:window-maximized=\"1\"\n fit-margin-top=\"1\"\n fit-margin-left=\"1\"\n fit-margin-right=\"1\"\n fit-margin-bottom=\"1\"\n units=\"cm\" />\n <metadata\n id=\"metadata7\">\n <rdf:RDF>\n <cc:Work\n rdf:about=\"\">\n <dc:format>image/svg+xml</dc:format>\n <dc:type\n rdf:resource=\"http://purl.org/dc/dcmitype/StillImage\" />\n <dc:title></dc:title>\n </cc:Work>\n </rdf:RDF>\n </metadata>\n <g\n inkscape:label=\"Layer 1\"\n inkscape:groupmode=\"layer\"\n id=\"layer1\"\n transform=\"translate(-40.758533,29.820888)\">\n <g\n id=\"g11880\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591\"\n y=\"240.97427\"\n x=\"138.65004\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.97427\"\n x=\"138.65004\"\n id=\"tspan10593\"\n sodipodi:role=\"line\">Child</tspan></text>\n <g\n id=\"g10626\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991\"\n d=\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7\"\n d=\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\"\n id=\"path2991-7-8\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5637\"\n d=\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5641\"\n d=\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5643\"\n d=\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245\"\n y=\"240.57648\"\n x=\"90\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.57648\"\n x=\"90\"\n id=\"tspan6247\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8\"\n y=\"213.07455\"\n x=\"184.47076\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"213.07455\"\n x=\"184.47076\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8\"\n y=\"262.00311\"\n x=\"192.32663\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"262.00311\"\n x=\"192.32663\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(18,0)\"\n id=\"g11773\">\n <g\n id=\"g11763\">\n <rect\n y=\"120.8597\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308\"\n y=\"129.96561\"\n x=\"63.277264\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"129.96561\"\n x=\"63.277264\"\n id=\"tspan6310\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g11768\">\n <rect\n y=\"135.43114\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304\"\n y=\"144.58977\"\n x=\"64.540932\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"144.58977\"\n x=\"64.540932\"\n id=\"tspan6306\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(54,-16)\"\n id=\"g10674\">\n <g\n id=\"g10664\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(86.857134,-15.571435)\"\n id=\"g10674-6\">\n <g\n id=\"g10664-6\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0-5\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-9\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7-6\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669-5\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5-3\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6-1\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726\"\n y=\"139.6479\"\n x=\"135.03683\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"139.6479\"\n x=\"135.03683\"\n id=\"tspan10728\"\n sodipodi:role=\"line\">Popen</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-89\"\n y=\"158.43169\"\n x=\"234.46947\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-24\"\n style=\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\"\n y=\"158.43169\"\n x=\"234.46947\"\n sodipodi:role=\"line\">pipes</tspan></text>\n </g>\n <g\n id=\"g11847\"\n transform=\"translate(-10,0.39179)\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328-0\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-8\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591-3\"\n y=\"240.5825\"\n x=\"372.50137\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.5825\"\n x=\"372.50137\"\n id=\"tspan10593-2\"\n sodipodi:role=\"line\">Child</tspan></text>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path11075\"\n d=\"m 397.80427,110.64896 0,-52.85714\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\" />\n <g\n id=\"g10626-5\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2-4\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334-0\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336-9\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-4\"\n d=\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7-87\"\n d=\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331-7\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\"\n id=\"path2991-7-8-4\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-6\"\n y=\"240.18468\"\n x=\"323.85132\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.18468\"\n x=\"323.85132\"\n id=\"tspan6247-3\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-6\"\n y=\"207.68279\"\n x=\"410.10779\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-2\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"207.68279\"\n x=\"410.10779\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8-1\"\n y=\"261.61133\"\n x=\"426.17795\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298-3\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"261.61133\"\n x=\"426.17795\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(227.5656,-301.02546)\"\n id=\"g11065\">\n <g\n id=\"g11055\">\n <rect\n y=\"421.34998\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55\"\n style=\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6\"\n y=\"431.01376\"\n x=\"159.1624\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"431.01376\"\n x=\"159.1624\"\n id=\"tspan6310-7-9\"\n sodipodi:role=\"line\">slave</tspan></text>\n </g>\n <g\n id=\"g11060\">\n <rect\n y=\"407.25223\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55-9\"\n style=\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6-7\"\n y=\"416.68555\"\n x=\"155.16631\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"416.68555\"\n x=\"155.16631\"\n id=\"tspan6310-7-9-7\"\n sodipodi:role=\"line\">master</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726-9\"\n y=\"116.71899\"\n x=\"429.1268\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"116.71899\"\n x=\"429.1268\"\n id=\"tspan10728-7\"\n sodipodi:role=\"line\">Pseudoterminal</tspan><tspan\n id=\"tspan11761\"\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"136.71899\"\n x=\"429.1268\"\n sodipodi:role=\"line\">(pty)</tspan></text>\n </g>\n </g>\n</svg>\n\n[end of docs/images/pty_vs_popen.svg]","filename":"docs/images/pty_vs_popen.svg","id":"12"},{"content":"None\n[end of docs/images/pty_vs_popen.png]","filename":"docs/images/pty_vs_popen.png","id":"13"}],"string":"[\n {\n \"content\": \"python:\\n version: 3\\n\\n[end of readthedocs.yml]\",\n \"filename\": \"readthedocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"ISC LICENSE\\n\\n This license is approved by the OSI and FSF as GPL-compatible.\\n http://opensource.org/licenses/isc-license.txt\\n\\n Copyright (c) 2013-2014, Pexpect development team\\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\\n\\n Permission to use, copy, modify, and/or distribute this software for any\\n purpose with or without fee is hereby granted, provided that the above\\n copyright notice and this permission notice appear in all copies.\\n \\n THE SOFTWARE IS PROVIDED \\\"AS IS\\\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"flit_core >=2,<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.metadata]\\nmodule = \\\"ptyprocess\\\"\\nauthor = \\\"Thomas Kluyver\\\"\\nauthor-email = \\\"thomas@kluyver.me.uk\\\"\\nhome-page = \\\"https://github.com/pexpect/ptyprocess\\\"\\ndescription-file = \\\"README.rst\\\"\\nrequires-python = \\\">=3.7\\\"\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: ISC License (ISCL)\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Topic :: Terminals\\\"\\n]\\n\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"Launch a subprocess in a pseudo terminal (pty), and interact with both the\\nprocess and its pty.\\n\\nSometimes, piping stdin and stdout is not enough. There might be a password\\nprompt that doesn't read from stdin, output that changes when it's going to a\\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\\nIf you need to automate these things, running the process in a pseudo terminal\\n(pty) is the answer.\\n\\nInterface:\\n\\n.. code:: python\\n\\n from ptyprocess import PtyProcessUnicode\\n p = PtyProcessUnicode.spawn(['python'])\\n p.read(20)\\n p.write('6+6\\\\n')\\n p.read(20)\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"3\"\n },\n {\n \"content\": \"Ptyprocess\\n==========\\n\\n.. include:: ../README.rst\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n\\n api\\n\\nWhat is a pty?\\n--------------\\n\\nA pty is a kernel-level object which processes can write data to and read data\\nfrom, a bit like a pipe.\\n\\nUnlike a pipe, data moves through a single pty in both directions. When you use\\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\\nto three pipes are created for the process's standard streams (stdin, stdout\\nand stderr). When you run a program using ptyprocess, all three of its standard\\nstreams are connected to a single pty:\\n\\n.. image:: images/pty_vs_popen.png\\n\\nA pty also does more than a pipe. It keeps track of the window size (rows and\\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\\nSIGINT to be sent to the child process.\\n\\nMany command line programs behave differently if they detect that stdin or stdout\\nis connected to a terminal instead of a pipe (using \\n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\\nthat they're being used interactively by a human user.\\nThey may format output differently (e.g. ``ls`` lists files in columns)\\nor prompt the user to confirm actions.\\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\\n\\n.. seealso::\\n\\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\\n Detailed article by Linus Akesson\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"4\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = _build\\n\\n# User-friendly check for sphinx-build\\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\\nendif\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n# the i18n builder cannot share the environment and doctrees with the others\\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n\\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" singlehtml to make a single large HTML file\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" devhelp to make HTML files and a Devhelp project\\\"\\n\\t@echo \\\" epub to make an epub\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" latexpdf to make LaTeX files and run them through pdflatex\\\"\\n\\t@echo \\\" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\\\"\\n\\t@echo \\\" text to make text files\\\"\\n\\t@echo \\\" man to make manual pages\\\"\\n\\t@echo \\\" texinfo to make Texinfo files\\\"\\n\\t@echo \\\" info to make Texinfo files and run them through makeinfo\\\"\\n\\t@echo \\\" gettext to make PO message catalogs\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" xml to make Docutils-native XML files\\\"\\n\\t@echo \\\" pseudoxml to make pseudoxml-XML files for display purposes\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\trm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\nsinglehtml:\\n\\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\\\"\\n\\ndevhelp:\\n\\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\\n\\t@echo\\n\\t@echo \\\"Build finished.\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# devhelp\\\"\\n\\nepub:\\n\\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\\n\\t@echo\\n\\t@echo \\\"Build finished. The epub file is in $(BUILDDIR)/epub.\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through (pdf)latex\\\" \\\\\\n\\t \\\"(use \\\\`make latexpdf' here to do that automatically).\\\"\\n\\nlatexpdf:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through pdflatex...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\nlatexpdfja:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through platex and dvipdfmx...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\ntext:\\n\\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\\n\\t@echo\\n\\t@echo \\\"Build finished. The text files are in $(BUILDDIR)/text.\\\"\\n\\nman:\\n\\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\\n\\t@echo\\n\\t@echo \\\"Build finished. The manual pages are in $(BUILDDIR)/man.\\\"\\n\\ntexinfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo\\n\\t@echo \\\"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through makeinfo\\\" \\\\\\n\\t \\\"(use \\\\`make info' here to do that automatically).\\\"\\n\\ninfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo \\\"Running Texinfo files through makeinfo...\\\"\\n\\tmake -C $(BUILDDIR)/texinfo info\\n\\t@echo \\\"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\\\"\\n\\ngettext:\\n\\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\\n\\t@echo\\n\\t@echo \\\"Build finished. The message catalogs are in $(BUILDDIR)/locale.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\nxml:\\n\\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\\n\\t@echo\\n\\t@echo \\\"Build finished. The XML files are in $(BUILDDIR)/xml.\\\"\\n\\npseudoxml:\\n\\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\\n\\t@echo\\n\\t@echo \\\"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\\\"\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n#\\n# Ptyprocess documentation build configuration file, created by\\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\\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\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.insert(0, os.path.abspath('..'))\\n\\n# -- General configuration ------------------------------------------------\\n\\n# If your documentation needs a minimal Sphinx version, state it here.\\n#needs_sphinx = '1.0'\\n\\n# Add any Sphinx extension module names here, as strings. They can be\\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\\n# ones.\\nextensions = [\\n 'sphinx.ext.autodoc',\\n 'sphinx.ext.intersphinx',\\n 'sphinx.ext.viewcode',\\n]\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['_templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8-sig'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = u'Ptyprocess'\\ncopyright = u'2014, Thomas Kluyver'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.7'\\n# The full version, including alpha/beta/rc tags.\\nrelease = version #+ '.2'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of patterns, relative to source directory, that match files and\\n# directories to ignore when looking for source files.\\nexclude_patterns = ['_build']\\n\\n# The reST default role (used for this markup: `text`) to use for all\\n# documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n# If true, keep warnings as \\\"system message\\\" paragraphs in the built documents.\\n#keep_warnings = False\\n\\n\\n# -- Options for HTML output ----------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. See the documentation for\\n# a list of builtin themes.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['_static']\\n\\n# Add any extra paths that contain custom files (such as robots.txt or\\n# .htaccess) here, relative to this directory. These files are copied\\n# directly to the root of the documentation.\\n#html_extra_path = []\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_domain_indices = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, \\\"Created using Sphinx\\\" is shown in the HTML footer. Default is True.\\n#html_show_sphinx = True\\n\\n# If true, \\\"(C) Copyright ...\\\" is shown in the HTML footer. Default is True.\\n#html_show_copyright = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# This is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = None\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'Ptyprocessdoc'\\n\\n\\n# -- Options for LaTeX output ---------------------------------------------\\n\\nlatex_elements = {\\n# The paper size ('letterpaper' or 'a4paper').\\n#'papersize': 'letterpaper',\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#'pointsize': '10pt',\\n\\n# Additional stuff for the LaTeX preamble.\\n#'preamble': '',\\n}\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title,\\n# author, documentclass [howto, manual, or own class]).\\nlatex_documents = [\\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# If true, show page references after internal links.\\n#latex_show_pagerefs = False\\n\\n# If true, show URL addresses after external links.\\n#latex_show_urls = False\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_domain_indices = True\\n\\n\\n# -- Options for manual page output ---------------------------------------\\n\\n# One entry per manual page. List of tuples\\n# (source start file, name, description, authors, manual section).\\nman_pages = [\\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\\n [u'Thomas Kluyver'], 1)\\n]\\n\\n# If true, show URL addresses after external links.\\n#man_show_urls = False\\n\\n\\n# -- Options for Texinfo output -------------------------------------------\\n\\n# Grouping the document tree into Texinfo files. List of tuples\\n# (source start file, target name, title, author,\\n# dir menu entry, description, category)\\ntexinfo_documents = [\\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\\n 'Miscellaneous'),\\n]\\n\\n# Documents to append as an appendix to all manuals.\\n#texinfo_appendices = []\\n\\n# If false, no module index is generated.\\n#texinfo_domain_indices = True\\n\\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\\n#texinfo_show_urls = 'footnote'\\n\\n# If true, do not generate a @detailmenu in the \\\"Top\\\" node's menu.\\n#texinfo_no_detailmenu = False\\n\\n\\n# Example configuration for intersphinx: refer to the Python standard library.\\nintersphinx_mapping = {'http://docs.python.org/': None}\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Ptyprocess API\\n==============\\n\\n.. module:: ptyprocess\\n\\n.. autoclass:: PtyProcess\\n\\n .. automethod:: spawn\\n\\n .. automethod:: read\\n\\n .. automethod:: readline\\n\\n .. automethod:: write\\n\\n .. automethod:: sendcontrol\\n\\n .. automethod:: sendeof\\n\\n .. automethod:: sendintr\\n\\n .. automethod:: getecho\\n\\n .. automethod:: waitnoecho\\n\\n .. automethod:: setecho\\n\\n .. automethod:: getwinsize\\n\\n .. automethod:: setwinsize\\n\\n .. automethod:: eof\\n\\n .. automethod:: isalive\\n\\n .. automethod:: wait\\n\\n .. automethod:: kill\\n\\n .. automethod:: terminate\\n\\n .. automethod:: close\\n\\n.. autoclass:: PtyProcessUnicode\\n\\n[end of docs/api.rst]\",\n \"filename\": \"docs/api.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"try:\\n from shutil import which # Python >= 3.3\\nexcept ImportError:\\n import os, sys\\n \\n # This is copied from Python 3.4.1\\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\\n \\\"\\\"\\\"Given a command, mode, and a PATH string, return the path which\\n conforms to the given mode on the PATH, or None if there is no such\\n file.\\n \\n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\\n of os.environ.get(\\\"PATH\\\"), or can be overridden with a custom search\\n path.\\n \\n \\\"\\\"\\\"\\n # Check that a given file can be accessed with the correct mode.\\n # Additionally check that `file` is not a directory, as on Windows\\n # directories pass the os.access check.\\n def _access_check(fn, mode):\\n return (os.path.exists(fn) and os.access(fn, mode)\\n and not os.path.isdir(fn))\\n \\n # If we're given a path with a directory part, look it up directly rather\\n # than referring to PATH directories. This includes checking relative to the\\n # current directory, e.g. ./script\\n if os.path.dirname(cmd):\\n if _access_check(cmd, mode):\\n return cmd\\n return None\\n \\n if path is None:\\n path = os.environ.get(\\\"PATH\\\", os.defpath)\\n if not path:\\n return None\\n path = path.split(os.pathsep)\\n \\n if sys.platform == \\\"win32\\\":\\n # The current directory takes precedence on Windows.\\n if not os.curdir in path:\\n path.insert(0, os.curdir)\\n \\n # PATHEXT is necessary to check on Windows.\\n pathext = os.environ.get(\\\"PATHEXT\\\", \\\"\\\").split(os.pathsep)\\n # See if the given file matches any of the expected path extensions.\\n # This will allow us to short circuit when given \\\"python.exe\\\".\\n # If it does match, only test that one, otherwise we have to try\\n # others.\\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\\n files = [cmd]\\n else:\\n files = [cmd + ext for ext in pathext]\\n else:\\n # On other platforms you don't have things like PATHEXT to tell you\\n # what file suffixes are executable, so just pass on cmd as-is.\\n files = [cmd]\\n \\n seen = set()\\n for dir in path:\\n normdir = os.path.normcase(dir)\\n if not normdir in seen:\\n seen.add(normdir)\\n for thefile in files:\\n name = os.path.join(dir, thefile)\\n if _access_check(name, mode):\\n return name\\n return None\\n\\n\\nclass PtyProcessError(Exception):\\n \\\"\\\"\\\"Generic error class for this package.\\\"\\\"\\\"\\n\\n[end of ptyprocess/util.py]\",\n \"filename\": \"ptyprocess/util.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Substitute for the forkpty system call, to support Solaris.\\n\\\"\\\"\\\"\\nimport os\\nimport errno\\n\\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\\nfrom .util import PtyProcessError\\n\\ndef fork_pty():\\n '''This implements a substitute for the forkpty system call. This\\n should be more portable than the pty.fork() function. Specifically,\\n this should work on Solaris.\\n\\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\\n resolve the issue with Python's pty.fork() not supporting Solaris,\\n particularly ssh. Based on patch to posixmodule.c authored by Noah\\n Spurrier::\\n\\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\\n\\n '''\\n\\n parent_fd, child_fd = os.openpty()\\n if parent_fd < 0 or child_fd < 0:\\n raise OSError(\\\"os.openpty() failed\\\")\\n\\n pid = os.fork()\\n if pid == CHILD:\\n # Child.\\n os.close(parent_fd)\\n pty_make_controlling_tty(child_fd)\\n\\n os.dup2(child_fd, STDIN_FILENO)\\n os.dup2(child_fd, STDOUT_FILENO)\\n os.dup2(child_fd, STDERR_FILENO)\\n\\n else:\\n # Parent.\\n os.close(child_fd)\\n\\n return pid, parent_fd\\n\\ndef pty_make_controlling_tty(tty_fd):\\n '''This makes the pseudo-terminal the controlling tty. This should be\\n more portable than the pty.fork() function. Specifically, this should\\n work on Solaris. '''\\n\\n child_name = os.ttyname(tty_fd)\\n\\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\\n # if there was no controlling tty to begin with, such as when\\n # executed by a cron(1) job.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n os.setsid()\\n\\n # Verify we are disconnected from controlling tty by attempting to open\\n # it again. We expect that OSError of ENXIO should always be raised.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n raise PtyProcessError(\\\"OSError of errno.ENXIO should be raised.\\\")\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n # Verify we can open child pty.\\n fd = os.open(child_name, os.O_RDWR)\\n os.close(fd)\\n\\n # Verify we now have a controlling tty.\\n fd = os.open(\\\"/dev/tty\\\", os.O_WRONLY)\\n os.close(fd)\\n\\n[end of ptyprocess/_fork_pty.py]\",\n \"filename\": \"ptyprocess/_fork_pty.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"import codecs\\nimport errno\\nimport fcntl\\nimport io\\nimport os\\nimport pty\\nimport resource\\nimport signal\\nimport struct\\nimport sys\\nimport termios\\nimport time\\n\\ntry:\\n import builtins # Python 3\\nexcept ImportError:\\n import __builtin__ as builtins # Python 2\\n\\n# Constants\\nfrom pty import (STDIN_FILENO, CHILD)\\n\\nfrom .util import which, PtyProcessError\\n\\n_platform = sys.platform.lower()\\n\\n# Solaris uses internal __fork_pty(). All others use pty.fork().\\n_is_solaris = (\\n _platform.startswith('solaris') or\\n _platform.startswith('sunos'))\\n\\nif _is_solaris:\\n use_native_pty_fork = False\\n from . import _fork_pty\\nelse:\\n use_native_pty_fork = True\\n\\nPY3 = sys.version_info[0] >= 3\\n\\nif PY3:\\n def _byte(i):\\n return bytes([i])\\nelse:\\n def _byte(i):\\n return chr(i)\\n \\n class FileNotFoundError(OSError): pass\\n class TimeoutError(OSError): pass\\n\\n_EOF, _INTR = None, None\\n\\ndef _make_eof_intr():\\n \\\"\\\"\\\"Set constants _EOF and _INTR.\\n \\n This avoids doing potentially costly operations on module load.\\n \\\"\\\"\\\"\\n global _EOF, _INTR\\n if (_EOF is not None) and (_INTR is not None):\\n return\\n\\n # inherit EOF and INTR definitions from controlling process.\\n try:\\n from termios import VEOF, VINTR\\n fd = None\\n for name in 'stdin', 'stdout':\\n stream = getattr(sys, '__%s__' % name, None)\\n if stream is None or not hasattr(stream, 'fileno'):\\n continue\\n try:\\n fd = stream.fileno()\\n except ValueError:\\n continue\\n if fd is None:\\n # no fd, raise ValueError to fallback on CEOF, CINTR\\n raise ValueError(\\\"No stream has a fileno\\\")\\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\\n except (ImportError, OSError, IOError, ValueError, termios.error):\\n # unless the controlling process is also not a terminal,\\n # such as cron(1), or when stdin and stdout are both closed.\\n # Fall-back to using CEOF and CINTR. There\\n try:\\n from termios import CEOF, CINTR\\n (intr, eof) = (CINTR, CEOF)\\n except ImportError:\\n # ^C, ^D\\n (intr, eof) = (3, 4)\\n \\n _INTR = _byte(intr)\\n _EOF = _byte(eof)\\n\\n# setecho and setwinsize are pulled out here because on some platforms, we need\\n# to do this from the child before we exec()\\n \\ndef _setecho(fd, state):\\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\\n\\n try:\\n attr = termios.tcgetattr(fd)\\n except termios.error as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n if state:\\n attr[3] = attr[3] | termios.ECHO\\n else:\\n attr[3] = attr[3] & ~termios.ECHO\\n\\n try:\\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\\n # blocked on some platforms. TCSADRAIN would probably be ideal.\\n termios.tcsetattr(fd, termios.TCSANOW, attr)\\n except IOError as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\ndef _setwinsize(fd, rows, cols):\\n # Some very old platforms have a bug that causes the value for\\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\\n # around this, but it caused problems with newer platforms so has been\\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\\n # Note, assume ws_xpixel and ws_ypixel are zero.\\n s = struct.pack('HHHH', rows, cols, 0, 0)\\n fcntl.ioctl(fd, TIOCSWINSZ, s)\\n\\nclass PtyProcess(object):\\n '''This class represents a process running in a pseudoterminal.\\n \\n The main constructor is the :meth:`spawn` classmethod.\\n '''\\n string_type = bytes\\n if PY3:\\n linesep = os.linesep.encode('ascii')\\n crlf = '\\\\r\\\\n'.encode('ascii')\\n\\n @staticmethod\\n def write_to_stdout(b):\\n try:\\n return sys.stdout.buffer.write(b)\\n except AttributeError:\\n # If stdout has been replaced, it may not have .buffer\\n return sys.stdout.write(b.decode('ascii', 'replace'))\\n else:\\n linesep = os.linesep\\n crlf = '\\\\r\\\\n'\\n write_to_stdout = sys.stdout.write\\n\\n encoding = None\\n \\n argv = None\\n env = None\\n launch_dir = None\\n\\n def __init__(self, pid, fd):\\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\\n self.pid = pid\\n self.fd = fd\\n readf = io.open(fd, 'rb', buffering=0)\\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\\n self.fileobj = io.BufferedRWPair(readf, writef)\\n\\n self.terminated = False\\n self.closed = False\\n self.exitstatus = None\\n self.signalstatus = None\\n # status returned by os.waitpid\\n self.status = None\\n self.flag_eof = False\\n # Used by close() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterclose = 0.1\\n # Used by terminate() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterterminate = 0.1\\n\\n @classmethod\\n def spawn(\\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\\n dimensions=(24, 80), pass_fds=()):\\n '''Start the given command in a child process in a pseudo terminal.\\n\\n This does all the fork/exec type of stuff for a pty, and returns an\\n instance of PtyProcess.\\n\\n If preexec_fn is supplied, it will be called with no arguments in the\\n child process before exec-ing the specified command.\\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\\n\\n Dimensions of the psuedoterminal used for the subprocess can be\\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\\n\\n By default, all file descriptors except 0, 1 and 2 are closed. This\\n behavior can be overridden with pass_fds, a list of file descriptors to\\n keep open between the parent and the child.\\n '''\\n # Note that it is difficult for this method to fail.\\n # You cannot detect if the child process cannot start.\\n # So the only way you can tell if the child process started\\n # or not is to try to read from the file descriptor. If you get\\n # EOF immediately then it means that the child is already dead.\\n # That may not necessarily be bad because you may have spawned a child\\n # that performs some task; creates no stdout output; and then dies.\\n\\n if not isinstance(argv, (list, tuple)):\\n raise TypeError(\\\"Expected a list or tuple for argv, got %r\\\" % argv)\\n\\n # Shallow copy of argv so we can modify it\\n argv = argv[:]\\n command = argv[0]\\n\\n command_with_path = which(command)\\n if command_with_path is None:\\n raise FileNotFoundError('The command was not found or was not ' +\\n 'executable: %s.' % command)\\n command = command_with_path\\n argv[0] = command\\n\\n # [issue #119] To prevent the case where exec fails and the user is\\n # stuck interacting with a python child process instead of whatever\\n # was expected, we implement the solution from\\n # http://stackoverflow.com/a/3703179 to pass the exception to the\\n # parent process\\n\\n # [issue #119] 1. Before forking, open a pipe in the parent process.\\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\\n\\n if use_native_pty_fork:\\n pid, fd = pty.fork()\\n else:\\n # Use internal fork_pty, for Solaris\\n pid, fd = _fork_pty.fork_pty()\\n\\n # Some platforms must call setwinsize() and setecho() from the\\n # child process, and others from the master process. We do both,\\n # allowing IOError for either.\\n\\n if pid == CHILD:\\n # set window size\\n try:\\n _setwinsize(STDIN_FILENO, *dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # disable echo if spawn argument echo was unset\\n if not echo:\\n try:\\n _setecho(STDIN_FILENO, False)\\n except (IOError, termios.error) as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # [issue #119] 3. The child closes the reading end and sets the\\n # close-on-exec flag for the writing end.\\n os.close(exec_err_pipe_read)\\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\\n\\n # Do not allow child to inherit open file descriptors from parent,\\n # with the exception of the exec_err_pipe_write of the pipe\\n # and pass_fds.\\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\\n # occasionally raises out of range error\\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\\n os.closerange(pair[0]+1, pair[1])\\n\\n if cwd is not None:\\n os.chdir(cwd)\\n\\n if preexec_fn is not None:\\n try:\\n preexec_fn()\\n except Exception as e:\\n ename = type(e).__name__\\n tosend = '{}:0:{}'.format(ename, str(e))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(1)\\n\\n try:\\n if env is None:\\n os.execv(command, argv)\\n else:\\n os.execvpe(command, argv, env)\\n except OSError as err:\\n # [issue #119] 5. If exec fails, the child writes the error\\n # code back to the parent using the pipe, then exits.\\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(os.EX_OSERR)\\n\\n # Parent\\n inst = cls(pid, fd)\\n \\n # Set some informational attributes\\n inst.argv = argv\\n if env is not None:\\n inst.env = env\\n if cwd is not None:\\n inst.launch_dir = cwd\\n\\n # [issue #119] 2. After forking, the parent closes the writing end\\n # of the pipe and reads from the reading end.\\n os.close(exec_err_pipe_write)\\n exec_err_data = os.read(exec_err_pipe_read, 4096)\\n os.close(exec_err_pipe_read)\\n\\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\\n # child successfully performed exec, since close-on-exec made\\n # successful exec close the writing end of the pipe. Or, if exec\\n # failed, the parent reads the error code and can proceed\\n # accordingly. Either way, the parent blocks until the child calls\\n # exec.\\n if len(exec_err_data) != 0:\\n try:\\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\\n\\n exception = exctype(errmsg.decode('utf-8', 'replace'))\\n if exctype is OSError:\\n exception.errno = int(errno_s)\\n except:\\n raise Exception('Subprocess failed, got bad error data: %r'\\n % exec_err_data)\\n else:\\n raise exception\\n\\n try:\\n inst.setwinsize(*dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\\n raise\\n\\n return inst\\n\\n def __repr__(self):\\n clsname = type(self).__name__\\n if self.argv is not None:\\n args = [repr(self.argv)]\\n if self.env is not None:\\n args.append(\\\"env=%r\\\" % self.env)\\n if self.launch_dir is not None:\\n args.append(\\\"cwd=%r\\\" % self.launch_dir)\\n \\n return \\\"{}.spawn({})\\\".format(clsname, \\\", \\\".join(args))\\n \\n else:\\n return \\\"{}(pid={}, fd={})\\\".format(clsname, self.pid, self.fd)\\n\\n @staticmethod\\n def _coerce_send_string(s):\\n if not isinstance(s, bytes):\\n return s.encode('utf-8')\\n return s\\n\\n @staticmethod\\n def _coerce_read_string(s):\\n return s\\n\\n def __del__(self):\\n '''This makes sure that no system resources are left open. Python only\\n garbage collects Python objects. OS file descriptors are not Python\\n objects, so they must be handled explicitly. If the child file\\n descriptor was opened outside of this class (passed to the constructor)\\n then this does not close it. '''\\n\\n if not self.closed:\\n # It is possible for __del__ methods to execute during the\\n # teardown of the Python VM itself. Thus self.close() may\\n # trigger an exception because os.close may be None.\\n try:\\n self.close()\\n # which exception, shouldn't we catch explicitly .. ?\\n except:\\n pass\\n\\n\\n def fileno(self):\\n '''This returns the file descriptor of the pty for the child.\\n '''\\n return self.fd\\n\\n def close(self, force=True):\\n '''This closes the connection with the child application. Note that\\n calling close() more than once is valid. This emulates standard Python\\n behavior with files. Set force to True if you want to make sure that\\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\\n and SIGINT). '''\\n if not self.closed:\\n self.flush()\\n self.fileobj.close() # Closes the file descriptor\\n # Give kernel time to update process status.\\n time.sleep(self.delayafterclose)\\n if self.isalive():\\n if not self.terminate(force):\\n raise PtyProcessError('Could not terminate the child.')\\n self.fd = -1\\n self.closed = True\\n #self.pid = None\\n\\n def flush(self):\\n '''This does nothing. It is here to support the interface for a\\n File-like object. '''\\n\\n pass\\n\\n def isatty(self):\\n '''This returns True if the file descriptor is open and connected to a\\n tty(-like) device, else False.\\n\\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\\n the child pty may not appear as a terminal device. This means\\n methods such as setecho(), setwinsize(), getwinsize() may raise an\\n IOError. '''\\n\\n return os.isatty(self.fd)\\n\\n def waitnoecho(self, timeout=None):\\n '''Wait until the terminal ECHO flag is set False.\\n\\n This returns True if the echo mode is off, or False if echo was not\\n disabled before the timeout. This can be used to detect when the\\n child is waiting for a password. Usually a child application will turn\\n off echo mode when it is waiting for the user to enter a password. For\\n example, instead of expecting the \\\"password:\\\" prompt you can wait for\\n the child to turn echo off::\\n\\n p = pexpect.spawn('ssh user@example.com')\\n p.waitnoecho()\\n p.sendline(mypassword)\\n\\n If ``timeout=None`` then this method to block until ECHO flag is False.\\n '''\\n\\n if timeout is not None:\\n end_time = time.time() + timeout\\n while True:\\n if not self.getecho():\\n return True\\n if timeout < 0 and timeout is not None:\\n return False\\n if timeout is not None:\\n timeout = end_time - time.time()\\n time.sleep(0.1)\\n\\n def getecho(self):\\n '''Returns True if terminal echo is on, or False if echo is off.\\n\\n Child applications that are expecting you to enter a password often\\n disable echo. See also :meth:`waitnoecho`.\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n\\n try:\\n attr = termios.tcgetattr(self.fd)\\n except termios.error as err:\\n errmsg = 'getecho() may not be called on this platform'\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n self.echo = bool(attr[3] & termios.ECHO)\\n return self.echo\\n\\n def setecho(self, state):\\n '''Enable or disable terminal echo.\\n\\n Anything the child sent before the echo will be lost, so you should be\\n sure that your input buffer is empty before you call setecho().\\n For example, the following will work as expected::\\n\\n p = pexpect.spawn('cat') # Echo is on by default.\\n p.sendline('1234') # We expect see this twice from the child...\\n p.expect(['1234']) # ... once from the tty echo...\\n p.expect(['1234']) # ... and again from cat itself.\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n The following WILL NOT WORK because the lines sent before the setecho\\n will be lost::\\n\\n p = pexpect.spawn('cat')\\n p.sendline('1234')\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['1234'])\\n p.expect(['1234'])\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n _setecho(self.fd, state)\\n\\n self.echo = state\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read and return at most ``size`` bytes from the pty.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\\n with the vagaries of EOF on platforms that do strange things, like IRIX\\n or older Solaris systems. It handles the errno=EIO pattern used on\\n Linux, and the empty-string return used on BSD platforms and (seemingly)\\n on recent Solaris.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.read1(size)\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.readline()\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def _writeb(self, b, flush=True):\\n n = self.fileobj.write(b)\\n if flush:\\n self.fileobj.flush()\\n return n\\n\\n def write(self, s, flush=True):\\n \\\"\\\"\\\"Write bytes to the pseudoterminal.\\n \\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n return self._writeb(s, flush=flush)\\n\\n def sendcontrol(self, char):\\n '''Helper method for sending control characters to the terminal.\\n\\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\\\\\a'``)::\\n\\n child.sendcontrol('g')\\n\\n See also, :meth:`sendintr` and :meth:`sendeof`.\\n '''\\n char = char.lower()\\n a = ord(char)\\n if 97 <= a <= 122:\\n a = a - ord('a') + 1\\n byte = _byte(a)\\n return self._writeb(byte), byte\\n d = {'@': 0, '`': 0,\\n '[': 27, '{': 27,\\n '\\\\\\\\': 28, '|': 28,\\n ']': 29, '}': 29,\\n '^': 30, '~': 30,\\n '_': 31,\\n '?': 127}\\n if char not in d:\\n return 0, b''\\n\\n byte = _byte(d[char])\\n return self._writeb(byte), byte\\n\\n def sendeof(self):\\n '''Sends an EOF (typically Ctrl-D) through the terminal.\\n\\n This sends a character which causes\\n the pending parent output buffer to be sent to the waiting child\\n program without waiting for end-of-line. If it is the first character\\n of the line, the read() in the user program returns 0, which signifies\\n end-of-file. This means to work as expected a sendeof() has to be\\n called at the beginning of a line. This method does not send a newline.\\n It is the responsibility of the caller to ensure the eof is sent at the\\n beginning of a line.\\n '''\\n return self._writeb(_EOF), _EOF\\n\\n def sendintr(self):\\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\\n\\n This will normally trigger the kernel to send SIGINT to the current\\n foreground process group. Processes can turn off this translation, in\\n which case they can read the raw data sent, e.g. ``b'\\\\\\\\x03'`` for Ctrl-C.\\n\\n See also the :meth:`kill` method, which sends a signal directly to the\\n immediate child process in the terminal (which is not necessarily the\\n foreground process).\\n '''\\n return self._writeb(_INTR), _INTR\\n\\n def eof(self):\\n '''This returns True if the EOF exception was ever raised.\\n '''\\n\\n return self.flag_eof\\n\\n def terminate(self, force=False):\\n '''This forces a child process to terminate. It starts nicely with\\n SIGHUP and SIGINT. If \\\"force\\\" is True then moves onto SIGKILL. This\\n returns True if the child was terminated. This returns False if the\\n child could not be terminated. '''\\n\\n if not self.isalive():\\n return True\\n try:\\n self.kill(signal.SIGHUP)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGCONT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGINT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n if force:\\n self.kill(signal.SIGKILL)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n return False\\n except OSError:\\n # I think there are kernel timing issues that sometimes cause\\n # this to happen. I think isalive() reports True, but the\\n # process is dead to the kernel.\\n # Make one last attempt to see if the kernel is up to date.\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n\\n def wait(self):\\n '''This waits until the child exits. This is a blocking call. This will\\n not read any data from the child, so this will block forever if the\\n child has unread output and has terminated. In other words, the child\\n may have printed output then called exit(), but, the child is\\n technically still alive until its output is read by the parent. '''\\n\\n if self.isalive():\\n pid, status = os.waitpid(self.pid, 0)\\n else:\\n return self.exitstatus\\n self.exitstatus = os.WEXITSTATUS(status)\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status): # pragma: no cover\\n # You can't call wait() on a child process in the stopped state.\\n raise PtyProcessError('Called wait() on a stopped child ' +\\n 'process. This is not supported. Is some other ' +\\n 'process attempting job control with our child pid?')\\n return self.exitstatus\\n\\n def isalive(self):\\n '''This tests if the child process is running or not. This is\\n non-blocking. If the child was terminated then this will read the\\n exitstatus or signalstatus of the child. This returns True if the child\\n process appears to be running or False if not. It can take literally\\n SECONDS for Solaris to return the right status. '''\\n\\n if self.terminated:\\n return False\\n\\n if self.flag_eof:\\n # This is for Linux, which requires the blocking form\\n # of waitpid to get the status of a defunct process.\\n # This is super-lame. The flag_eof would have been set\\n # in read_nonblocking(), so this should be safe.\\n waitpid_options = 0\\n else:\\n waitpid_options = os.WNOHANG\\n\\n try:\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e:\\n # No child processes\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where \\\"terminated\\\" is 0, but there was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # I have to do this twice for Solaris.\\n # I can't even believe that I figured this out...\\n # If waitpid() returns 0 it means that no child process\\n # wishes to report, and the value of status is undefined.\\n if pid == 0:\\n try:\\n ### os.WNOHANG) # Solaris!\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e: # pragma: no cover\\n # This should never happen...\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'that should never happen. There was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # If pid is still 0 after two calls to waitpid() then the process\\n # really is alive. This seems to work on all platforms, except for\\n # Irix which seems to require a blocking call on waitpid or select,\\n # so I let read_nonblocking take care of this situation\\n # (unfortunately, this requires waiting through the timeout).\\n if pid == 0:\\n return True\\n\\n if pid == 0:\\n return True\\n\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status):\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where child process is stopped. This is not ' +\\n 'supported. Is some other process attempting ' +\\n 'job control with our child pid?')\\n return False\\n\\n def kill(self, sig):\\n \\\"\\\"\\\"Send the given signal to the child application.\\n\\n In keeping with UNIX tradition it has a misleading name. It does not\\n necessarily kill the child unless you send the right signal. See the\\n :mod:`signal` module for constants representing signal numbers.\\n \\\"\\\"\\\"\\n\\n # Same as os.kill, but the pid is given for you.\\n if self.isalive():\\n os.kill(self.pid, sig)\\n\\n def getwinsize(self):\\n \\\"\\\"\\\"Return the window size of the pseudoterminal as a tuple (rows, cols).\\n \\\"\\\"\\\"\\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\\n s = struct.pack('HHHH', 0, 0, 0, 0)\\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\\n return struct.unpack('HHHH', x)[0:2]\\n\\n def setwinsize(self, rows, cols):\\n \\\"\\\"\\\"Set the terminal window size of the child tty.\\n\\n This will cause a SIGWINCH signal to be sent to the child. This does not\\n change the physical window size. It changes the size reported to\\n TTY-aware applications like vi or curses -- applications that respond to\\n the SIGWINCH signal.\\n \\\"\\\"\\\"\\n return _setwinsize(self.fd, rows, cols)\\n\\n\\nclass PtyProcessUnicode(PtyProcess):\\n \\\"\\\"\\\"Unicode wrapper around a process running in a pseudoterminal.\\n\\n This class exposes a similar interface to :class:`PtyProcess`, but its read\\n methods return unicode, and its :meth:`write` accepts unicode.\\n \\\"\\\"\\\"\\n if PY3:\\n string_type = str\\n else:\\n string_type = unicode # analysis:ignore\\n\\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\\n super(PtyProcessUnicode, self).__init__(pid, fd)\\n self.encoding = encoding\\n self.codec_errors = codec_errors\\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read at most ``size`` bytes from the pty, return them as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n\\n The size argument still refers to bytes, not unicode code points.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).read(size)\\n return self.decoder.decode(b, final=False)\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).readline()\\n return self.decoder.decode(b, final=False)\\n\\n def write(self, s):\\n \\\"\\\"\\\"Write the unicode string ``s`` to the pseudoterminal.\\n\\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n b = s.encode(self.encoding)\\n return super(PtyProcessUnicode, self).write(b)\\n\\n[end of ptyprocess/ptyprocess.py]\",\n \"filename\": \"ptyprocess/ptyprocess.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Run a subprocess in a pseudo terminal\\\"\\\"\\\"\\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\\n\\n__version__ = '0.7.0'\\n\\n[end of ptyprocess/__init__.py]\",\n \"filename\": \"ptyprocess/__init__.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"no\\\"?>\\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\\n\\n<svg\\n xmlns:dc=\\\"http://purl.org/dc/elements/1.1/\\\"\\n xmlns:cc=\\\"http://creativecommons.org/ns#\\\"\\n xmlns:rdf=\\\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\\\"\\n xmlns:svg=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns:sodipodi=\\\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\\\"\\n xmlns:inkscape=\\\"http://www.inkscape.org/namespaces/inkscape\\\"\\n width=\\\"554.44196\\\"\\n height=\\\"327.38452\\\"\\n id=\\\"svg2\\\"\\n version=\\\"1.1\\\"\\n inkscape:version=\\\"0.48.4 r9939\\\"\\n sodipodi:docname=\\\"pty_vs_popen.svg\\\">\\n <defs\\n id=\\\"defs4\\\">\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3838\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3783\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(1.1,0,0,1.1,1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Tail\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Tail\\\"\\n style=\\\"overflow:visible\\\">\\n <g\\n id=\\\"g3801\\\"\\n transform=\\\"scale(-1.2,-1.2)\\\">\\n <path\\n id=\\\"path3803\\\"\\n d=\\\"M -3.8048674,-3.9585227 0.54352094,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3805\\\"\\n d=\\\"M -1.2866832,-3.9585227 3.0617053,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3807\\\"\\n d=\\\"M 1.3053582,-3.9585227 5.6537466,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3809\\\"\\n d=\\\"M -3.8048674,4.1775838 0.54352094,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3811\\\"\\n d=\\\"M -1.2866832,4.1775838 3.0617053,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3813\\\"\\n d=\\\"M 1.3053582,4.1775838 5.6537466,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </g>\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3765\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(0.8,0,0,0.8,10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3786\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3768\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(-0.8,0,0,-0.8,-10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-9\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-2\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-6\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-27\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM-5\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3838-7\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10742\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10744\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10746\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10748\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10750\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10752\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10754\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10756\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10758\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10760\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n </defs>\\n <sodipodi:namedview\\n id=\\\"base\\\"\\n pagecolor=\\\"#ffffff\\\"\\n bordercolor=\\\"#666666\\\"\\n borderopacity=\\\"1.0\\\"\\n inkscape:pageopacity=\\\"0.0\\\"\\n inkscape:pageshadow=\\\"2\\\"\\n inkscape:zoom=\\\"0.98994949\\\"\\n inkscape:cx=\\\"77.797977\\\"\\n inkscape:cy=\\\"137.24456\\\"\\n inkscape:document-units=\\\"px\\\"\\n inkscape:current-layer=\\\"layer1\\\"\\n showgrid=\\\"false\\\"\\n inkscape:window-width=\\\"1301\\\"\\n inkscape:window-height=\\\"744\\\"\\n inkscape:window-x=\\\"65\\\"\\n inkscape:window-y=\\\"24\\\"\\n inkscape:window-maximized=\\\"1\\\"\\n fit-margin-top=\\\"1\\\"\\n fit-margin-left=\\\"1\\\"\\n fit-margin-right=\\\"1\\\"\\n fit-margin-bottom=\\\"1\\\"\\n units=\\\"cm\\\" />\\n <metadata\\n id=\\\"metadata7\\\">\\n <rdf:RDF>\\n <cc:Work\\n rdf:about=\\\"\\\">\\n <dc:format>image/svg+xml</dc:format>\\n <dc:type\\n rdf:resource=\\\"http://purl.org/dc/dcmitype/StillImage\\\" />\\n <dc:title></dc:title>\\n </cc:Work>\\n </rdf:RDF>\\n </metadata>\\n <g\\n inkscape:label=\\\"Layer 1\\\"\\n inkscape:groupmode=\\\"layer\\\"\\n id=\\\"layer1\\\"\\n transform=\\\"translate(-40.758533,29.820888)\\\">\\n <g\\n id=\\\"g11880\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591\\\"\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n id=\\\"tspan10593\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <g\\n id=\\\"g10626\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991\\\"\\n d=\\\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7\\\"\\n d=\\\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\\\"\\n id=\\\"path2991-7-8\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5637\\\"\\n d=\\\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5641\\\"\\n d=\\\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5643\\\"\\n d=\\\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n id=\\\"tspan6247\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(18,0)\\\"\\n id=\\\"g11773\\\">\\n <g\\n id=\\\"g11763\\\">\\n <rect\\n y=\\\"120.8597\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308\\\"\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n id=\\\"tspan6310\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g11768\\\">\\n <rect\\n y=\\\"135.43114\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304\\\"\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n id=\\\"tspan6306\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(54,-16)\\\"\\n id=\\\"g10674\\\">\\n <g\\n id=\\\"g10664\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(86.857134,-15.571435)\\\"\\n id=\\\"g10674-6\\\">\\n <g\\n id=\\\"g10664-6\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0-5\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-9\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7-6\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669-5\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5-3\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6-1\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n id=\\\"tspan10728\\\"\\n sodipodi:role=\\\"line\\\">Popen</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-89\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-24\\\"\\n style=\\\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n sodipodi:role=\\\"line\\\">pipes</tspan></text>\\n </g>\\n <g\\n id=\\\"g11847\\\"\\n transform=\\\"translate(-10,0.39179)\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328-0\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-8\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591-3\\\"\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n id=\\\"tspan10593-2\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path11075\\\"\\n d=\\\"m 397.80427,110.64896 0,-52.85714\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\\\" />\\n <g\\n id=\\\"g10626-5\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2-4\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334-0\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336-9\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-4\\\"\\n d=\\\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7-87\\\"\\n d=\\\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331-7\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\\\"\\n id=\\\"path2991-7-8-4\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-6\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n id=\\\"tspan6247-3\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-6\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-2\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8-1\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298-3\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(227.5656,-301.02546)\\\"\\n id=\\\"g11065\\\">\\n <g\\n id=\\\"g11055\\\">\\n <rect\\n y=\\\"421.34998\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55\\\"\\n style=\\\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6\\\"\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n id=\\\"tspan6310-7-9\\\"\\n sodipodi:role=\\\"line\\\">slave</tspan></text>\\n </g>\\n <g\\n id=\\\"g11060\\\">\\n <rect\\n y=\\\"407.25223\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55-9\\\"\\n style=\\\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6-7\\\"\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n id=\\\"tspan6310-7-9-7\\\"\\n sodipodi:role=\\\"line\\\">master</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726-9\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n id=\\\"tspan10728-7\\\"\\n sodipodi:role=\\\"line\\\">Pseudoterminal</tspan><tspan\\n id=\\\"tspan11761\\\"\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"136.71899\\\"\\n x=\\\"429.1268\\\"\\n sodipodi:role=\\\"line\\\">(pty)</tspan></text>\\n </g>\\n </g>\\n</svg>\\n\\n[end of docs/images/pty_vs_popen.svg]\",\n \"filename\": \"docs/images/pty_vs_popen.svg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"None\\n[end of docs/images/pty_vs_popen.png]\",\n \"filename\": \"docs/images/pty_vs_popen.png\",\n \"id\": \"13\"\n }\n]","isConversational":false}}},{"rowIdx":81,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 81,\n \"num_files\": 14,\n \"repo_id\": \"repo_0081\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"python:\n version: 3\n\n[end of readthedocs.yml]","filename":"readthedocs.yml","id":"0"},{"content":"ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, Pexpect development team\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\n\n Permission to use, copy, modify, and/or distribute this software for any\n purpose with or without fee is hereby granted, provided that the above\n copyright notice and this permission notice appear in all copies.\n \n THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"[build-system]\nrequires = [\"flit_core >=2,<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.metadata]\nmodule = \"ptyprocess\"\nauthor = \"Thomas Kluyver\"\nauthor-email = \"thomas@kluyver.me.uk\"\nhome-page = \"https://github.com/pexpect/ptyprocess\"\ndescription-file = \"README.rst\"\nrequires-python = \">=3.7\"\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: ISC License (ISCL)\",\n \"Operating System :: POSIX\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Topic :: Terminals\"\n]\n\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"Launch a subprocess in a pseudo terminal (pty), and interact with both the\nprocess and its pty.\n\nSometimes, piping stdin and stdout is not enough. There might be a password\nprompt that doesn't read from stdin, output that changes when it's going to a\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\nIf you need to automate these things, running the process in a pseudo terminal\n(pty) is the answer.\n\nInterface:\n\n.. code:: python\n\n from ptyprocess import PtyProcessUnicode\n p = PtyProcessUnicode.spawn(['python'])\n p.read(20)\n p.write('6+6\\n')\n p.read(20)\n\n[end of README.rst]","filename":"README.rst","id":"3"},{"content":"Ptyprocess\n==========\n\n.. include:: ../README.rst\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n\n api\n\nWhat is a pty?\n--------------\n\nA pty is a kernel-level object which processes can write data to and read data\nfrom, a bit like a pipe.\n\nUnlike a pipe, data moves through a single pty in both directions. When you use\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\nto three pipes are created for the process's standard streams (stdin, stdout\nand stderr). When you run a program using ptyprocess, all three of its standard\nstreams are connected to a single pty:\n\n.. image:: images/pty_vs_popen.png\n\nA pty also does more than a pipe. It keeps track of the window size (rows and\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\nSIGINT to be sent to the child process.\n\nMany command line programs behave differently if they detect that stdin or stdout\nis connected to a terminal instead of a pipe (using \n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\nthat they're being used interactively by a human user.\nThey may format output differently (e.g. ``ls`` lists files in columns)\nor prompt the user to confirm actions.\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\n\n.. seealso::\n\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\n Detailed article by Linus Akesson\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"4"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = _build\n\n# User-friendly check for sphinx-build\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\nendif\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" xml to make Docutils-native XML files\"\n\t@echo \" pseudoxml to make pseudoxml-XML files for display purposes\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\trm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\nlatexpdfja:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through platex and dvipdfmx...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\nxml:\n\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\n\t@echo\n\t@echo \"Build finished. The XML files are in $(BUILDDIR)/xml.\"\n\npseudoxml:\n\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\n\t@echo\n\t@echo \"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\"\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"5"},{"content":"# -*- coding: utf-8 -*-\n#\n# Ptyprocess documentation build configuration file, created by\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\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\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.insert(0, os.path.abspath('..'))\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.viewcode',\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'Ptyprocess'\ncopyright = u'2014, Thomas Kluyver'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.7'\n# The full version, including alpha/beta/rc tags.\nrelease = version #+ '.2'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\n\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#html_extra_path = []\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'Ptyprocessdoc'\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\n [u'Thomas Kluyver'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {'http://docs.python.org/': None}\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"6"},{"content":"Ptyprocess API\n==============\n\n.. module:: ptyprocess\n\n.. autoclass:: PtyProcess\n\n .. automethod:: spawn\n\n .. automethod:: read\n\n .. automethod:: readline\n\n .. automethod:: write\n\n .. automethod:: sendcontrol\n\n .. automethod:: sendeof\n\n .. automethod:: sendintr\n\n .. automethod:: getecho\n\n .. automethod:: waitnoecho\n\n .. automethod:: setecho\n\n .. automethod:: getwinsize\n\n .. automethod:: setwinsize\n\n .. automethod:: eof\n\n .. automethod:: isalive\n\n .. automethod:: wait\n\n .. automethod:: kill\n\n .. automethod:: terminate\n\n .. automethod:: close\n\n.. autoclass:: PtyProcessUnicode\n\n[end of docs/api.rst]","filename":"docs/api.rst","id":"7"},{"content":"try:\n from shutil import which # Python >= 3.3\nexcept ImportError:\n import os, sys\n \n # This is copied from Python 3.4.1\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\n \"\"\"Given a command, mode, and a PATH string, return the path which\n conforms to the given mode on the PATH, or None if there is no such\n file.\n \n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\n of os.environ.get(\"PATH\"), or can be overridden with a custom search\n path.\n \n \"\"\"\n # Check that a given file can be accessed with the correct mode.\n # Additionally check that `file` is not a directory, as on Windows\n # directories pass the os.access check.\n def _access_check(fn, mode):\n return (os.path.exists(fn) and os.access(fn, mode)\n and not os.path.isdir(fn))\n \n # If we're given a path with a directory part, look it up directly rather\n # than referring to PATH directories. This includes checking relative to the\n # current directory, e.g. ./script\n if os.path.dirname(cmd):\n if _access_check(cmd, mode):\n return cmd\n return None\n \n if path is None:\n path = os.environ.get(\"PATH\", os.defpath)\n if not path:\n return None\n path = path.split(os.pathsep)\n \n if sys.platform == \"win32\":\n # The current directory takes precedence on Windows.\n if not os.curdir in path:\n path.insert(0, os.curdir)\n \n # PATHEXT is necessary to check on Windows.\n pathext = os.environ.get(\"PATHEXT\", \"\").split(os.pathsep)\n # See if the given file matches any of the expected path extensions.\n # This will allow us to short circuit when given \"python.exe\".\n # If it does match, only test that one, otherwise we have to try\n # others.\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\n files = [cmd]\n else:\n files = [cmd + ext for ext in pathext]\n else:\n # On other platforms you don't have things like PATHEXT to tell you\n # what file suffixes are executable, so just pass on cmd as-is.\n files = [cmd]\n \n seen = set()\n for dir in path:\n normdir = os.path.normcase(dir)\n if not normdir in seen:\n seen.add(normdir)\n for thefile in files:\n name = os.path.join(dir, thefile)\n if _access_check(name, mode):\n return name\n return None\n\n\nclass PtyProcessError(Exception):\n \"\"\"Generic error class for this package.\"\"\"\n\n[end of ptyprocess/util.py]","filename":"ptyprocess/util.py","id":"8"},{"content":"\"\"\"Substitute for the forkpty system call, to support Solaris.\n\"\"\"\nimport os\nimport errno\n\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\nfrom .util import PtyProcessError\n\ndef fork_pty():\n '''This implements a substitute for the forkpty system call. This\n should be more portable than the pty.fork() function. Specifically,\n this should work on Solaris.\n\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\n resolve the issue with Python's pty.fork() not supporting Solaris,\n particularly ssh. Based on patch to posixmodule.c authored by Noah\n Spurrier::\n\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\n\n '''\n\n parent_fd, child_fd = os.openpty()\n if parent_fd < 0 or child_fd < 0:\n raise OSError(\"os.openpty() failed\")\n\n pid = os.fork()\n if pid == CHILD:\n # Child.\n os.close(parent_fd)\n pty_make_controlling_tty(child_fd)\n\n os.dup2(child_fd, STDIN_FILENO)\n os.dup2(child_fd, STDOUT_FILENO)\n os.dup2(child_fd, STDERR_FILENO)\n\n else:\n # Parent.\n os.close(child_fd)\n\n return pid, parent_fd\n\ndef pty_make_controlling_tty(tty_fd):\n '''This makes the pseudo-terminal the controlling tty. This should be\n more portable than the pty.fork() function. Specifically, this should\n work on Solaris. '''\n\n child_name = os.ttyname(tty_fd)\n\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\n # if there was no controlling tty to begin with, such as when\n # executed by a cron(1) job.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n os.setsid()\n\n # Verify we are disconnected from controlling tty by attempting to open\n # it again. We expect that OSError of ENXIO should always be raised.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n raise PtyProcessError(\"OSError of errno.ENXIO should be raised.\")\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n # Verify we can open child pty.\n fd = os.open(child_name, os.O_RDWR)\n os.close(fd)\n\n # Verify we now have a controlling tty.\n fd = os.open(\"/dev/tty\", os.O_WRONLY)\n os.close(fd)\n\n[end of ptyprocess/_fork_pty.py]","filename":"ptyprocess/_fork_pty.py","id":"9"},{"content":"import codecs\nimport errno\nimport fcntl\nimport io\nimport os\nimport pty\nimport resource\nimport signal\nimport struct\nimport sys\nimport termios\nimport time\n\ntry:\n import builtins # Python 3\nexcept ImportError:\n import __builtin__ as builtins # Python 2\n\n# Constants\nfrom pty import (STDIN_FILENO, CHILD)\n\nfrom .util import which, PtyProcessError\n\n_platform = sys.platform.lower()\n\n# Solaris uses internal __fork_pty(). All others use pty.fork().\n_is_solaris = (\n _platform.startswith('solaris') or\n _platform.startswith('sunos'))\n\nif _is_solaris:\n use_native_pty_fork = False\n from . import _fork_pty\nelse:\n use_native_pty_fork = True\n\nPY3 = sys.version_info[0] >= 3\n\nif PY3:\n def _byte(i):\n return bytes([i])\nelse:\n def _byte(i):\n return chr(i)\n \n class FileNotFoundError(OSError): pass\n class TimeoutError(OSError): pass\n\n_EOF, _INTR = None, None\n\ndef _make_eof_intr():\n \"\"\"Set constants _EOF and _INTR.\n \n This avoids doing potentially costly operations on module load.\n \"\"\"\n global _EOF, _INTR\n if (_EOF is not None) and (_INTR is not None):\n return\n\n # inherit EOF and INTR definitions from controlling process.\n try:\n from termios import VEOF, VINTR\n fd = None\n for name in 'stdin', 'stdout':\n stream = getattr(sys, '__%s__' % name, None)\n if stream is None or not hasattr(stream, 'fileno'):\n continue\n try:\n fd = stream.fileno()\n except ValueError:\n continue\n if fd is None:\n # no fd, raise ValueError to fallback on CEOF, CINTR\n raise ValueError(\"No stream has a fileno\")\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\n except (ImportError, OSError, IOError, ValueError, termios.error):\n # unless the controlling process is also not a terminal,\n # such as cron(1), or when stdin and stdout are both closed.\n # Fall-back to using CEOF and CINTR. There\n try:\n from termios import CEOF, CINTR\n (intr, eof) = (CINTR, CEOF)\n except ImportError:\n # ^C, ^D\n (intr, eof) = (3, 4)\n \n _INTR = _byte(intr)\n _EOF = _byte(eof)\n\n# setecho and setwinsize are pulled out here because on some platforms, we need\n# to do this from the child before we exec()\n \ndef _setecho(fd, state):\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\n\n try:\n attr = termios.tcgetattr(fd)\n except termios.error as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n if state:\n attr[3] = attr[3] | termios.ECHO\n else:\n attr[3] = attr[3] & ~termios.ECHO\n\n try:\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\n # blocked on some platforms. TCSADRAIN would probably be ideal.\n termios.tcsetattr(fd, termios.TCSANOW, attr)\n except IOError as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\ndef _setwinsize(fd, rows, cols):\n # Some very old platforms have a bug that causes the value for\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\n # around this, but it caused problems with newer platforms so has been\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\n # Note, assume ws_xpixel and ws_ypixel are zero.\n s = struct.pack('HHHH', rows, cols, 0, 0)\n fcntl.ioctl(fd, TIOCSWINSZ, s)\n\nclass PtyProcess(object):\n '''This class represents a process running in a pseudoterminal.\n \n The main constructor is the :meth:`spawn` classmethod.\n '''\n string_type = bytes\n if PY3:\n linesep = os.linesep.encode('ascii')\n crlf = '\\r\\n'.encode('ascii')\n\n @staticmethod\n def write_to_stdout(b):\n try:\n return sys.stdout.buffer.write(b)\n except AttributeError:\n # If stdout has been replaced, it may not have .buffer\n return sys.stdout.write(b.decode('ascii', 'replace'))\n else:\n linesep = os.linesep\n crlf = '\\r\\n'\n write_to_stdout = sys.stdout.write\n\n encoding = None\n \n argv = None\n env = None\n launch_dir = None\n\n def __init__(self, pid, fd):\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\n self.pid = pid\n self.fd = fd\n readf = io.open(fd, 'rb', buffering=0)\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\n self.fileobj = io.BufferedRWPair(readf, writef)\n\n self.terminated = False\n self.closed = False\n self.exitstatus = None\n self.signalstatus = None\n # status returned by os.waitpid\n self.status = None\n self.flag_eof = False\n # Used by close() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterclose = 0.1\n # Used by terminate() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterterminate = 0.1\n\n @classmethod\n def spawn(\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\n dimensions=(24, 80), pass_fds=()):\n '''Start the given command in a child process in a pseudo terminal.\n\n This does all the fork/exec type of stuff for a pty, and returns an\n instance of PtyProcess.\n\n If preexec_fn is supplied, it will be called with no arguments in the\n child process before exec-ing the specified command.\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\n\n Dimensions of the psuedoterminal used for the subprocess can be\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\n\n By default, all file descriptors except 0, 1 and 2 are closed. This\n behavior can be overridden with pass_fds, a list of file descriptors to\n keep open between the parent and the child.\n '''\n # Note that it is difficult for this method to fail.\n # You cannot detect if the child process cannot start.\n # So the only way you can tell if the child process started\n # or not is to try to read from the file descriptor. If you get\n # EOF immediately then it means that the child is already dead.\n # That may not necessarily be bad because you may have spawned a child\n # that performs some task; creates no stdout output; and then dies.\n\n if not isinstance(argv, (list, tuple)):\n raise TypeError(\"Expected a list or tuple for argv, got %r\" % argv)\n\n # Shallow copy of argv so we can modify it\n argv = argv[:]\n command = argv[0]\n\n command_with_path = which(command)\n if command_with_path is None:\n raise FileNotFoundError('The command was not found or was not ' +\n 'executable: %s.' % command)\n command = command_with_path\n argv[0] = command\n\n # [issue #119] To prevent the case where exec fails and the user is\n # stuck interacting with a python child process instead of whatever\n # was expected, we implement the solution from\n # http://stackoverflow.com/a/3703179 to pass the exception to the\n # parent process\n\n # [issue #119] 1. Before forking, open a pipe in the parent process.\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\n\n if use_native_pty_fork:\n pid, fd = pty.fork()\n else:\n # Use internal fork_pty, for Solaris\n pid, fd = _fork_pty.fork_pty()\n\n # Some platforms must call setwinsize() and setecho() from the\n # child process, and others from the master process. We do both,\n # allowing IOError for either.\n\n if pid == CHILD:\n # set window size\n try:\n _setwinsize(STDIN_FILENO, *dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # disable echo if spawn argument echo was unset\n if not echo:\n try:\n _setecho(STDIN_FILENO, False)\n except (IOError, termios.error) as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # [issue #119] 3. The child closes the reading end and sets the\n # close-on-exec flag for the writing end.\n os.close(exec_err_pipe_read)\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\n\n # Do not allow child to inherit open file descriptors from parent,\n # with the exception of the exec_err_pipe_write of the pipe\n # and pass_fds.\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\n # occasionally raises out of range error\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\n os.closerange(pair[0]+1, pair[1])\n\n if cwd is not None:\n os.chdir(cwd)\n\n if preexec_fn is not None:\n try:\n preexec_fn()\n except Exception as e:\n ename = type(e).__name__\n tosend = '{}:0:{}'.format(ename, str(e))\n if PY3:\n tosend = tosend.encode('utf-8')\n\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(1)\n\n try:\n if env is None:\n os.execv(command, argv)\n else:\n os.execvpe(command, argv, env)\n except OSError as err:\n # [issue #119] 5. If exec fails, the child writes the error\n # code back to the parent using the pipe, then exits.\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\n if PY3:\n tosend = tosend.encode('utf-8')\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(os.EX_OSERR)\n\n # Parent\n inst = cls(pid, fd)\n \n # Set some informational attributes\n inst.argv = argv\n if env is not None:\n inst.env = env\n if cwd is not None:\n inst.launch_dir = cwd\n\n # [issue #119] 2. After forking, the parent closes the writing end\n # of the pipe and reads from the reading end.\n os.close(exec_err_pipe_write)\n exec_err_data = os.read(exec_err_pipe_read, 4096)\n os.close(exec_err_pipe_read)\n\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\n # child successfully performed exec, since close-on-exec made\n # successful exec close the writing end of the pipe. Or, if exec\n # failed, the parent reads the error code and can proceed\n # accordingly. Either way, the parent blocks until the child calls\n # exec.\n if len(exec_err_data) != 0:\n try:\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\n\n exception = exctype(errmsg.decode('utf-8', 'replace'))\n if exctype is OSError:\n exception.errno = int(errno_s)\n except:\n raise Exception('Subprocess failed, got bad error data: %r'\n % exec_err_data)\n else:\n raise exception\n\n try:\n inst.setwinsize(*dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\n raise\n\n return inst\n\n def __repr__(self):\n clsname = type(self).__name__\n if self.argv is not None:\n args = [repr(self.argv)]\n if self.env is not None:\n args.append(\"env=%r\" % self.env)\n if self.launch_dir is not None:\n args.append(\"cwd=%r\" % self.launch_dir)\n \n return \"{}.spawn({})\".format(clsname, \", \".join(args))\n \n else:\n return \"{}(pid={}, fd={})\".format(clsname, self.pid, self.fd)\n\n @staticmethod\n def _coerce_send_string(s):\n if not isinstance(s, bytes):\n return s.encode('utf-8')\n return s\n\n @staticmethod\n def _coerce_read_string(s):\n return s\n\n def __del__(self):\n '''This makes sure that no system resources are left open. Python only\n garbage collects Python objects. OS file descriptors are not Python\n objects, so they must be handled explicitly. If the child file\n descriptor was opened outside of this class (passed to the constructor)\n then this does not close it. '''\n\n if not self.closed:\n # It is possible for __del__ methods to execute during the\n # teardown of the Python VM itself. Thus self.close() may\n # trigger an exception because os.close may be None.\n try:\n self.close()\n # which exception, shouldn't we catch explicitly .. ?\n except:\n pass\n\n\n def fileno(self):\n '''This returns the file descriptor of the pty for the child.\n '''\n return self.fd\n\n def close(self, force=True):\n '''This closes the connection with the child application. Note that\n calling close() more than once is valid. This emulates standard Python\n behavior with files. Set force to True if you want to make sure that\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\n and SIGINT). '''\n if not self.closed:\n self.flush()\n self.fileobj.close() # Closes the file descriptor\n # Give kernel time to update process status.\n time.sleep(self.delayafterclose)\n if self.isalive():\n if not self.terminate(force):\n raise PtyProcessError('Could not terminate the child.')\n self.fd = -1\n self.closed = True\n #self.pid = None\n\n def flush(self):\n '''This does nothing. It is here to support the interface for a\n File-like object. '''\n\n pass\n\n def isatty(self):\n '''This returns True if the file descriptor is open and connected to a\n tty(-like) device, else False.\n\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\n the child pty may not appear as a terminal device. This means\n methods such as setecho(), setwinsize(), getwinsize() may raise an\n IOError. '''\n\n return os.isatty(self.fd)\n\n def waitnoecho(self, timeout=None):\n '''Wait until the terminal ECHO flag is set False.\n\n This returns True if the echo mode is off, or False if echo was not\n disabled before the timeout. This can be used to detect when the\n child is waiting for a password. Usually a child application will turn\n off echo mode when it is waiting for the user to enter a password. For\n example, instead of expecting the \"password:\" prompt you can wait for\n the child to turn echo off::\n\n p = pexpect.spawn('ssh user@example.com')\n p.waitnoecho()\n p.sendline(mypassword)\n\n If ``timeout=None`` then this method to block until ECHO flag is False.\n '''\n\n if timeout is not None:\n end_time = time.time() + timeout\n while True:\n if not self.getecho():\n return True\n if timeout < 0 and timeout is not None:\n return False\n if timeout is not None:\n timeout = end_time - time.time()\n time.sleep(0.1)\n\n def getecho(self):\n '''Returns True if terminal echo is on, or False if echo is off.\n\n Child applications that are expecting you to enter a password often\n disable echo. See also :meth:`waitnoecho`.\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n\n try:\n attr = termios.tcgetattr(self.fd)\n except termios.error as err:\n errmsg = 'getecho() may not be called on this platform'\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n self.echo = bool(attr[3] & termios.ECHO)\n return self.echo\n\n def setecho(self, state):\n '''Enable or disable terminal echo.\n\n Anything the child sent before the echo will be lost, so you should be\n sure that your input buffer is empty before you call setecho().\n For example, the following will work as expected::\n\n p = pexpect.spawn('cat') # Echo is on by default.\n p.sendline('1234') # We expect see this twice from the child...\n p.expect(['1234']) # ... once from the tty echo...\n p.expect(['1234']) # ... and again from cat itself.\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n The following WILL NOT WORK because the lines sent before the setecho\n will be lost::\n\n p = pexpect.spawn('cat')\n p.sendline('1234')\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['1234'])\n p.expect(['1234'])\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n _setecho(self.fd, state)\n\n self.echo = state\n\n def read(self, size=1024):\n \"\"\"Read and return at most ``size`` bytes from the pty.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\n with the vagaries of EOF on platforms that do strange things, like IRIX\n or older Solaris systems. It handles the errno=EIO pattern used on\n Linux, and the empty-string return used on BSD platforms and (seemingly)\n on recent Solaris.\n \"\"\"\n try:\n s = self.fileobj.read1(size)\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n try:\n s = self.fileobj.readline()\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def _writeb(self, b, flush=True):\n n = self.fileobj.write(b)\n if flush:\n self.fileobj.flush()\n return n\n\n def write(self, s, flush=True):\n \"\"\"Write bytes to the pseudoterminal.\n \n Returns the number of bytes written.\n \"\"\"\n return self._writeb(s, flush=flush)\n\n def sendcontrol(self, char):\n '''Helper method for sending control characters to the terminal.\n\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\a'``)::\n\n child.sendcontrol('g')\n\n See also, :meth:`sendintr` and :meth:`sendeof`.\n '''\n char = char.lower()\n a = ord(char)\n if 97 <= a <= 122:\n a = a - ord('a') + 1\n byte = _byte(a)\n return self._writeb(byte), byte\n d = {'@': 0, '`': 0,\n '[': 27, '{': 27,\n '\\\\': 28, '|': 28,\n ']': 29, '}': 29,\n '^': 30, '~': 30,\n '_': 31,\n '?': 127}\n if char not in d:\n return 0, b''\n\n byte = _byte(d[char])\n return self._writeb(byte), byte\n\n def sendeof(self):\n '''Sends an EOF (typically Ctrl-D) through the terminal.\n\n This sends a character which causes\n the pending parent output buffer to be sent to the waiting child\n program without waiting for end-of-line. If it is the first character\n of the line, the read() in the user program returns 0, which signifies\n end-of-file. This means to work as expected a sendeof() has to be\n called at the beginning of a line. This method does not send a newline.\n It is the responsibility of the caller to ensure the eof is sent at the\n beginning of a line.\n '''\n return self._writeb(_EOF), _EOF\n\n def sendintr(self):\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\n\n This will normally trigger the kernel to send SIGINT to the current\n foreground process group. Processes can turn off this translation, in\n which case they can read the raw data sent, e.g. ``b'\\\\x03'`` for Ctrl-C.\n\n See also the :meth:`kill` method, which sends a signal directly to the\n immediate child process in the terminal (which is not necessarily the\n foreground process).\n '''\n return self._writeb(_INTR), _INTR\n\n def eof(self):\n '''This returns True if the EOF exception was ever raised.\n '''\n\n return self.flag_eof\n\n def terminate(self, force=False):\n '''This forces a child process to terminate. It starts nicely with\n SIGHUP and SIGINT. If \"force\" is True then moves onto SIGKILL. This\n returns True if the child was terminated. This returns False if the\n child could not be terminated. '''\n\n if not self.isalive():\n return True\n try:\n self.kill(signal.SIGHUP)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGCONT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGINT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n if force:\n self.kill(signal.SIGKILL)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n return False\n except OSError:\n # I think there are kernel timing issues that sometimes cause\n # this to happen. I think isalive() reports True, but the\n # process is dead to the kernel.\n # Make one last attempt to see if the kernel is up to date.\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n\n def wait(self):\n '''This waits until the child exits. This is a blocking call. This will\n not read any data from the child, so this will block forever if the\n child has unread output and has terminated. In other words, the child\n may have printed output then called exit(), but, the child is\n technically still alive until its output is read by the parent. '''\n\n if self.isalive():\n pid, status = os.waitpid(self.pid, 0)\n else:\n return self.exitstatus\n self.exitstatus = os.WEXITSTATUS(status)\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status): # pragma: no cover\n # You can't call wait() on a child process in the stopped state.\n raise PtyProcessError('Called wait() on a stopped child ' +\n 'process. This is not supported. Is some other ' +\n 'process attempting job control with our child pid?')\n return self.exitstatus\n\n def isalive(self):\n '''This tests if the child process is running or not. This is\n non-blocking. If the child was terminated then this will read the\n exitstatus or signalstatus of the child. This returns True if the child\n process appears to be running or False if not. It can take literally\n SECONDS for Solaris to return the right status. '''\n\n if self.terminated:\n return False\n\n if self.flag_eof:\n # This is for Linux, which requires the blocking form\n # of waitpid to get the status of a defunct process.\n # This is super-lame. The flag_eof would have been set\n # in read_nonblocking(), so this should be safe.\n waitpid_options = 0\n else:\n waitpid_options = os.WNOHANG\n\n try:\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e:\n # No child processes\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'where \"terminated\" is 0, but there was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # I have to do this twice for Solaris.\n # I can't even believe that I figured this out...\n # If waitpid() returns 0 it means that no child process\n # wishes to report, and the value of status is undefined.\n if pid == 0:\n try:\n ### os.WNOHANG) # Solaris!\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e: # pragma: no cover\n # This should never happen...\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'that should never happen. There was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # If pid is still 0 after two calls to waitpid() then the process\n # really is alive. This seems to work on all platforms, except for\n # Irix which seems to require a blocking call on waitpid or select,\n # so I let read_nonblocking take care of this situation\n # (unfortunately, this requires waiting through the timeout).\n if pid == 0:\n return True\n\n if pid == 0:\n return True\n\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status):\n raise PtyProcessError('isalive() encountered condition ' +\n 'where child process is stopped. This is not ' +\n 'supported. Is some other process attempting ' +\n 'job control with our child pid?')\n return False\n\n def kill(self, sig):\n \"\"\"Send the given signal to the child application.\n\n In keeping with UNIX tradition it has a misleading name. It does not\n necessarily kill the child unless you send the right signal. See the\n :mod:`signal` module for constants representing signal numbers.\n \"\"\"\n\n # Same as os.kill, but the pid is given for you.\n if self.isalive():\n os.kill(self.pid, sig)\n\n def getwinsize(self):\n \"\"\"Return the window size of the pseudoterminal as a tuple (rows, cols).\n \"\"\"\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\n s = struct.pack('HHHH', 0, 0, 0, 0)\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\n return struct.unpack('HHHH', x)[0:2]\n\n def setwinsize(self, rows, cols):\n \"\"\"Set the terminal window size of the child tty.\n\n This will cause a SIGWINCH signal to be sent to the child. This does not\n change the physical window size. It changes the size reported to\n TTY-aware applications like vi or curses -- applications that respond to\n the SIGWINCH signal.\n \"\"\"\n return _setwinsize(self.fd, rows, cols)\n\n\nclass PtyProcessUnicode(PtyProcess):\n \"\"\"Unicode wrapper around a process running in a pseudoterminal.\n\n This class exposes a similar interface to :class:`PtyProcess`, but its read\n methods return unicode, and its :meth:`write` accepts unicode.\n \"\"\"\n if PY3:\n string_type = str\n else:\n string_type = unicode # analysis:ignore\n\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\n super(PtyProcessUnicode, self).__init__(pid, fd)\n self.encoding = encoding\n self.codec_errors = codec_errors\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\n\n def read(self, size=1024):\n \"\"\"Read at most ``size`` bytes from the pty, return them as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n\n The size argument still refers to bytes, not unicode code points.\n \"\"\"\n b = super(PtyProcessUnicode, self).read(size)\n return self.decoder.decode(b, final=False)\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n b = super(PtyProcessUnicode, self).readline()\n return self.decoder.decode(b, final=False)\n\n def write(self, s):\n \"\"\"Write the unicode string ``s`` to the pseudoterminal.\n\n Returns the number of bytes written.\n \"\"\"\n b = s.encode(self.encoding)\n return super(PtyProcessUnicode, self).write(b)\n\n[end of ptyprocess/ptyprocess.py]","filename":"ptyprocess/ptyprocess.py","id":"10"},{"content":"\"\"\"Run a subprocess in a pseudo terminal\"\"\"\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\n\n__version__ = '0.7.0'\n\n[end of ptyprocess/__init__.py]","filename":"ptyprocess/__init__.py","id":"11"},{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\n\n<svg\n xmlns:dc=\"http://purl.org/dc/elements/1.1/\"\n xmlns:cc=\"http://creativecommons.org/ns#\"\n xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n xmlns:svg=\"http://www.w3.org/2000/svg\"\n xmlns=\"http://www.w3.org/2000/svg\"\n xmlns:sodipodi=\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\"\n xmlns:inkscape=\"http://www.inkscape.org/namespaces/inkscape\"\n width=\"554.44196\"\n height=\"327.38452\"\n id=\"svg2\"\n version=\"1.1\"\n inkscape:version=\"0.48.4 r9939\"\n sodipodi:docname=\"pty_vs_popen.svg\">\n <defs\n id=\"defs4\">\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM\"\n style=\"overflow:visible\">\n <path\n id=\"path3838\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3783\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(1.1,0,0,1.1,1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Tail\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Tail\"\n style=\"overflow:visible\">\n <g\n id=\"g3801\"\n transform=\"scale(-1.2,-1.2)\">\n <path\n id=\"path3803\"\n d=\"M -3.8048674,-3.9585227 0.54352094,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3805\"\n d=\"M -1.2866832,-3.9585227 3.0617053,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3807\"\n d=\"M 1.3053582,-3.9585227 5.6537466,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3809\"\n d=\"M -3.8048674,4.1775838 0.54352094,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3811\"\n d=\"M -1.2866832,4.1775838 3.0617053,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3813\"\n d=\"M 1.3053582,4.1775838 5.6537466,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n </g>\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3765\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(0.8,0,0,0.8,10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3786\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3768\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(-0.8,0,0,-0.8,-10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-9\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-2\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-6\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-27\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM-5\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3838-7\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10742\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10744\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10746\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10748\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10750\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10752\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10754\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10756\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10758\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10760\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n </defs>\n <sodipodi:namedview\n id=\"base\"\n pagecolor=\"#ffffff\"\n bordercolor=\"#666666\"\n borderopacity=\"1.0\"\n inkscape:pageopacity=\"0.0\"\n inkscape:pageshadow=\"2\"\n inkscape:zoom=\"0.98994949\"\n inkscape:cx=\"77.797977\"\n inkscape:cy=\"137.24456\"\n inkscape:document-units=\"px\"\n inkscape:current-layer=\"layer1\"\n showgrid=\"false\"\n inkscape:window-width=\"1301\"\n inkscape:window-height=\"744\"\n inkscape:window-x=\"65\"\n inkscape:window-y=\"24\"\n inkscape:window-maximized=\"1\"\n fit-margin-top=\"1\"\n fit-margin-left=\"1\"\n fit-margin-right=\"1\"\n fit-margin-bottom=\"1\"\n units=\"cm\" />\n <metadata\n id=\"metadata7\">\n <rdf:RDF>\n <cc:Work\n rdf:about=\"\">\n <dc:format>image/svg+xml</dc:format>\n <dc:type\n rdf:resource=\"http://purl.org/dc/dcmitype/StillImage\" />\n <dc:title></dc:title>\n </cc:Work>\n </rdf:RDF>\n </metadata>\n <g\n inkscape:label=\"Layer 1\"\n inkscape:groupmode=\"layer\"\n id=\"layer1\"\n transform=\"translate(-40.758533,29.820888)\">\n <g\n id=\"g11880\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591\"\n y=\"240.97427\"\n x=\"138.65004\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.97427\"\n x=\"138.65004\"\n id=\"tspan10593\"\n sodipodi:role=\"line\">Child</tspan></text>\n <g\n id=\"g10626\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991\"\n d=\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7\"\n d=\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\"\n id=\"path2991-7-8\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5637\"\n d=\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5641\"\n d=\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5643\"\n d=\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245\"\n y=\"240.57648\"\n x=\"90\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.57648\"\n x=\"90\"\n id=\"tspan6247\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8\"\n y=\"213.07455\"\n x=\"184.47076\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"213.07455\"\n x=\"184.47076\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8\"\n y=\"262.00311\"\n x=\"192.32663\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"262.00311\"\n x=\"192.32663\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(18,0)\"\n id=\"g11773\">\n <g\n id=\"g11763\">\n <rect\n y=\"120.8597\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308\"\n y=\"129.96561\"\n x=\"63.277264\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"129.96561\"\n x=\"63.277264\"\n id=\"tspan6310\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g11768\">\n <rect\n y=\"135.43114\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304\"\n y=\"144.58977\"\n x=\"64.540932\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"144.58977\"\n x=\"64.540932\"\n id=\"tspan6306\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(54,-16)\"\n id=\"g10674\">\n <g\n id=\"g10664\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(86.857134,-15.571435)\"\n id=\"g10674-6\">\n <g\n id=\"g10664-6\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0-5\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-9\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7-6\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669-5\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5-3\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6-1\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726\"\n y=\"139.6479\"\n x=\"135.03683\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"139.6479\"\n x=\"135.03683\"\n id=\"tspan10728\"\n sodipodi:role=\"line\">Popen</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-89\"\n y=\"158.43169\"\n x=\"234.46947\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-24\"\n style=\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\"\n y=\"158.43169\"\n x=\"234.46947\"\n sodipodi:role=\"line\">pipes</tspan></text>\n </g>\n <g\n id=\"g11847\"\n transform=\"translate(-10,0.39179)\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328-0\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-8\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591-3\"\n y=\"240.5825\"\n x=\"372.50137\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.5825\"\n x=\"372.50137\"\n id=\"tspan10593-2\"\n sodipodi:role=\"line\">Child</tspan></text>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path11075\"\n d=\"m 397.80427,110.64896 0,-52.85714\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\" />\n <g\n id=\"g10626-5\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2-4\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334-0\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336-9\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-4\"\n d=\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7-87\"\n d=\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331-7\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\"\n id=\"path2991-7-8-4\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-6\"\n y=\"240.18468\"\n x=\"323.85132\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.18468\"\n x=\"323.85132\"\n id=\"tspan6247-3\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-6\"\n y=\"207.68279\"\n x=\"410.10779\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-2\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"207.68279\"\n x=\"410.10779\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8-1\"\n y=\"261.61133\"\n x=\"426.17795\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298-3\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"261.61133\"\n x=\"426.17795\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(227.5656,-301.02546)\"\n id=\"g11065\">\n <g\n id=\"g11055\">\n <rect\n y=\"421.34998\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55\"\n style=\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6\"\n y=\"431.01376\"\n x=\"159.1624\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"431.01376\"\n x=\"159.1624\"\n id=\"tspan6310-7-9\"\n sodipodi:role=\"line\">slave</tspan></text>\n </g>\n <g\n id=\"g11060\">\n <rect\n y=\"407.25223\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55-9\"\n style=\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6-7\"\n y=\"416.68555\"\n x=\"155.16631\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"416.68555\"\n x=\"155.16631\"\n id=\"tspan6310-7-9-7\"\n sodipodi:role=\"line\">master</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726-9\"\n y=\"116.71899\"\n x=\"429.1268\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"116.71899\"\n x=\"429.1268\"\n id=\"tspan10728-7\"\n sodipodi:role=\"line\">Pseudoterminal</tspan><tspan\n id=\"tspan11761\"\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"136.71899\"\n x=\"429.1268\"\n sodipodi:role=\"line\">(pty)</tspan></text>\n </g>\n </g>\n</svg>\n\n[end of docs/images/pty_vs_popen.svg]","filename":"docs/images/pty_vs_popen.svg","id":"12"},{"content":"None\n[end of docs/images/pty_vs_popen.png]","filename":"docs/images/pty_vs_popen.png","id":"13"}],"string":"[\n {\n \"content\": \"python:\\n version: 3\\n\\n[end of readthedocs.yml]\",\n \"filename\": \"readthedocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"ISC LICENSE\\n\\n This license is approved by the OSI and FSF as GPL-compatible.\\n http://opensource.org/licenses/isc-license.txt\\n\\n Copyright (c) 2013-2014, Pexpect development team\\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\\n\\n Permission to use, copy, modify, and/or distribute this software for any\\n purpose with or without fee is hereby granted, provided that the above\\n copyright notice and this permission notice appear in all copies.\\n \\n THE SOFTWARE IS PROVIDED \\\"AS IS\\\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"flit_core >=2,<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.metadata]\\nmodule = \\\"ptyprocess\\\"\\nauthor = \\\"Thomas Kluyver\\\"\\nauthor-email = \\\"thomas@kluyver.me.uk\\\"\\nhome-page = \\\"https://github.com/pexpect/ptyprocess\\\"\\ndescription-file = \\\"README.rst\\\"\\nrequires-python = \\\">=3.7\\\"\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: ISC License (ISCL)\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Topic :: Terminals\\\"\\n]\\n\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"Launch a subprocess in a pseudo terminal (pty), and interact with both the\\nprocess and its pty.\\n\\nSometimes, piping stdin and stdout is not enough. There might be a password\\nprompt that doesn't read from stdin, output that changes when it's going to a\\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\\nIf you need to automate these things, running the process in a pseudo terminal\\n(pty) is the answer.\\n\\nInterface:\\n\\n.. code:: python\\n\\n from ptyprocess import PtyProcessUnicode\\n p = PtyProcessUnicode.spawn(['python'])\\n p.read(20)\\n p.write('6+6\\\\n')\\n p.read(20)\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"3\"\n },\n {\n \"content\": \"Ptyprocess\\n==========\\n\\n.. include:: ../README.rst\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n\\n api\\n\\nWhat is a pty?\\n--------------\\n\\nA pty is a kernel-level object which processes can write data to and read data\\nfrom, a bit like a pipe.\\n\\nUnlike a pipe, data moves through a single pty in both directions. When you use\\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\\nto three pipes are created for the process's standard streams (stdin, stdout\\nand stderr). When you run a program using ptyprocess, all three of its standard\\nstreams are connected to a single pty:\\n\\n.. image:: images/pty_vs_popen.png\\n\\nA pty also does more than a pipe. It keeps track of the window size (rows and\\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\\nSIGINT to be sent to the child process.\\n\\nMany command line programs behave differently if they detect that stdin or stdout\\nis connected to a terminal instead of a pipe (using \\n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\\nthat they're being used interactively by a human user.\\nThey may format output differently (e.g. ``ls`` lists files in columns)\\nor prompt the user to confirm actions.\\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\\n\\n.. seealso::\\n\\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\\n Detailed article by Linus Akesson\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"4\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = _build\\n\\n# User-friendly check for sphinx-build\\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\\nendif\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n# the i18n builder cannot share the environment and doctrees with the others\\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n\\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" singlehtml to make a single large HTML file\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" devhelp to make HTML files and a Devhelp project\\\"\\n\\t@echo \\\" epub to make an epub\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" latexpdf to make LaTeX files and run them through pdflatex\\\"\\n\\t@echo \\\" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\\\"\\n\\t@echo \\\" text to make text files\\\"\\n\\t@echo \\\" man to make manual pages\\\"\\n\\t@echo \\\" texinfo to make Texinfo files\\\"\\n\\t@echo \\\" info to make Texinfo files and run them through makeinfo\\\"\\n\\t@echo \\\" gettext to make PO message catalogs\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" xml to make Docutils-native XML files\\\"\\n\\t@echo \\\" pseudoxml to make pseudoxml-XML files for display purposes\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\trm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\nsinglehtml:\\n\\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\\\"\\n\\ndevhelp:\\n\\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\\n\\t@echo\\n\\t@echo \\\"Build finished.\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# devhelp\\\"\\n\\nepub:\\n\\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\\n\\t@echo\\n\\t@echo \\\"Build finished. The epub file is in $(BUILDDIR)/epub.\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through (pdf)latex\\\" \\\\\\n\\t \\\"(use \\\\`make latexpdf' here to do that automatically).\\\"\\n\\nlatexpdf:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through pdflatex...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\nlatexpdfja:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through platex and dvipdfmx...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\ntext:\\n\\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\\n\\t@echo\\n\\t@echo \\\"Build finished. The text files are in $(BUILDDIR)/text.\\\"\\n\\nman:\\n\\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\\n\\t@echo\\n\\t@echo \\\"Build finished. The manual pages are in $(BUILDDIR)/man.\\\"\\n\\ntexinfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo\\n\\t@echo \\\"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through makeinfo\\\" \\\\\\n\\t \\\"(use \\\\`make info' here to do that automatically).\\\"\\n\\ninfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo \\\"Running Texinfo files through makeinfo...\\\"\\n\\tmake -C $(BUILDDIR)/texinfo info\\n\\t@echo \\\"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\\\"\\n\\ngettext:\\n\\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\\n\\t@echo\\n\\t@echo \\\"Build finished. The message catalogs are in $(BUILDDIR)/locale.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\nxml:\\n\\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\\n\\t@echo\\n\\t@echo \\\"Build finished. The XML files are in $(BUILDDIR)/xml.\\\"\\n\\npseudoxml:\\n\\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\\n\\t@echo\\n\\t@echo \\\"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\\\"\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n#\\n# Ptyprocess documentation build configuration file, created by\\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\\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\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.insert(0, os.path.abspath('..'))\\n\\n# -- General configuration ------------------------------------------------\\n\\n# If your documentation needs a minimal Sphinx version, state it here.\\n#needs_sphinx = '1.0'\\n\\n# Add any Sphinx extension module names here, as strings. They can be\\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\\n# ones.\\nextensions = [\\n 'sphinx.ext.autodoc',\\n 'sphinx.ext.intersphinx',\\n 'sphinx.ext.viewcode',\\n]\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['_templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8-sig'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = u'Ptyprocess'\\ncopyright = u'2014, Thomas Kluyver'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.7'\\n# The full version, including alpha/beta/rc tags.\\nrelease = version #+ '.2'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of patterns, relative to source directory, that match files and\\n# directories to ignore when looking for source files.\\nexclude_patterns = ['_build']\\n\\n# The reST default role (used for this markup: `text`) to use for all\\n# documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n# If true, keep warnings as \\\"system message\\\" paragraphs in the built documents.\\n#keep_warnings = False\\n\\n\\n# -- Options for HTML output ----------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. See the documentation for\\n# a list of builtin themes.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['_static']\\n\\n# Add any extra paths that contain custom files (such as robots.txt or\\n# .htaccess) here, relative to this directory. These files are copied\\n# directly to the root of the documentation.\\n#html_extra_path = []\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_domain_indices = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, \\\"Created using Sphinx\\\" is shown in the HTML footer. Default is True.\\n#html_show_sphinx = True\\n\\n# If true, \\\"(C) Copyright ...\\\" is shown in the HTML footer. Default is True.\\n#html_show_copyright = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# This is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = None\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'Ptyprocessdoc'\\n\\n\\n# -- Options for LaTeX output ---------------------------------------------\\n\\nlatex_elements = {\\n# The paper size ('letterpaper' or 'a4paper').\\n#'papersize': 'letterpaper',\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#'pointsize': '10pt',\\n\\n# Additional stuff for the LaTeX preamble.\\n#'preamble': '',\\n}\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title,\\n# author, documentclass [howto, manual, or own class]).\\nlatex_documents = [\\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# If true, show page references after internal links.\\n#latex_show_pagerefs = False\\n\\n# If true, show URL addresses after external links.\\n#latex_show_urls = False\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_domain_indices = True\\n\\n\\n# -- Options for manual page output ---------------------------------------\\n\\n# One entry per manual page. List of tuples\\n# (source start file, name, description, authors, manual section).\\nman_pages = [\\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\\n [u'Thomas Kluyver'], 1)\\n]\\n\\n# If true, show URL addresses after external links.\\n#man_show_urls = False\\n\\n\\n# -- Options for Texinfo output -------------------------------------------\\n\\n# Grouping the document tree into Texinfo files. List of tuples\\n# (source start file, target name, title, author,\\n# dir menu entry, description, category)\\ntexinfo_documents = [\\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\\n 'Miscellaneous'),\\n]\\n\\n# Documents to append as an appendix to all manuals.\\n#texinfo_appendices = []\\n\\n# If false, no module index is generated.\\n#texinfo_domain_indices = True\\n\\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\\n#texinfo_show_urls = 'footnote'\\n\\n# If true, do not generate a @detailmenu in the \\\"Top\\\" node's menu.\\n#texinfo_no_detailmenu = False\\n\\n\\n# Example configuration for intersphinx: refer to the Python standard library.\\nintersphinx_mapping = {'http://docs.python.org/': None}\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Ptyprocess API\\n==============\\n\\n.. module:: ptyprocess\\n\\n.. autoclass:: PtyProcess\\n\\n .. automethod:: spawn\\n\\n .. automethod:: read\\n\\n .. automethod:: readline\\n\\n .. automethod:: write\\n\\n .. automethod:: sendcontrol\\n\\n .. automethod:: sendeof\\n\\n .. automethod:: sendintr\\n\\n .. automethod:: getecho\\n\\n .. automethod:: waitnoecho\\n\\n .. automethod:: setecho\\n\\n .. automethod:: getwinsize\\n\\n .. automethod:: setwinsize\\n\\n .. automethod:: eof\\n\\n .. automethod:: isalive\\n\\n .. automethod:: wait\\n\\n .. automethod:: kill\\n\\n .. automethod:: terminate\\n\\n .. automethod:: close\\n\\n.. autoclass:: PtyProcessUnicode\\n\\n[end of docs/api.rst]\",\n \"filename\": \"docs/api.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"try:\\n from shutil import which # Python >= 3.3\\nexcept ImportError:\\n import os, sys\\n \\n # This is copied from Python 3.4.1\\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\\n \\\"\\\"\\\"Given a command, mode, and a PATH string, return the path which\\n conforms to the given mode on the PATH, or None if there is no such\\n file.\\n \\n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\\n of os.environ.get(\\\"PATH\\\"), or can be overridden with a custom search\\n path.\\n \\n \\\"\\\"\\\"\\n # Check that a given file can be accessed with the correct mode.\\n # Additionally check that `file` is not a directory, as on Windows\\n # directories pass the os.access check.\\n def _access_check(fn, mode):\\n return (os.path.exists(fn) and os.access(fn, mode)\\n and not os.path.isdir(fn))\\n \\n # If we're given a path with a directory part, look it up directly rather\\n # than referring to PATH directories. This includes checking relative to the\\n # current directory, e.g. ./script\\n if os.path.dirname(cmd):\\n if _access_check(cmd, mode):\\n return cmd\\n return None\\n \\n if path is None:\\n path = os.environ.get(\\\"PATH\\\", os.defpath)\\n if not path:\\n return None\\n path = path.split(os.pathsep)\\n \\n if sys.platform == \\\"win32\\\":\\n # The current directory takes precedence on Windows.\\n if not os.curdir in path:\\n path.insert(0, os.curdir)\\n \\n # PATHEXT is necessary to check on Windows.\\n pathext = os.environ.get(\\\"PATHEXT\\\", \\\"\\\").split(os.pathsep)\\n # See if the given file matches any of the expected path extensions.\\n # This will allow us to short circuit when given \\\"python.exe\\\".\\n # If it does match, only test that one, otherwise we have to try\\n # others.\\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\\n files = [cmd]\\n else:\\n files = [cmd + ext for ext in pathext]\\n else:\\n # On other platforms you don't have things like PATHEXT to tell you\\n # what file suffixes are executable, so just pass on cmd as-is.\\n files = [cmd]\\n \\n seen = set()\\n for dir in path:\\n normdir = os.path.normcase(dir)\\n if not normdir in seen:\\n seen.add(normdir)\\n for thefile in files:\\n name = os.path.join(dir, thefile)\\n if _access_check(name, mode):\\n return name\\n return None\\n\\n\\nclass PtyProcessError(Exception):\\n \\\"\\\"\\\"Generic error class for this package.\\\"\\\"\\\"\\n\\n[end of ptyprocess/util.py]\",\n \"filename\": \"ptyprocess/util.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Substitute for the forkpty system call, to support Solaris.\\n\\\"\\\"\\\"\\nimport os\\nimport errno\\n\\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\\nfrom .util import PtyProcessError\\n\\ndef fork_pty():\\n '''This implements a substitute for the forkpty system call. This\\n should be more portable than the pty.fork() function. Specifically,\\n this should work on Solaris.\\n\\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\\n resolve the issue with Python's pty.fork() not supporting Solaris,\\n particularly ssh. Based on patch to posixmodule.c authored by Noah\\n Spurrier::\\n\\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\\n\\n '''\\n\\n parent_fd, child_fd = os.openpty()\\n if parent_fd < 0 or child_fd < 0:\\n raise OSError(\\\"os.openpty() failed\\\")\\n\\n pid = os.fork()\\n if pid == CHILD:\\n # Child.\\n os.close(parent_fd)\\n pty_make_controlling_tty(child_fd)\\n\\n os.dup2(child_fd, STDIN_FILENO)\\n os.dup2(child_fd, STDOUT_FILENO)\\n os.dup2(child_fd, STDERR_FILENO)\\n\\n else:\\n # Parent.\\n os.close(child_fd)\\n\\n return pid, parent_fd\\n\\ndef pty_make_controlling_tty(tty_fd):\\n '''This makes the pseudo-terminal the controlling tty. This should be\\n more portable than the pty.fork() function. Specifically, this should\\n work on Solaris. '''\\n\\n child_name = os.ttyname(tty_fd)\\n\\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\\n # if there was no controlling tty to begin with, such as when\\n # executed by a cron(1) job.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n os.setsid()\\n\\n # Verify we are disconnected from controlling tty by attempting to open\\n # it again. We expect that OSError of ENXIO should always be raised.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n raise PtyProcessError(\\\"OSError of errno.ENXIO should be raised.\\\")\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n # Verify we can open child pty.\\n fd = os.open(child_name, os.O_RDWR)\\n os.close(fd)\\n\\n # Verify we now have a controlling tty.\\n fd = os.open(\\\"/dev/tty\\\", os.O_WRONLY)\\n os.close(fd)\\n\\n[end of ptyprocess/_fork_pty.py]\",\n \"filename\": \"ptyprocess/_fork_pty.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"import codecs\\nimport errno\\nimport fcntl\\nimport io\\nimport os\\nimport pty\\nimport resource\\nimport signal\\nimport struct\\nimport sys\\nimport termios\\nimport time\\n\\ntry:\\n import builtins # Python 3\\nexcept ImportError:\\n import __builtin__ as builtins # Python 2\\n\\n# Constants\\nfrom pty import (STDIN_FILENO, CHILD)\\n\\nfrom .util import which, PtyProcessError\\n\\n_platform = sys.platform.lower()\\n\\n# Solaris uses internal __fork_pty(). All others use pty.fork().\\n_is_solaris = (\\n _platform.startswith('solaris') or\\n _platform.startswith('sunos'))\\n\\nif _is_solaris:\\n use_native_pty_fork = False\\n from . import _fork_pty\\nelse:\\n use_native_pty_fork = True\\n\\nPY3 = sys.version_info[0] >= 3\\n\\nif PY3:\\n def _byte(i):\\n return bytes([i])\\nelse:\\n def _byte(i):\\n return chr(i)\\n \\n class FileNotFoundError(OSError): pass\\n class TimeoutError(OSError): pass\\n\\n_EOF, _INTR = None, None\\n\\ndef _make_eof_intr():\\n \\\"\\\"\\\"Set constants _EOF and _INTR.\\n \\n This avoids doing potentially costly operations on module load.\\n \\\"\\\"\\\"\\n global _EOF, _INTR\\n if (_EOF is not None) and (_INTR is not None):\\n return\\n\\n # inherit EOF and INTR definitions from controlling process.\\n try:\\n from termios import VEOF, VINTR\\n fd = None\\n for name in 'stdin', 'stdout':\\n stream = getattr(sys, '__%s__' % name, None)\\n if stream is None or not hasattr(stream, 'fileno'):\\n continue\\n try:\\n fd = stream.fileno()\\n except ValueError:\\n continue\\n if fd is None:\\n # no fd, raise ValueError to fallback on CEOF, CINTR\\n raise ValueError(\\\"No stream has a fileno\\\")\\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\\n except (ImportError, OSError, IOError, ValueError, termios.error):\\n # unless the controlling process is also not a terminal,\\n # such as cron(1), or when stdin and stdout are both closed.\\n # Fall-back to using CEOF and CINTR. There\\n try:\\n from termios import CEOF, CINTR\\n (intr, eof) = (CINTR, CEOF)\\n except ImportError:\\n # ^C, ^D\\n (intr, eof) = (3, 4)\\n \\n _INTR = _byte(intr)\\n _EOF = _byte(eof)\\n\\n# setecho and setwinsize are pulled out here because on some platforms, we need\\n# to do this from the child before we exec()\\n \\ndef _setecho(fd, state):\\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\\n\\n try:\\n attr = termios.tcgetattr(fd)\\n except termios.error as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n if state:\\n attr[3] = attr[3] | termios.ECHO\\n else:\\n attr[3] = attr[3] & ~termios.ECHO\\n\\n try:\\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\\n # blocked on some platforms. TCSADRAIN would probably be ideal.\\n termios.tcsetattr(fd, termios.TCSANOW, attr)\\n except IOError as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\ndef _setwinsize(fd, rows, cols):\\n # Some very old platforms have a bug that causes the value for\\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\\n # around this, but it caused problems with newer platforms so has been\\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\\n # Note, assume ws_xpixel and ws_ypixel are zero.\\n s = struct.pack('HHHH', rows, cols, 0, 0)\\n fcntl.ioctl(fd, TIOCSWINSZ, s)\\n\\nclass PtyProcess(object):\\n '''This class represents a process running in a pseudoterminal.\\n \\n The main constructor is the :meth:`spawn` classmethod.\\n '''\\n string_type = bytes\\n if PY3:\\n linesep = os.linesep.encode('ascii')\\n crlf = '\\\\r\\\\n'.encode('ascii')\\n\\n @staticmethod\\n def write_to_stdout(b):\\n try:\\n return sys.stdout.buffer.write(b)\\n except AttributeError:\\n # If stdout has been replaced, it may not have .buffer\\n return sys.stdout.write(b.decode('ascii', 'replace'))\\n else:\\n linesep = os.linesep\\n crlf = '\\\\r\\\\n'\\n write_to_stdout = sys.stdout.write\\n\\n encoding = None\\n \\n argv = None\\n env = None\\n launch_dir = None\\n\\n def __init__(self, pid, fd):\\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\\n self.pid = pid\\n self.fd = fd\\n readf = io.open(fd, 'rb', buffering=0)\\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\\n self.fileobj = io.BufferedRWPair(readf, writef)\\n\\n self.terminated = False\\n self.closed = False\\n self.exitstatus = None\\n self.signalstatus = None\\n # status returned by os.waitpid\\n self.status = None\\n self.flag_eof = False\\n # Used by close() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterclose = 0.1\\n # Used by terminate() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterterminate = 0.1\\n\\n @classmethod\\n def spawn(\\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\\n dimensions=(24, 80), pass_fds=()):\\n '''Start the given command in a child process in a pseudo terminal.\\n\\n This does all the fork/exec type of stuff for a pty, and returns an\\n instance of PtyProcess.\\n\\n If preexec_fn is supplied, it will be called with no arguments in the\\n child process before exec-ing the specified command.\\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\\n\\n Dimensions of the psuedoterminal used for the subprocess can be\\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\\n\\n By default, all file descriptors except 0, 1 and 2 are closed. This\\n behavior can be overridden with pass_fds, a list of file descriptors to\\n keep open between the parent and the child.\\n '''\\n # Note that it is difficult for this method to fail.\\n # You cannot detect if the child process cannot start.\\n # So the only way you can tell if the child process started\\n # or not is to try to read from the file descriptor. If you get\\n # EOF immediately then it means that the child is already dead.\\n # That may not necessarily be bad because you may have spawned a child\\n # that performs some task; creates no stdout output; and then dies.\\n\\n if not isinstance(argv, (list, tuple)):\\n raise TypeError(\\\"Expected a list or tuple for argv, got %r\\\" % argv)\\n\\n # Shallow copy of argv so we can modify it\\n argv = argv[:]\\n command = argv[0]\\n\\n command_with_path = which(command)\\n if command_with_path is None:\\n raise FileNotFoundError('The command was not found or was not ' +\\n 'executable: %s.' % command)\\n command = command_with_path\\n argv[0] = command\\n\\n # [issue #119] To prevent the case where exec fails and the user is\\n # stuck interacting with a python child process instead of whatever\\n # was expected, we implement the solution from\\n # http://stackoverflow.com/a/3703179 to pass the exception to the\\n # parent process\\n\\n # [issue #119] 1. Before forking, open a pipe in the parent process.\\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\\n\\n if use_native_pty_fork:\\n pid, fd = pty.fork()\\n else:\\n # Use internal fork_pty, for Solaris\\n pid, fd = _fork_pty.fork_pty()\\n\\n # Some platforms must call setwinsize() and setecho() from the\\n # child process, and others from the master process. We do both,\\n # allowing IOError for either.\\n\\n if pid == CHILD:\\n # set window size\\n try:\\n _setwinsize(STDIN_FILENO, *dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # disable echo if spawn argument echo was unset\\n if not echo:\\n try:\\n _setecho(STDIN_FILENO, False)\\n except (IOError, termios.error) as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # [issue #119] 3. The child closes the reading end and sets the\\n # close-on-exec flag for the writing end.\\n os.close(exec_err_pipe_read)\\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\\n\\n # Do not allow child to inherit open file descriptors from parent,\\n # with the exception of the exec_err_pipe_write of the pipe\\n # and pass_fds.\\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\\n # occasionally raises out of range error\\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\\n os.closerange(pair[0]+1, pair[1])\\n\\n if cwd is not None:\\n os.chdir(cwd)\\n\\n if preexec_fn is not None:\\n try:\\n preexec_fn()\\n except Exception as e:\\n ename = type(e).__name__\\n tosend = '{}:0:{}'.format(ename, str(e))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(1)\\n\\n try:\\n if env is None:\\n os.execv(command, argv)\\n else:\\n os.execvpe(command, argv, env)\\n except OSError as err:\\n # [issue #119] 5. If exec fails, the child writes the error\\n # code back to the parent using the pipe, then exits.\\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(os.EX_OSERR)\\n\\n # Parent\\n inst = cls(pid, fd)\\n \\n # Set some informational attributes\\n inst.argv = argv\\n if env is not None:\\n inst.env = env\\n if cwd is not None:\\n inst.launch_dir = cwd\\n\\n # [issue #119] 2. After forking, the parent closes the writing end\\n # of the pipe and reads from the reading end.\\n os.close(exec_err_pipe_write)\\n exec_err_data = os.read(exec_err_pipe_read, 4096)\\n os.close(exec_err_pipe_read)\\n\\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\\n # child successfully performed exec, since close-on-exec made\\n # successful exec close the writing end of the pipe. Or, if exec\\n # failed, the parent reads the error code and can proceed\\n # accordingly. Either way, the parent blocks until the child calls\\n # exec.\\n if len(exec_err_data) != 0:\\n try:\\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\\n\\n exception = exctype(errmsg.decode('utf-8', 'replace'))\\n if exctype is OSError:\\n exception.errno = int(errno_s)\\n except:\\n raise Exception('Subprocess failed, got bad error data: %r'\\n % exec_err_data)\\n else:\\n raise exception\\n\\n try:\\n inst.setwinsize(*dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\\n raise\\n\\n return inst\\n\\n def __repr__(self):\\n clsname = type(self).__name__\\n if self.argv is not None:\\n args = [repr(self.argv)]\\n if self.env is not None:\\n args.append(\\\"env=%r\\\" % self.env)\\n if self.launch_dir is not None:\\n args.append(\\\"cwd=%r\\\" % self.launch_dir)\\n \\n return \\\"{}.spawn({})\\\".format(clsname, \\\", \\\".join(args))\\n \\n else:\\n return \\\"{}(pid={}, fd={})\\\".format(clsname, self.pid, self.fd)\\n\\n @staticmethod\\n def _coerce_send_string(s):\\n if not isinstance(s, bytes):\\n return s.encode('utf-8')\\n return s\\n\\n @staticmethod\\n def _coerce_read_string(s):\\n return s\\n\\n def __del__(self):\\n '''This makes sure that no system resources are left open. Python only\\n garbage collects Python objects. OS file descriptors are not Python\\n objects, so they must be handled explicitly. If the child file\\n descriptor was opened outside of this class (passed to the constructor)\\n then this does not close it. '''\\n\\n if not self.closed:\\n # It is possible for __del__ methods to execute during the\\n # teardown of the Python VM itself. Thus self.close() may\\n # trigger an exception because os.close may be None.\\n try:\\n self.close()\\n # which exception, shouldn't we catch explicitly .. ?\\n except:\\n pass\\n\\n\\n def fileno(self):\\n '''This returns the file descriptor of the pty for the child.\\n '''\\n return self.fd\\n\\n def close(self, force=True):\\n '''This closes the connection with the child application. Note that\\n calling close() more than once is valid. This emulates standard Python\\n behavior with files. Set force to True if you want to make sure that\\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\\n and SIGINT). '''\\n if not self.closed:\\n self.flush()\\n self.fileobj.close() # Closes the file descriptor\\n # Give kernel time to update process status.\\n time.sleep(self.delayafterclose)\\n if self.isalive():\\n if not self.terminate(force):\\n raise PtyProcessError('Could not terminate the child.')\\n self.fd = -1\\n self.closed = True\\n #self.pid = None\\n\\n def flush(self):\\n '''This does nothing. It is here to support the interface for a\\n File-like object. '''\\n\\n pass\\n\\n def isatty(self):\\n '''This returns True if the file descriptor is open and connected to a\\n tty(-like) device, else False.\\n\\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\\n the child pty may not appear as a terminal device. This means\\n methods such as setecho(), setwinsize(), getwinsize() may raise an\\n IOError. '''\\n\\n return os.isatty(self.fd)\\n\\n def waitnoecho(self, timeout=None):\\n '''Wait until the terminal ECHO flag is set False.\\n\\n This returns True if the echo mode is off, or False if echo was not\\n disabled before the timeout. This can be used to detect when the\\n child is waiting for a password. Usually a child application will turn\\n off echo mode when it is waiting for the user to enter a password. For\\n example, instead of expecting the \\\"password:\\\" prompt you can wait for\\n the child to turn echo off::\\n\\n p = pexpect.spawn('ssh user@example.com')\\n p.waitnoecho()\\n p.sendline(mypassword)\\n\\n If ``timeout=None`` then this method to block until ECHO flag is False.\\n '''\\n\\n if timeout is not None:\\n end_time = time.time() + timeout\\n while True:\\n if not self.getecho():\\n return True\\n if timeout < 0 and timeout is not None:\\n return False\\n if timeout is not None:\\n timeout = end_time - time.time()\\n time.sleep(0.1)\\n\\n def getecho(self):\\n '''Returns True if terminal echo is on, or False if echo is off.\\n\\n Child applications that are expecting you to enter a password often\\n disable echo. See also :meth:`waitnoecho`.\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n\\n try:\\n attr = termios.tcgetattr(self.fd)\\n except termios.error as err:\\n errmsg = 'getecho() may not be called on this platform'\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n self.echo = bool(attr[3] & termios.ECHO)\\n return self.echo\\n\\n def setecho(self, state):\\n '''Enable or disable terminal echo.\\n\\n Anything the child sent before the echo will be lost, so you should be\\n sure that your input buffer is empty before you call setecho().\\n For example, the following will work as expected::\\n\\n p = pexpect.spawn('cat') # Echo is on by default.\\n p.sendline('1234') # We expect see this twice from the child...\\n p.expect(['1234']) # ... once from the tty echo...\\n p.expect(['1234']) # ... and again from cat itself.\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n The following WILL NOT WORK because the lines sent before the setecho\\n will be lost::\\n\\n p = pexpect.spawn('cat')\\n p.sendline('1234')\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['1234'])\\n p.expect(['1234'])\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n _setecho(self.fd, state)\\n\\n self.echo = state\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read and return at most ``size`` bytes from the pty.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\\n with the vagaries of EOF on platforms that do strange things, like IRIX\\n or older Solaris systems. It handles the errno=EIO pattern used on\\n Linux, and the empty-string return used on BSD platforms and (seemingly)\\n on recent Solaris.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.read1(size)\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.readline()\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def _writeb(self, b, flush=True):\\n n = self.fileobj.write(b)\\n if flush:\\n self.fileobj.flush()\\n return n\\n\\n def write(self, s, flush=True):\\n \\\"\\\"\\\"Write bytes to the pseudoterminal.\\n \\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n return self._writeb(s, flush=flush)\\n\\n def sendcontrol(self, char):\\n '''Helper method for sending control characters to the terminal.\\n\\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\\\\\a'``)::\\n\\n child.sendcontrol('g')\\n\\n See also, :meth:`sendintr` and :meth:`sendeof`.\\n '''\\n char = char.lower()\\n a = ord(char)\\n if 97 <= a <= 122:\\n a = a - ord('a') + 1\\n byte = _byte(a)\\n return self._writeb(byte), byte\\n d = {'@': 0, '`': 0,\\n '[': 27, '{': 27,\\n '\\\\\\\\': 28, '|': 28,\\n ']': 29, '}': 29,\\n '^': 30, '~': 30,\\n '_': 31,\\n '?': 127}\\n if char not in d:\\n return 0, b''\\n\\n byte = _byte(d[char])\\n return self._writeb(byte), byte\\n\\n def sendeof(self):\\n '''Sends an EOF (typically Ctrl-D) through the terminal.\\n\\n This sends a character which causes\\n the pending parent output buffer to be sent to the waiting child\\n program without waiting for end-of-line. If it is the first character\\n of the line, the read() in the user program returns 0, which signifies\\n end-of-file. This means to work as expected a sendeof() has to be\\n called at the beginning of a line. This method does not send a newline.\\n It is the responsibility of the caller to ensure the eof is sent at the\\n beginning of a line.\\n '''\\n return self._writeb(_EOF), _EOF\\n\\n def sendintr(self):\\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\\n\\n This will normally trigger the kernel to send SIGINT to the current\\n foreground process group. Processes can turn off this translation, in\\n which case they can read the raw data sent, e.g. ``b'\\\\\\\\x03'`` for Ctrl-C.\\n\\n See also the :meth:`kill` method, which sends a signal directly to the\\n immediate child process in the terminal (which is not necessarily the\\n foreground process).\\n '''\\n return self._writeb(_INTR), _INTR\\n\\n def eof(self):\\n '''This returns True if the EOF exception was ever raised.\\n '''\\n\\n return self.flag_eof\\n\\n def terminate(self, force=False):\\n '''This forces a child process to terminate. It starts nicely with\\n SIGHUP and SIGINT. If \\\"force\\\" is True then moves onto SIGKILL. This\\n returns True if the child was terminated. This returns False if the\\n child could not be terminated. '''\\n\\n if not self.isalive():\\n return True\\n try:\\n self.kill(signal.SIGHUP)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGCONT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGINT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n if force:\\n self.kill(signal.SIGKILL)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n return False\\n except OSError:\\n # I think there are kernel timing issues that sometimes cause\\n # this to happen. I think isalive() reports True, but the\\n # process is dead to the kernel.\\n # Make one last attempt to see if the kernel is up to date.\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n\\n def wait(self):\\n '''This waits until the child exits. This is a blocking call. This will\\n not read any data from the child, so this will block forever if the\\n child has unread output and has terminated. In other words, the child\\n may have printed output then called exit(), but, the child is\\n technically still alive until its output is read by the parent. '''\\n\\n if self.isalive():\\n pid, status = os.waitpid(self.pid, 0)\\n else:\\n return self.exitstatus\\n self.exitstatus = os.WEXITSTATUS(status)\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status): # pragma: no cover\\n # You can't call wait() on a child process in the stopped state.\\n raise PtyProcessError('Called wait() on a stopped child ' +\\n 'process. This is not supported. Is some other ' +\\n 'process attempting job control with our child pid?')\\n return self.exitstatus\\n\\n def isalive(self):\\n '''This tests if the child process is running or not. This is\\n non-blocking. If the child was terminated then this will read the\\n exitstatus or signalstatus of the child. This returns True if the child\\n process appears to be running or False if not. It can take literally\\n SECONDS for Solaris to return the right status. '''\\n\\n if self.terminated:\\n return False\\n\\n if self.flag_eof:\\n # This is for Linux, which requires the blocking form\\n # of waitpid to get the status of a defunct process.\\n # This is super-lame. The flag_eof would have been set\\n # in read_nonblocking(), so this should be safe.\\n waitpid_options = 0\\n else:\\n waitpid_options = os.WNOHANG\\n\\n try:\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e:\\n # No child processes\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where \\\"terminated\\\" is 0, but there was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # I have to do this twice for Solaris.\\n # I can't even believe that I figured this out...\\n # If waitpid() returns 0 it means that no child process\\n # wishes to report, and the value of status is undefined.\\n if pid == 0:\\n try:\\n ### os.WNOHANG) # Solaris!\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e: # pragma: no cover\\n # This should never happen...\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'that should never happen. There was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # If pid is still 0 after two calls to waitpid() then the process\\n # really is alive. This seems to work on all platforms, except for\\n # Irix which seems to require a blocking call on waitpid or select,\\n # so I let read_nonblocking take care of this situation\\n # (unfortunately, this requires waiting through the timeout).\\n if pid == 0:\\n return True\\n\\n if pid == 0:\\n return True\\n\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status):\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where child process is stopped. This is not ' +\\n 'supported. Is some other process attempting ' +\\n 'job control with our child pid?')\\n return False\\n\\n def kill(self, sig):\\n \\\"\\\"\\\"Send the given signal to the child application.\\n\\n In keeping with UNIX tradition it has a misleading name. It does not\\n necessarily kill the child unless you send the right signal. See the\\n :mod:`signal` module for constants representing signal numbers.\\n \\\"\\\"\\\"\\n\\n # Same as os.kill, but the pid is given for you.\\n if self.isalive():\\n os.kill(self.pid, sig)\\n\\n def getwinsize(self):\\n \\\"\\\"\\\"Return the window size of the pseudoterminal as a tuple (rows, cols).\\n \\\"\\\"\\\"\\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\\n s = struct.pack('HHHH', 0, 0, 0, 0)\\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\\n return struct.unpack('HHHH', x)[0:2]\\n\\n def setwinsize(self, rows, cols):\\n \\\"\\\"\\\"Set the terminal window size of the child tty.\\n\\n This will cause a SIGWINCH signal to be sent to the child. This does not\\n change the physical window size. It changes the size reported to\\n TTY-aware applications like vi or curses -- applications that respond to\\n the SIGWINCH signal.\\n \\\"\\\"\\\"\\n return _setwinsize(self.fd, rows, cols)\\n\\n\\nclass PtyProcessUnicode(PtyProcess):\\n \\\"\\\"\\\"Unicode wrapper around a process running in a pseudoterminal.\\n\\n This class exposes a similar interface to :class:`PtyProcess`, but its read\\n methods return unicode, and its :meth:`write` accepts unicode.\\n \\\"\\\"\\\"\\n if PY3:\\n string_type = str\\n else:\\n string_type = unicode # analysis:ignore\\n\\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\\n super(PtyProcessUnicode, self).__init__(pid, fd)\\n self.encoding = encoding\\n self.codec_errors = codec_errors\\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read at most ``size`` bytes from the pty, return them as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n\\n The size argument still refers to bytes, not unicode code points.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).read(size)\\n return self.decoder.decode(b, final=False)\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).readline()\\n return self.decoder.decode(b, final=False)\\n\\n def write(self, s):\\n \\\"\\\"\\\"Write the unicode string ``s`` to the pseudoterminal.\\n\\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n b = s.encode(self.encoding)\\n return super(PtyProcessUnicode, self).write(b)\\n\\n[end of ptyprocess/ptyprocess.py]\",\n \"filename\": \"ptyprocess/ptyprocess.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Run a subprocess in a pseudo terminal\\\"\\\"\\\"\\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\\n\\n__version__ = '0.7.0'\\n\\n[end of ptyprocess/__init__.py]\",\n \"filename\": \"ptyprocess/__init__.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"no\\\"?>\\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\\n\\n<svg\\n xmlns:dc=\\\"http://purl.org/dc/elements/1.1/\\\"\\n xmlns:cc=\\\"http://creativecommons.org/ns#\\\"\\n xmlns:rdf=\\\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\\\"\\n xmlns:svg=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns:sodipodi=\\\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\\\"\\n xmlns:inkscape=\\\"http://www.inkscape.org/namespaces/inkscape\\\"\\n width=\\\"554.44196\\\"\\n height=\\\"327.38452\\\"\\n id=\\\"svg2\\\"\\n version=\\\"1.1\\\"\\n inkscape:version=\\\"0.48.4 r9939\\\"\\n sodipodi:docname=\\\"pty_vs_popen.svg\\\">\\n <defs\\n id=\\\"defs4\\\">\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3838\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3783\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(1.1,0,0,1.1,1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Tail\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Tail\\\"\\n style=\\\"overflow:visible\\\">\\n <g\\n id=\\\"g3801\\\"\\n transform=\\\"scale(-1.2,-1.2)\\\">\\n <path\\n id=\\\"path3803\\\"\\n d=\\\"M -3.8048674,-3.9585227 0.54352094,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3805\\\"\\n d=\\\"M -1.2866832,-3.9585227 3.0617053,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3807\\\"\\n d=\\\"M 1.3053582,-3.9585227 5.6537466,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3809\\\"\\n d=\\\"M -3.8048674,4.1775838 0.54352094,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3811\\\"\\n d=\\\"M -1.2866832,4.1775838 3.0617053,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3813\\\"\\n d=\\\"M 1.3053582,4.1775838 5.6537466,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </g>\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3765\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(0.8,0,0,0.8,10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3786\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3768\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(-0.8,0,0,-0.8,-10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-9\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-2\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-6\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-27\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM-5\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3838-7\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10742\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10744\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10746\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10748\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10750\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10752\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10754\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10756\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10758\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10760\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n </defs>\\n <sodipodi:namedview\\n id=\\\"base\\\"\\n pagecolor=\\\"#ffffff\\\"\\n bordercolor=\\\"#666666\\\"\\n borderopacity=\\\"1.0\\\"\\n inkscape:pageopacity=\\\"0.0\\\"\\n inkscape:pageshadow=\\\"2\\\"\\n inkscape:zoom=\\\"0.98994949\\\"\\n inkscape:cx=\\\"77.797977\\\"\\n inkscape:cy=\\\"137.24456\\\"\\n inkscape:document-units=\\\"px\\\"\\n inkscape:current-layer=\\\"layer1\\\"\\n showgrid=\\\"false\\\"\\n inkscape:window-width=\\\"1301\\\"\\n inkscape:window-height=\\\"744\\\"\\n inkscape:window-x=\\\"65\\\"\\n inkscape:window-y=\\\"24\\\"\\n inkscape:window-maximized=\\\"1\\\"\\n fit-margin-top=\\\"1\\\"\\n fit-margin-left=\\\"1\\\"\\n fit-margin-right=\\\"1\\\"\\n fit-margin-bottom=\\\"1\\\"\\n units=\\\"cm\\\" />\\n <metadata\\n id=\\\"metadata7\\\">\\n <rdf:RDF>\\n <cc:Work\\n rdf:about=\\\"\\\">\\n <dc:format>image/svg+xml</dc:format>\\n <dc:type\\n rdf:resource=\\\"http://purl.org/dc/dcmitype/StillImage\\\" />\\n <dc:title></dc:title>\\n </cc:Work>\\n </rdf:RDF>\\n </metadata>\\n <g\\n inkscape:label=\\\"Layer 1\\\"\\n inkscape:groupmode=\\\"layer\\\"\\n id=\\\"layer1\\\"\\n transform=\\\"translate(-40.758533,29.820888)\\\">\\n <g\\n id=\\\"g11880\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591\\\"\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n id=\\\"tspan10593\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <g\\n id=\\\"g10626\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991\\\"\\n d=\\\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7\\\"\\n d=\\\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\\\"\\n id=\\\"path2991-7-8\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5637\\\"\\n d=\\\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5641\\\"\\n d=\\\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5643\\\"\\n d=\\\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n id=\\\"tspan6247\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(18,0)\\\"\\n id=\\\"g11773\\\">\\n <g\\n id=\\\"g11763\\\">\\n <rect\\n y=\\\"120.8597\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308\\\"\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n id=\\\"tspan6310\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g11768\\\">\\n <rect\\n y=\\\"135.43114\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304\\\"\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n id=\\\"tspan6306\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(54,-16)\\\"\\n id=\\\"g10674\\\">\\n <g\\n id=\\\"g10664\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(86.857134,-15.571435)\\\"\\n id=\\\"g10674-6\\\">\\n <g\\n id=\\\"g10664-6\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0-5\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-9\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7-6\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669-5\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5-3\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6-1\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n id=\\\"tspan10728\\\"\\n sodipodi:role=\\\"line\\\">Popen</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-89\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-24\\\"\\n style=\\\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n sodipodi:role=\\\"line\\\">pipes</tspan></text>\\n </g>\\n <g\\n id=\\\"g11847\\\"\\n transform=\\\"translate(-10,0.39179)\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328-0\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-8\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591-3\\\"\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n id=\\\"tspan10593-2\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path11075\\\"\\n d=\\\"m 397.80427,110.64896 0,-52.85714\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\\\" />\\n <g\\n id=\\\"g10626-5\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2-4\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334-0\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336-9\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-4\\\"\\n d=\\\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7-87\\\"\\n d=\\\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331-7\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\\\"\\n id=\\\"path2991-7-8-4\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-6\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n id=\\\"tspan6247-3\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-6\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-2\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8-1\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298-3\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(227.5656,-301.02546)\\\"\\n id=\\\"g11065\\\">\\n <g\\n id=\\\"g11055\\\">\\n <rect\\n y=\\\"421.34998\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55\\\"\\n style=\\\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6\\\"\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n id=\\\"tspan6310-7-9\\\"\\n sodipodi:role=\\\"line\\\">slave</tspan></text>\\n </g>\\n <g\\n id=\\\"g11060\\\">\\n <rect\\n y=\\\"407.25223\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55-9\\\"\\n style=\\\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6-7\\\"\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n id=\\\"tspan6310-7-9-7\\\"\\n sodipodi:role=\\\"line\\\">master</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726-9\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n id=\\\"tspan10728-7\\\"\\n sodipodi:role=\\\"line\\\">Pseudoterminal</tspan><tspan\\n id=\\\"tspan11761\\\"\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"136.71899\\\"\\n x=\\\"429.1268\\\"\\n sodipodi:role=\\\"line\\\">(pty)</tspan></text>\\n </g>\\n </g>\\n</svg>\\n\\n[end of docs/images/pty_vs_popen.svg]\",\n \"filename\": \"docs/images/pty_vs_popen.svg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"None\\n[end of docs/images/pty_vs_popen.png]\",\n \"filename\": \"docs/images/pty_vs_popen.png\",\n \"id\": \"13\"\n }\n]","isConversational":false}}},{"rowIdx":82,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 82,\n \"num_files\": 14,\n \"repo_id\": \"repo_0082\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"python:\n version: 3\n\n[end of readthedocs.yml]","filename":"readthedocs.yml","id":"0"},{"content":"ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, Pexpect development team\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\n\n Permission to use, copy, modify, and/or distribute this software for any\n purpose with or without fee is hereby granted, provided that the above\n copyright notice and this permission notice appear in all copies.\n \n THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"[build-system]\nrequires = [\"flit_core >=2,<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.metadata]\nmodule = \"ptyprocess\"\nauthor = \"Thomas Kluyver\"\nauthor-email = \"thomas@kluyver.me.uk\"\nhome-page = \"https://github.com/pexpect/ptyprocess\"\ndescription-file = \"README.rst\"\nrequires-python = \">=3.7\"\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: ISC License (ISCL)\",\n \"Operating System :: POSIX\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Topic :: Terminals\"\n]\n\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"Launch a subprocess in a pseudo terminal (pty), and interact with both the\nprocess and its pty.\n\nSometimes, piping stdin and stdout is not enough. There might be a password\nprompt that doesn't read from stdin, output that changes when it's going to a\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\nIf you need to automate these things, running the process in a pseudo terminal\n(pty) is the answer.\n\nInterface:\n\n.. code:: python\n\n from ptyprocess import PtyProcessUnicode\n p = PtyProcessUnicode.spawn(['python'])\n p.read(20)\n p.write('6+6\\n')\n p.read(20)\n\n[end of README.rst]","filename":"README.rst","id":"3"},{"content":"Ptyprocess\n==========\n\n.. include:: ../README.rst\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n\n api\n\nWhat is a pty?\n--------------\n\nA pty is a kernel-level object which processes can write data to and read data\nfrom, a bit like a pipe.\n\nUnlike a pipe, data moves through a single pty in both directions. When you use\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\nto three pipes are created for the process's standard streams (stdin, stdout\nand stderr). When you run a program using ptyprocess, all three of its standard\nstreams are connected to a single pty:\n\n.. image:: images/pty_vs_popen.png\n\nA pty also does more than a pipe. It keeps track of the window size (rows and\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\nSIGINT to be sent to the child process.\n\nMany command line programs behave differently if they detect that stdin or stdout\nis connected to a terminal instead of a pipe (using \n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\nthat they're being used interactively by a human user.\nThey may format output differently (e.g. ``ls`` lists files in columns)\nor prompt the user to confirm actions.\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\n\n.. seealso::\n\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\n Detailed article by Linus Akesson\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"4"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = _build\n\n# User-friendly check for sphinx-build\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\nendif\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" xml to make Docutils-native XML files\"\n\t@echo \" pseudoxml to make pseudoxml-XML files for display purposes\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\trm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\nlatexpdfja:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through platex and dvipdfmx...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\nxml:\n\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\n\t@echo\n\t@echo \"Build finished. The XML files are in $(BUILDDIR)/xml.\"\n\npseudoxml:\n\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\n\t@echo\n\t@echo \"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\"\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"5"},{"content":"# -*- coding: utf-8 -*-\n#\n# Ptyprocess documentation build configuration file, created by\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\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\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.insert(0, os.path.abspath('..'))\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.viewcode',\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'Ptyprocess'\ncopyright = u'2014, Thomas Kluyver'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.7'\n# The full version, including alpha/beta/rc tags.\nrelease = version #+ '.2'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\n\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#html_extra_path = []\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'Ptyprocessdoc'\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\n [u'Thomas Kluyver'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {'http://docs.python.org/': None}\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"6"},{"content":"Ptyprocess API\n==============\n\n.. module:: ptyprocess\n\n.. autoclass:: PtyProcess\n\n .. automethod:: spawn\n\n .. automethod:: read\n\n .. automethod:: readline\n\n .. automethod:: write\n\n .. automethod:: sendcontrol\n\n .. automethod:: sendeof\n\n .. automethod:: sendintr\n\n .. automethod:: getecho\n\n .. automethod:: waitnoecho\n\n .. automethod:: setecho\n\n .. automethod:: getwinsize\n\n .. automethod:: setwinsize\n\n .. automethod:: eof\n\n .. automethod:: isalive\n\n .. automethod:: wait\n\n .. automethod:: kill\n\n .. automethod:: terminate\n\n .. automethod:: close\n\n.. autoclass:: PtyProcessUnicode\n\n[end of docs/api.rst]","filename":"docs/api.rst","id":"7"},{"content":"try:\n from shutil import which # Python >= 3.3\nexcept ImportError:\n import os, sys\n \n # This is copied from Python 3.4.1\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\n \"\"\"Given a command, mode, and a PATH string, return the path which\n conforms to the given mode on the PATH, or None if there is no such\n file.\n \n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\n of os.environ.get(\"PATH\"), or can be overridden with a custom search\n path.\n \n \"\"\"\n # Check that a given file can be accessed with the correct mode.\n # Additionally check that `file` is not a directory, as on Windows\n # directories pass the os.access check.\n def _access_check(fn, mode):\n return (os.path.exists(fn) and os.access(fn, mode)\n and not os.path.isdir(fn))\n \n # If we're given a path with a directory part, look it up directly rather\n # than referring to PATH directories. This includes checking relative to the\n # current directory, e.g. ./script\n if os.path.dirname(cmd):\n if _access_check(cmd, mode):\n return cmd\n return None\n \n if path is None:\n path = os.environ.get(\"PATH\", os.defpath)\n if not path:\n return None\n path = path.split(os.pathsep)\n \n if sys.platform == \"win32\":\n # The current directory takes precedence on Windows.\n if not os.curdir in path:\n path.insert(0, os.curdir)\n \n # PATHEXT is necessary to check on Windows.\n pathext = os.environ.get(\"PATHEXT\", \"\").split(os.pathsep)\n # See if the given file matches any of the expected path extensions.\n # This will allow us to short circuit when given \"python.exe\".\n # If it does match, only test that one, otherwise we have to try\n # others.\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\n files = [cmd]\n else:\n files = [cmd + ext for ext in pathext]\n else:\n # On other platforms you don't have things like PATHEXT to tell you\n # what file suffixes are executable, so just pass on cmd as-is.\n files = [cmd]\n \n seen = set()\n for dir in path:\n normdir = os.path.normcase(dir)\n if not normdir in seen:\n seen.add(normdir)\n for thefile in files:\n name = os.path.join(dir, thefile)\n if _access_check(name, mode):\n return name\n return None\n\n\nclass PtyProcessError(Exception):\n \"\"\"Generic error class for this package.\"\"\"\n\n[end of ptyprocess/util.py]","filename":"ptyprocess/util.py","id":"8"},{"content":"\"\"\"Substitute for the forkpty system call, to support Solaris.\n\"\"\"\nimport os\nimport errno\n\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\nfrom .util import PtyProcessError\n\ndef fork_pty():\n '''This implements a substitute for the forkpty system call. This\n should be more portable than the pty.fork() function. Specifically,\n this should work on Solaris.\n\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\n resolve the issue with Python's pty.fork() not supporting Solaris,\n particularly ssh. Based on patch to posixmodule.c authored by Noah\n Spurrier::\n\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\n\n '''\n\n parent_fd, child_fd = os.openpty()\n if parent_fd < 0 or child_fd < 0:\n raise OSError(\"os.openpty() failed\")\n\n pid = os.fork()\n if pid == CHILD:\n # Child.\n os.close(parent_fd)\n pty_make_controlling_tty(child_fd)\n\n os.dup2(child_fd, STDIN_FILENO)\n os.dup2(child_fd, STDOUT_FILENO)\n os.dup2(child_fd, STDERR_FILENO)\n\n else:\n # Parent.\n os.close(child_fd)\n\n return pid, parent_fd\n\ndef pty_make_controlling_tty(tty_fd):\n '''This makes the pseudo-terminal the controlling tty. This should be\n more portable than the pty.fork() function. Specifically, this should\n work on Solaris. '''\n\n child_name = os.ttyname(tty_fd)\n\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\n # if there was no controlling tty to begin with, such as when\n # executed by a cron(1) job.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n os.setsid()\n\n # Verify we are disconnected from controlling tty by attempting to open\n # it again. We expect that OSError of ENXIO should always be raised.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n raise PtyProcessError(\"OSError of errno.ENXIO should be raised.\")\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n # Verify we can open child pty.\n fd = os.open(child_name, os.O_RDWR)\n os.close(fd)\n\n # Verify we now have a controlling tty.\n fd = os.open(\"/dev/tty\", os.O_WRONLY)\n os.close(fd)\n\n[end of ptyprocess/_fork_pty.py]","filename":"ptyprocess/_fork_pty.py","id":"9"},{"content":"import codecs\nimport errno\nimport fcntl\nimport io\nimport os\nimport pty\nimport resource\nimport signal\nimport struct\nimport sys\nimport termios\nimport time\n\ntry:\n import builtins # Python 3\nexcept ImportError:\n import __builtin__ as builtins # Python 2\n\n# Constants\nfrom pty import (STDIN_FILENO, CHILD)\n\nfrom .util import which, PtyProcessError\n\n_platform = sys.platform.lower()\n\n# Solaris uses internal __fork_pty(). All others use pty.fork().\n_is_solaris = (\n _platform.startswith('solaris') or\n _platform.startswith('sunos'))\n\nif _is_solaris:\n use_native_pty_fork = False\n from . import _fork_pty\nelse:\n use_native_pty_fork = True\n\nPY3 = sys.version_info[0] >= 3\n\nif PY3:\n def _byte(i):\n return bytes([i])\nelse:\n def _byte(i):\n return chr(i)\n \n class FileNotFoundError(OSError): pass\n class TimeoutError(OSError): pass\n\n_EOF, _INTR = None, None\n\ndef _make_eof_intr():\n \"\"\"Set constants _EOF and _INTR.\n \n This avoids doing potentially costly operations on module load.\n \"\"\"\n global _EOF, _INTR\n if (_EOF is not None) and (_INTR is not None):\n return\n\n # inherit EOF and INTR definitions from controlling process.\n try:\n from termios import VEOF, VINTR\n fd = None\n for name in 'stdin', 'stdout':\n stream = getattr(sys, '__%s__' % name, None)\n if stream is None or not hasattr(stream, 'fileno'):\n continue\n try:\n fd = stream.fileno()\n except ValueError:\n continue\n if fd is None:\n # no fd, raise ValueError to fallback on CEOF, CINTR\n raise ValueError(\"No stream has a fileno\")\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\n except (ImportError, OSError, IOError, ValueError, termios.error):\n # unless the controlling process is also not a terminal,\n # such as cron(1), or when stdin and stdout are both closed.\n # Fall-back to using CEOF and CINTR. There\n try:\n from termios import CEOF, CINTR\n (intr, eof) = (CINTR, CEOF)\n except ImportError:\n # ^C, ^D\n (intr, eof) = (3, 4)\n \n _INTR = _byte(intr)\n _EOF = _byte(eof)\n\n# setecho and setwinsize are pulled out here because on some platforms, we need\n# to do this from the child before we exec()\n \ndef _setecho(fd, state):\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\n\n try:\n attr = termios.tcgetattr(fd)\n except termios.error as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n if state:\n attr[3] = attr[3] | termios.ECHO\n else:\n attr[3] = attr[3] & ~termios.ECHO\n\n try:\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\n # blocked on some platforms. TCSADRAIN would probably be ideal.\n termios.tcsetattr(fd, termios.TCSANOW, attr)\n except IOError as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\ndef _setwinsize(fd, rows, cols):\n # Some very old platforms have a bug that causes the value for\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\n # around this, but it caused problems with newer platforms so has been\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\n # Note, assume ws_xpixel and ws_ypixel are zero.\n s = struct.pack('HHHH', rows, cols, 0, 0)\n fcntl.ioctl(fd, TIOCSWINSZ, s)\n\nclass PtyProcess(object):\n '''This class represents a process running in a pseudoterminal.\n \n The main constructor is the :meth:`spawn` classmethod.\n '''\n string_type = bytes\n if PY3:\n linesep = os.linesep.encode('ascii')\n crlf = '\\r\\n'.encode('ascii')\n\n @staticmethod\n def write_to_stdout(b):\n try:\n return sys.stdout.buffer.write(b)\n except AttributeError:\n # If stdout has been replaced, it may not have .buffer\n return sys.stdout.write(b.decode('ascii', 'replace'))\n else:\n linesep = os.linesep\n crlf = '\\r\\n'\n write_to_stdout = sys.stdout.write\n\n encoding = None\n \n argv = None\n env = None\n launch_dir = None\n\n def __init__(self, pid, fd):\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\n self.pid = pid\n self.fd = fd\n readf = io.open(fd, 'rb', buffering=0)\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\n self.fileobj = io.BufferedRWPair(readf, writef)\n\n self.terminated = False\n self.closed = False\n self.exitstatus = None\n self.signalstatus = None\n # status returned by os.waitpid\n self.status = None\n self.flag_eof = False\n # Used by close() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterclose = 0.1\n # Used by terminate() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterterminate = 0.1\n\n @classmethod\n def spawn(\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\n dimensions=(24, 80), pass_fds=()):\n '''Start the given command in a child process in a pseudo terminal.\n\n This does all the fork/exec type of stuff for a pty, and returns an\n instance of PtyProcess.\n\n If preexec_fn is supplied, it will be called with no arguments in the\n child process before exec-ing the specified command.\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\n\n Dimensions of the psuedoterminal used for the subprocess can be\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\n\n By default, all file descriptors except 0, 1 and 2 are closed. This\n behavior can be overridden with pass_fds, a list of file descriptors to\n keep open between the parent and the child.\n '''\n # Note that it is difficult for this method to fail.\n # You cannot detect if the child process cannot start.\n # So the only way you can tell if the child process started\n # or not is to try to read from the file descriptor. If you get\n # EOF immediately then it means that the child is already dead.\n # That may not necessarily be bad because you may have spawned a child\n # that performs some task; creates no stdout output; and then dies.\n\n if not isinstance(argv, (list, tuple)):\n raise TypeError(\"Expected a list or tuple for argv, got %r\" % argv)\n\n # Shallow copy of argv so we can modify it\n argv = argv[:]\n command = argv[0]\n\n command_with_path = which(command)\n if command_with_path is None:\n raise FileNotFoundError('The command was not found or was not ' +\n 'executable: %s.' % command)\n command = command_with_path\n argv[0] = command\n\n # [issue #119] To prevent the case where exec fails and the user is\n # stuck interacting with a python child process instead of whatever\n # was expected, we implement the solution from\n # http://stackoverflow.com/a/3703179 to pass the exception to the\n # parent process\n\n # [issue #119] 1. Before forking, open a pipe in the parent process.\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\n\n if use_native_pty_fork:\n pid, fd = pty.fork()\n else:\n # Use internal fork_pty, for Solaris\n pid, fd = _fork_pty.fork_pty()\n\n # Some platforms must call setwinsize() and setecho() from the\n # child process, and others from the master process. We do both,\n # allowing IOError for either.\n\n if pid == CHILD:\n # set window size\n try:\n _setwinsize(STDIN_FILENO, *dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # disable echo if spawn argument echo was unset\n if not echo:\n try:\n _setecho(STDIN_FILENO, False)\n except (IOError, termios.error) as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # [issue #119] 3. The child closes the reading end and sets the\n # close-on-exec flag for the writing end.\n os.close(exec_err_pipe_read)\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\n\n # Do not allow child to inherit open file descriptors from parent,\n # with the exception of the exec_err_pipe_write of the pipe\n # and pass_fds.\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\n # occasionally raises out of range error\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\n os.closerange(pair[0]+1, pair[1])\n\n if cwd is not None:\n os.chdir(cwd)\n\n if preexec_fn is not None:\n try:\n preexec_fn()\n except Exception as e:\n ename = type(e).__name__\n tosend = '{}:0:{}'.format(ename, str(e))\n if PY3:\n tosend = tosend.encode('utf-8')\n\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(1)\n\n try:\n if env is None:\n os.execv(command, argv)\n else:\n os.execvpe(command, argv, env)\n except OSError as err:\n # [issue #119] 5. If exec fails, the child writes the error\n # code back to the parent using the pipe, then exits.\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\n if PY3:\n tosend = tosend.encode('utf-8')\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(os.EX_OSERR)\n\n # Parent\n inst = cls(pid, fd)\n \n # Set some informational attributes\n inst.argv = argv\n if env is not None:\n inst.env = env\n if cwd is not None:\n inst.launch_dir = cwd\n\n # [issue #119] 2. After forking, the parent closes the writing end\n # of the pipe and reads from the reading end.\n os.close(exec_err_pipe_write)\n exec_err_data = os.read(exec_err_pipe_read, 4096)\n os.close(exec_err_pipe_read)\n\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\n # child successfully performed exec, since close-on-exec made\n # successful exec close the writing end of the pipe. Or, if exec\n # failed, the parent reads the error code and can proceed\n # accordingly. Either way, the parent blocks until the child calls\n # exec.\n if len(exec_err_data) != 0:\n try:\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\n\n exception = exctype(errmsg.decode('utf-8', 'replace'))\n if exctype is OSError:\n exception.errno = int(errno_s)\n except:\n raise Exception('Subprocess failed, got bad error data: %r'\n % exec_err_data)\n else:\n raise exception\n\n try:\n inst.setwinsize(*dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\n raise\n\n return inst\n\n def __repr__(self):\n clsname = type(self).__name__\n if self.argv is not None:\n args = [repr(self.argv)]\n if self.env is not None:\n args.append(\"env=%r\" % self.env)\n if self.launch_dir is not None:\n args.append(\"cwd=%r\" % self.launch_dir)\n \n return \"{}.spawn({})\".format(clsname, \", \".join(args))\n \n else:\n return \"{}(pid={}, fd={})\".format(clsname, self.pid, self.fd)\n\n @staticmethod\n def _coerce_send_string(s):\n if not isinstance(s, bytes):\n return s.encode('utf-8')\n return s\n\n @staticmethod\n def _coerce_read_string(s):\n return s\n\n def __del__(self):\n '''This makes sure that no system resources are left open. Python only\n garbage collects Python objects. OS file descriptors are not Python\n objects, so they must be handled explicitly. If the child file\n descriptor was opened outside of this class (passed to the constructor)\n then this does not close it. '''\n\n if not self.closed:\n # It is possible for __del__ methods to execute during the\n # teardown of the Python VM itself. Thus self.close() may\n # trigger an exception because os.close may be None.\n try:\n self.close()\n # which exception, shouldn't we catch explicitly .. ?\n except:\n pass\n\n\n def fileno(self):\n '''This returns the file descriptor of the pty for the child.\n '''\n return self.fd\n\n def close(self, force=True):\n '''This closes the connection with the child application. Note that\n calling close() more than once is valid. This emulates standard Python\n behavior with files. Set force to True if you want to make sure that\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\n and SIGINT). '''\n if not self.closed:\n self.flush()\n self.fileobj.close() # Closes the file descriptor\n # Give kernel time to update process status.\n time.sleep(self.delayafterclose)\n if self.isalive():\n if not self.terminate(force):\n raise PtyProcessError('Could not terminate the child.')\n self.fd = -1\n self.closed = True\n #self.pid = None\n\n def flush(self):\n '''This does nothing. It is here to support the interface for a\n File-like object. '''\n\n pass\n\n def isatty(self):\n '''This returns True if the file descriptor is open and connected to a\n tty(-like) device, else False.\n\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\n the child pty may not appear as a terminal device. This means\n methods such as setecho(), setwinsize(), getwinsize() may raise an\n IOError. '''\n\n return os.isatty(self.fd)\n\n def waitnoecho(self, timeout=None):\n '''Wait until the terminal ECHO flag is set False.\n\n This returns True if the echo mode is off, or False if echo was not\n disabled before the timeout. This can be used to detect when the\n child is waiting for a password. Usually a child application will turn\n off echo mode when it is waiting for the user to enter a password. For\n example, instead of expecting the \"password:\" prompt you can wait for\n the child to turn echo off::\n\n p = pexpect.spawn('ssh user@example.com')\n p.waitnoecho()\n p.sendline(mypassword)\n\n If ``timeout=None`` then this method to block until ECHO flag is False.\n '''\n\n if timeout is not None:\n end_time = time.time() + timeout\n while True:\n if not self.getecho():\n return True\n if timeout < 0 and timeout is not None:\n return False\n if timeout is not None:\n timeout = end_time - time.time()\n time.sleep(0.1)\n\n def getecho(self):\n '''Returns True if terminal echo is on, or False if echo is off.\n\n Child applications that are expecting you to enter a password often\n disable echo. See also :meth:`waitnoecho`.\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n\n try:\n attr = termios.tcgetattr(self.fd)\n except termios.error as err:\n errmsg = 'getecho() may not be called on this platform'\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n self.echo = bool(attr[3] & termios.ECHO)\n return self.echo\n\n def setecho(self, state):\n '''Enable or disable terminal echo.\n\n Anything the child sent before the echo will be lost, so you should be\n sure that your input buffer is empty before you call setecho().\n For example, the following will work as expected::\n\n p = pexpect.spawn('cat') # Echo is on by default.\n p.sendline('1234') # We expect see this twice from the child...\n p.expect(['1234']) # ... once from the tty echo...\n p.expect(['1234']) # ... and again from cat itself.\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n The following WILL NOT WORK because the lines sent before the setecho\n will be lost::\n\n p = pexpect.spawn('cat')\n p.sendline('1234')\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['1234'])\n p.expect(['1234'])\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n _setecho(self.fd, state)\n\n self.echo = state\n\n def read(self, size=1024):\n \"\"\"Read and return at most ``size`` bytes from the pty.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\n with the vagaries of EOF on platforms that do strange things, like IRIX\n or older Solaris systems. It handles the errno=EIO pattern used on\n Linux, and the empty-string return used on BSD platforms and (seemingly)\n on recent Solaris.\n \"\"\"\n try:\n s = self.fileobj.read1(size)\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n try:\n s = self.fileobj.readline()\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def _writeb(self, b, flush=True):\n n = self.fileobj.write(b)\n if flush:\n self.fileobj.flush()\n return n\n\n def write(self, s, flush=True):\n \"\"\"Write bytes to the pseudoterminal.\n \n Returns the number of bytes written.\n \"\"\"\n return self._writeb(s, flush=flush)\n\n def sendcontrol(self, char):\n '''Helper method for sending control characters to the terminal.\n\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\a'``)::\n\n child.sendcontrol('g')\n\n See also, :meth:`sendintr` and :meth:`sendeof`.\n '''\n char = char.lower()\n a = ord(char)\n if 97 <= a <= 122:\n a = a - ord('a') + 1\n byte = _byte(a)\n return self._writeb(byte), byte\n d = {'@': 0, '`': 0,\n '[': 27, '{': 27,\n '\\\\': 28, '|': 28,\n ']': 29, '}': 29,\n '^': 30, '~': 30,\n '_': 31,\n '?': 127}\n if char not in d:\n return 0, b''\n\n byte = _byte(d[char])\n return self._writeb(byte), byte\n\n def sendeof(self):\n '''Sends an EOF (typically Ctrl-D) through the terminal.\n\n This sends a character which causes\n the pending parent output buffer to be sent to the waiting child\n program without waiting for end-of-line. If it is the first character\n of the line, the read() in the user program returns 0, which signifies\n end-of-file. This means to work as expected a sendeof() has to be\n called at the beginning of a line. This method does not send a newline.\n It is the responsibility of the caller to ensure the eof is sent at the\n beginning of a line.\n '''\n return self._writeb(_EOF), _EOF\n\n def sendintr(self):\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\n\n This will normally trigger the kernel to send SIGINT to the current\n foreground process group. Processes can turn off this translation, in\n which case they can read the raw data sent, e.g. ``b'\\\\x03'`` for Ctrl-C.\n\n See also the :meth:`kill` method, which sends a signal directly to the\n immediate child process in the terminal (which is not necessarily the\n foreground process).\n '''\n return self._writeb(_INTR), _INTR\n\n def eof(self):\n '''This returns True if the EOF exception was ever raised.\n '''\n\n return self.flag_eof\n\n def terminate(self, force=False):\n '''This forces a child process to terminate. It starts nicely with\n SIGHUP and SIGINT. If \"force\" is True then moves onto SIGKILL. This\n returns True if the child was terminated. This returns False if the\n child could not be terminated. '''\n\n if not self.isalive():\n return True\n try:\n self.kill(signal.SIGHUP)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGCONT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGINT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n if force:\n self.kill(signal.SIGKILL)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n return False\n except OSError:\n # I think there are kernel timing issues that sometimes cause\n # this to happen. I think isalive() reports True, but the\n # process is dead to the kernel.\n # Make one last attempt to see if the kernel is up to date.\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n\n def wait(self):\n '''This waits until the child exits. This is a blocking call. This will\n not read any data from the child, so this will block forever if the\n child has unread output and has terminated. In other words, the child\n may have printed output then called exit(), but, the child is\n technically still alive until its output is read by the parent. '''\n\n if self.isalive():\n pid, status = os.waitpid(self.pid, 0)\n else:\n return self.exitstatus\n self.exitstatus = os.WEXITSTATUS(status)\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status): # pragma: no cover\n # You can't call wait() on a child process in the stopped state.\n raise PtyProcessError('Called wait() on a stopped child ' +\n 'process. This is not supported. Is some other ' +\n 'process attempting job control with our child pid?')\n return self.exitstatus\n\n def isalive(self):\n '''This tests if the child process is running or not. This is\n non-blocking. If the child was terminated then this will read the\n exitstatus or signalstatus of the child. This returns True if the child\n process appears to be running or False if not. It can take literally\n SECONDS for Solaris to return the right status. '''\n\n if self.terminated:\n return False\n\n if self.flag_eof:\n # This is for Linux, which requires the blocking form\n # of waitpid to get the status of a defunct process.\n # This is super-lame. The flag_eof would have been set\n # in read_nonblocking(), so this should be safe.\n waitpid_options = 0\n else:\n waitpid_options = os.WNOHANG\n\n try:\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e:\n # No child processes\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'where \"terminated\" is 0, but there was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # I have to do this twice for Solaris.\n # I can't even believe that I figured this out...\n # If waitpid() returns 0 it means that no child process\n # wishes to report, and the value of status is undefined.\n if pid == 0:\n try:\n ### os.WNOHANG) # Solaris!\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e: # pragma: no cover\n # This should never happen...\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'that should never happen. There was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # If pid is still 0 after two calls to waitpid() then the process\n # really is alive. This seems to work on all platforms, except for\n # Irix which seems to require a blocking call on waitpid or select,\n # so I let read_nonblocking take care of this situation\n # (unfortunately, this requires waiting through the timeout).\n if pid == 0:\n return True\n\n if pid == 0:\n return True\n\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status):\n raise PtyProcessError('isalive() encountered condition ' +\n 'where child process is stopped. This is not ' +\n 'supported. Is some other process attempting ' +\n 'job control with our child pid?')\n return False\n\n def kill(self, sig):\n \"\"\"Send the given signal to the child application.\n\n In keeping with UNIX tradition it has a misleading name. It does not\n necessarily kill the child unless you send the right signal. See the\n :mod:`signal` module for constants representing signal numbers.\n \"\"\"\n\n # Same as os.kill, but the pid is given for you.\n if self.isalive():\n os.kill(self.pid, sig)\n\n def getwinsize(self):\n \"\"\"Return the window size of the pseudoterminal as a tuple (rows, cols).\n \"\"\"\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\n s = struct.pack('HHHH', 0, 0, 0, 0)\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\n return struct.unpack('HHHH', x)[0:2]\n\n def setwinsize(self, rows, cols):\n \"\"\"Set the terminal window size of the child tty.\n\n This will cause a SIGWINCH signal to be sent to the child. This does not\n change the physical window size. It changes the size reported to\n TTY-aware applications like vi or curses -- applications that respond to\n the SIGWINCH signal.\n \"\"\"\n return _setwinsize(self.fd, rows, cols)\n\n\nclass PtyProcessUnicode(PtyProcess):\n \"\"\"Unicode wrapper around a process running in a pseudoterminal.\n\n This class exposes a similar interface to :class:`PtyProcess`, but its read\n methods return unicode, and its :meth:`write` accepts unicode.\n \"\"\"\n if PY3:\n string_type = str\n else:\n string_type = unicode # analysis:ignore\n\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\n super(PtyProcessUnicode, self).__init__(pid, fd)\n self.encoding = encoding\n self.codec_errors = codec_errors\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\n\n def read(self, size=1024):\n \"\"\"Read at most ``size`` bytes from the pty, return them as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n\n The size argument still refers to bytes, not unicode code points.\n \"\"\"\n b = super(PtyProcessUnicode, self).read(size)\n return self.decoder.decode(b, final=False)\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n b = super(PtyProcessUnicode, self).readline()\n return self.decoder.decode(b, final=False)\n\n def write(self, s):\n \"\"\"Write the unicode string ``s`` to the pseudoterminal.\n\n Returns the number of bytes written.\n \"\"\"\n b = s.encode(self.encoding)\n return super(PtyProcessUnicode, self).write(b)\n\n[end of ptyprocess/ptyprocess.py]","filename":"ptyprocess/ptyprocess.py","id":"10"},{"content":"\"\"\"Run a subprocess in a pseudo terminal\"\"\"\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\n\n__version__ = '0.7.0'\n\n[end of ptyprocess/__init__.py]","filename":"ptyprocess/__init__.py","id":"11"},{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\n\n<svg\n xmlns:dc=\"http://purl.org/dc/elements/1.1/\"\n xmlns:cc=\"http://creativecommons.org/ns#\"\n xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n xmlns:svg=\"http://www.w3.org/2000/svg\"\n xmlns=\"http://www.w3.org/2000/svg\"\n xmlns:sodipodi=\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\"\n xmlns:inkscape=\"http://www.inkscape.org/namespaces/inkscape\"\n width=\"554.44196\"\n height=\"327.38452\"\n id=\"svg2\"\n version=\"1.1\"\n inkscape:version=\"0.48.4 r9939\"\n sodipodi:docname=\"pty_vs_popen.svg\">\n <defs\n id=\"defs4\">\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM\"\n style=\"overflow:visible\">\n <path\n id=\"path3838\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3783\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(1.1,0,0,1.1,1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Tail\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Tail\"\n style=\"overflow:visible\">\n <g\n id=\"g3801\"\n transform=\"scale(-1.2,-1.2)\">\n <path\n id=\"path3803\"\n d=\"M -3.8048674,-3.9585227 0.54352094,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3805\"\n d=\"M -1.2866832,-3.9585227 3.0617053,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3807\"\n d=\"M 1.3053582,-3.9585227 5.6537466,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3809\"\n d=\"M -3.8048674,4.1775838 0.54352094,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3811\"\n d=\"M -1.2866832,4.1775838 3.0617053,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3813\"\n d=\"M 1.3053582,4.1775838 5.6537466,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n </g>\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3765\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(0.8,0,0,0.8,10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3786\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3768\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(-0.8,0,0,-0.8,-10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-9\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-2\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-6\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-27\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM-5\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3838-7\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10742\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10744\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10746\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10748\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10750\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10752\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10754\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10756\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10758\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10760\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n </defs>\n <sodipodi:namedview\n id=\"base\"\n pagecolor=\"#ffffff\"\n bordercolor=\"#666666\"\n borderopacity=\"1.0\"\n inkscape:pageopacity=\"0.0\"\n inkscape:pageshadow=\"2\"\n inkscape:zoom=\"0.98994949\"\n inkscape:cx=\"77.797977\"\n inkscape:cy=\"137.24456\"\n inkscape:document-units=\"px\"\n inkscape:current-layer=\"layer1\"\n showgrid=\"false\"\n inkscape:window-width=\"1301\"\n inkscape:window-height=\"744\"\n inkscape:window-x=\"65\"\n inkscape:window-y=\"24\"\n inkscape:window-maximized=\"1\"\n fit-margin-top=\"1\"\n fit-margin-left=\"1\"\n fit-margin-right=\"1\"\n fit-margin-bottom=\"1\"\n units=\"cm\" />\n <metadata\n id=\"metadata7\">\n <rdf:RDF>\n <cc:Work\n rdf:about=\"\">\n <dc:format>image/svg+xml</dc:format>\n <dc:type\n rdf:resource=\"http://purl.org/dc/dcmitype/StillImage\" />\n <dc:title></dc:title>\n </cc:Work>\n </rdf:RDF>\n </metadata>\n <g\n inkscape:label=\"Layer 1\"\n inkscape:groupmode=\"layer\"\n id=\"layer1\"\n transform=\"translate(-40.758533,29.820888)\">\n <g\n id=\"g11880\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591\"\n y=\"240.97427\"\n x=\"138.65004\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.97427\"\n x=\"138.65004\"\n id=\"tspan10593\"\n sodipodi:role=\"line\">Child</tspan></text>\n <g\n id=\"g10626\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991\"\n d=\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7\"\n d=\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\"\n id=\"path2991-7-8\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5637\"\n d=\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5641\"\n d=\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5643\"\n d=\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245\"\n y=\"240.57648\"\n x=\"90\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.57648\"\n x=\"90\"\n id=\"tspan6247\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8\"\n y=\"213.07455\"\n x=\"184.47076\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"213.07455\"\n x=\"184.47076\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8\"\n y=\"262.00311\"\n x=\"192.32663\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"262.00311\"\n x=\"192.32663\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(18,0)\"\n id=\"g11773\">\n <g\n id=\"g11763\">\n <rect\n y=\"120.8597\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308\"\n y=\"129.96561\"\n x=\"63.277264\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"129.96561\"\n x=\"63.277264\"\n id=\"tspan6310\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g11768\">\n <rect\n y=\"135.43114\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304\"\n y=\"144.58977\"\n x=\"64.540932\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"144.58977\"\n x=\"64.540932\"\n id=\"tspan6306\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(54,-16)\"\n id=\"g10674\">\n <g\n id=\"g10664\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(86.857134,-15.571435)\"\n id=\"g10674-6\">\n <g\n id=\"g10664-6\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0-5\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-9\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7-6\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669-5\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5-3\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6-1\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726\"\n y=\"139.6479\"\n x=\"135.03683\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"139.6479\"\n x=\"135.03683\"\n id=\"tspan10728\"\n sodipodi:role=\"line\">Popen</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-89\"\n y=\"158.43169\"\n x=\"234.46947\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-24\"\n style=\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\"\n y=\"158.43169\"\n x=\"234.46947\"\n sodipodi:role=\"line\">pipes</tspan></text>\n </g>\n <g\n id=\"g11847\"\n transform=\"translate(-10,0.39179)\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328-0\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-8\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591-3\"\n y=\"240.5825\"\n x=\"372.50137\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.5825\"\n x=\"372.50137\"\n id=\"tspan10593-2\"\n sodipodi:role=\"line\">Child</tspan></text>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path11075\"\n d=\"m 397.80427,110.64896 0,-52.85714\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\" />\n <g\n id=\"g10626-5\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2-4\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334-0\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336-9\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-4\"\n d=\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7-87\"\n d=\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331-7\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\"\n id=\"path2991-7-8-4\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-6\"\n y=\"240.18468\"\n x=\"323.85132\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.18468\"\n x=\"323.85132\"\n id=\"tspan6247-3\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-6\"\n y=\"207.68279\"\n x=\"410.10779\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-2\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"207.68279\"\n x=\"410.10779\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8-1\"\n y=\"261.61133\"\n x=\"426.17795\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298-3\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"261.61133\"\n x=\"426.17795\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(227.5656,-301.02546)\"\n id=\"g11065\">\n <g\n id=\"g11055\">\n <rect\n y=\"421.34998\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55\"\n style=\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6\"\n y=\"431.01376\"\n x=\"159.1624\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"431.01376\"\n x=\"159.1624\"\n id=\"tspan6310-7-9\"\n sodipodi:role=\"line\">slave</tspan></text>\n </g>\n <g\n id=\"g11060\">\n <rect\n y=\"407.25223\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55-9\"\n style=\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6-7\"\n y=\"416.68555\"\n x=\"155.16631\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"416.68555\"\n x=\"155.16631\"\n id=\"tspan6310-7-9-7\"\n sodipodi:role=\"line\">master</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726-9\"\n y=\"116.71899\"\n x=\"429.1268\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"116.71899\"\n x=\"429.1268\"\n id=\"tspan10728-7\"\n sodipodi:role=\"line\">Pseudoterminal</tspan><tspan\n id=\"tspan11761\"\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"136.71899\"\n x=\"429.1268\"\n sodipodi:role=\"line\">(pty)</tspan></text>\n </g>\n </g>\n</svg>\n\n[end of docs/images/pty_vs_popen.svg]","filename":"docs/images/pty_vs_popen.svg","id":"12"},{"content":"None\n[end of docs/images/pty_vs_popen.png]","filename":"docs/images/pty_vs_popen.png","id":"13"}],"string":"[\n {\n \"content\": \"python:\\n version: 3\\n\\n[end of readthedocs.yml]\",\n \"filename\": \"readthedocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"ISC LICENSE\\n\\n This license is approved by the OSI and FSF as GPL-compatible.\\n http://opensource.org/licenses/isc-license.txt\\n\\n Copyright (c) 2013-2014, Pexpect development team\\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\\n\\n Permission to use, copy, modify, and/or distribute this software for any\\n purpose with or without fee is hereby granted, provided that the above\\n copyright notice and this permission notice appear in all copies.\\n \\n THE SOFTWARE IS PROVIDED \\\"AS IS\\\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"flit_core >=2,<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.metadata]\\nmodule = \\\"ptyprocess\\\"\\nauthor = \\\"Thomas Kluyver\\\"\\nauthor-email = \\\"thomas@kluyver.me.uk\\\"\\nhome-page = \\\"https://github.com/pexpect/ptyprocess\\\"\\ndescription-file = \\\"README.rst\\\"\\nrequires-python = \\\">=3.7\\\"\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: ISC License (ISCL)\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Topic :: Terminals\\\"\\n]\\n\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"Launch a subprocess in a pseudo terminal (pty), and interact with both the\\nprocess and its pty.\\n\\nSometimes, piping stdin and stdout is not enough. There might be a password\\nprompt that doesn't read from stdin, output that changes when it's going to a\\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\\nIf you need to automate these things, running the process in a pseudo terminal\\n(pty) is the answer.\\n\\nInterface:\\n\\n.. code:: python\\n\\n from ptyprocess import PtyProcessUnicode\\n p = PtyProcessUnicode.spawn(['python'])\\n p.read(20)\\n p.write('6+6\\\\n')\\n p.read(20)\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"3\"\n },\n {\n \"content\": \"Ptyprocess\\n==========\\n\\n.. include:: ../README.rst\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n\\n api\\n\\nWhat is a pty?\\n--------------\\n\\nA pty is a kernel-level object which processes can write data to and read data\\nfrom, a bit like a pipe.\\n\\nUnlike a pipe, data moves through a single pty in both directions. When you use\\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\\nto three pipes are created for the process's standard streams (stdin, stdout\\nand stderr). When you run a program using ptyprocess, all three of its standard\\nstreams are connected to a single pty:\\n\\n.. image:: images/pty_vs_popen.png\\n\\nA pty also does more than a pipe. It keeps track of the window size (rows and\\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\\nSIGINT to be sent to the child process.\\n\\nMany command line programs behave differently if they detect that stdin or stdout\\nis connected to a terminal instead of a pipe (using \\n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\\nthat they're being used interactively by a human user.\\nThey may format output differently (e.g. ``ls`` lists files in columns)\\nor prompt the user to confirm actions.\\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\\n\\n.. seealso::\\n\\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\\n Detailed article by Linus Akesson\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"4\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = _build\\n\\n# User-friendly check for sphinx-build\\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\\nendif\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n# the i18n builder cannot share the environment and doctrees with the others\\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n\\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" singlehtml to make a single large HTML file\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" devhelp to make HTML files and a Devhelp project\\\"\\n\\t@echo \\\" epub to make an epub\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" latexpdf to make LaTeX files and run them through pdflatex\\\"\\n\\t@echo \\\" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\\\"\\n\\t@echo \\\" text to make text files\\\"\\n\\t@echo \\\" man to make manual pages\\\"\\n\\t@echo \\\" texinfo to make Texinfo files\\\"\\n\\t@echo \\\" info to make Texinfo files and run them through makeinfo\\\"\\n\\t@echo \\\" gettext to make PO message catalogs\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" xml to make Docutils-native XML files\\\"\\n\\t@echo \\\" pseudoxml to make pseudoxml-XML files for display purposes\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\trm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\nsinglehtml:\\n\\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\\\"\\n\\ndevhelp:\\n\\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\\n\\t@echo\\n\\t@echo \\\"Build finished.\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# devhelp\\\"\\n\\nepub:\\n\\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\\n\\t@echo\\n\\t@echo \\\"Build finished. The epub file is in $(BUILDDIR)/epub.\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through (pdf)latex\\\" \\\\\\n\\t \\\"(use \\\\`make latexpdf' here to do that automatically).\\\"\\n\\nlatexpdf:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through pdflatex...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\nlatexpdfja:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through platex and dvipdfmx...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\ntext:\\n\\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\\n\\t@echo\\n\\t@echo \\\"Build finished. The text files are in $(BUILDDIR)/text.\\\"\\n\\nman:\\n\\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\\n\\t@echo\\n\\t@echo \\\"Build finished. The manual pages are in $(BUILDDIR)/man.\\\"\\n\\ntexinfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo\\n\\t@echo \\\"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through makeinfo\\\" \\\\\\n\\t \\\"(use \\\\`make info' here to do that automatically).\\\"\\n\\ninfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo \\\"Running Texinfo files through makeinfo...\\\"\\n\\tmake -C $(BUILDDIR)/texinfo info\\n\\t@echo \\\"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\\\"\\n\\ngettext:\\n\\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\\n\\t@echo\\n\\t@echo \\\"Build finished. The message catalogs are in $(BUILDDIR)/locale.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\nxml:\\n\\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\\n\\t@echo\\n\\t@echo \\\"Build finished. The XML files are in $(BUILDDIR)/xml.\\\"\\n\\npseudoxml:\\n\\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\\n\\t@echo\\n\\t@echo \\\"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\\\"\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n#\\n# Ptyprocess documentation build configuration file, created by\\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\\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\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.insert(0, os.path.abspath('..'))\\n\\n# -- General configuration ------------------------------------------------\\n\\n# If your documentation needs a minimal Sphinx version, state it here.\\n#needs_sphinx = '1.0'\\n\\n# Add any Sphinx extension module names here, as strings. They can be\\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\\n# ones.\\nextensions = [\\n 'sphinx.ext.autodoc',\\n 'sphinx.ext.intersphinx',\\n 'sphinx.ext.viewcode',\\n]\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['_templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8-sig'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = u'Ptyprocess'\\ncopyright = u'2014, Thomas Kluyver'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.7'\\n# The full version, including alpha/beta/rc tags.\\nrelease = version #+ '.2'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of patterns, relative to source directory, that match files and\\n# directories to ignore when looking for source files.\\nexclude_patterns = ['_build']\\n\\n# The reST default role (used for this markup: `text`) to use for all\\n# documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n# If true, keep warnings as \\\"system message\\\" paragraphs in the built documents.\\n#keep_warnings = False\\n\\n\\n# -- Options for HTML output ----------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. See the documentation for\\n# a list of builtin themes.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['_static']\\n\\n# Add any extra paths that contain custom files (such as robots.txt or\\n# .htaccess) here, relative to this directory. These files are copied\\n# directly to the root of the documentation.\\n#html_extra_path = []\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_domain_indices = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, \\\"Created using Sphinx\\\" is shown in the HTML footer. Default is True.\\n#html_show_sphinx = True\\n\\n# If true, \\\"(C) Copyright ...\\\" is shown in the HTML footer. Default is True.\\n#html_show_copyright = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# This is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = None\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'Ptyprocessdoc'\\n\\n\\n# -- Options for LaTeX output ---------------------------------------------\\n\\nlatex_elements = {\\n# The paper size ('letterpaper' or 'a4paper').\\n#'papersize': 'letterpaper',\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#'pointsize': '10pt',\\n\\n# Additional stuff for the LaTeX preamble.\\n#'preamble': '',\\n}\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title,\\n# author, documentclass [howto, manual, or own class]).\\nlatex_documents = [\\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# If true, show page references after internal links.\\n#latex_show_pagerefs = False\\n\\n# If true, show URL addresses after external links.\\n#latex_show_urls = False\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_domain_indices = True\\n\\n\\n# -- Options for manual page output ---------------------------------------\\n\\n# One entry per manual page. List of tuples\\n# (source start file, name, description, authors, manual section).\\nman_pages = [\\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\\n [u'Thomas Kluyver'], 1)\\n]\\n\\n# If true, show URL addresses after external links.\\n#man_show_urls = False\\n\\n\\n# -- Options for Texinfo output -------------------------------------------\\n\\n# Grouping the document tree into Texinfo files. List of tuples\\n# (source start file, target name, title, author,\\n# dir menu entry, description, category)\\ntexinfo_documents = [\\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\\n 'Miscellaneous'),\\n]\\n\\n# Documents to append as an appendix to all manuals.\\n#texinfo_appendices = []\\n\\n# If false, no module index is generated.\\n#texinfo_domain_indices = True\\n\\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\\n#texinfo_show_urls = 'footnote'\\n\\n# If true, do not generate a @detailmenu in the \\\"Top\\\" node's menu.\\n#texinfo_no_detailmenu = False\\n\\n\\n# Example configuration for intersphinx: refer to the Python standard library.\\nintersphinx_mapping = {'http://docs.python.org/': None}\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Ptyprocess API\\n==============\\n\\n.. module:: ptyprocess\\n\\n.. autoclass:: PtyProcess\\n\\n .. automethod:: spawn\\n\\n .. automethod:: read\\n\\n .. automethod:: readline\\n\\n .. automethod:: write\\n\\n .. automethod:: sendcontrol\\n\\n .. automethod:: sendeof\\n\\n .. automethod:: sendintr\\n\\n .. automethod:: getecho\\n\\n .. automethod:: waitnoecho\\n\\n .. automethod:: setecho\\n\\n .. automethod:: getwinsize\\n\\n .. automethod:: setwinsize\\n\\n .. automethod:: eof\\n\\n .. automethod:: isalive\\n\\n .. automethod:: wait\\n\\n .. automethod:: kill\\n\\n .. automethod:: terminate\\n\\n .. automethod:: close\\n\\n.. autoclass:: PtyProcessUnicode\\n\\n[end of docs/api.rst]\",\n \"filename\": \"docs/api.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"try:\\n from shutil import which # Python >= 3.3\\nexcept ImportError:\\n import os, sys\\n \\n # This is copied from Python 3.4.1\\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\\n \\\"\\\"\\\"Given a command, mode, and a PATH string, return the path which\\n conforms to the given mode on the PATH, or None if there is no such\\n file.\\n \\n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\\n of os.environ.get(\\\"PATH\\\"), or can be overridden with a custom search\\n path.\\n \\n \\\"\\\"\\\"\\n # Check that a given file can be accessed with the correct mode.\\n # Additionally check that `file` is not a directory, as on Windows\\n # directories pass the os.access check.\\n def _access_check(fn, mode):\\n return (os.path.exists(fn) and os.access(fn, mode)\\n and not os.path.isdir(fn))\\n \\n # If we're given a path with a directory part, look it up directly rather\\n # than referring to PATH directories. This includes checking relative to the\\n # current directory, e.g. ./script\\n if os.path.dirname(cmd):\\n if _access_check(cmd, mode):\\n return cmd\\n return None\\n \\n if path is None:\\n path = os.environ.get(\\\"PATH\\\", os.defpath)\\n if not path:\\n return None\\n path = path.split(os.pathsep)\\n \\n if sys.platform == \\\"win32\\\":\\n # The current directory takes precedence on Windows.\\n if not os.curdir in path:\\n path.insert(0, os.curdir)\\n \\n # PATHEXT is necessary to check on Windows.\\n pathext = os.environ.get(\\\"PATHEXT\\\", \\\"\\\").split(os.pathsep)\\n # See if the given file matches any of the expected path extensions.\\n # This will allow us to short circuit when given \\\"python.exe\\\".\\n # If it does match, only test that one, otherwise we have to try\\n # others.\\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\\n files = [cmd]\\n else:\\n files = [cmd + ext for ext in pathext]\\n else:\\n # On other platforms you don't have things like PATHEXT to tell you\\n # what file suffixes are executable, so just pass on cmd as-is.\\n files = [cmd]\\n \\n seen = set()\\n for dir in path:\\n normdir = os.path.normcase(dir)\\n if not normdir in seen:\\n seen.add(normdir)\\n for thefile in files:\\n name = os.path.join(dir, thefile)\\n if _access_check(name, mode):\\n return name\\n return None\\n\\n\\nclass PtyProcessError(Exception):\\n \\\"\\\"\\\"Generic error class for this package.\\\"\\\"\\\"\\n\\n[end of ptyprocess/util.py]\",\n \"filename\": \"ptyprocess/util.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Substitute for the forkpty system call, to support Solaris.\\n\\\"\\\"\\\"\\nimport os\\nimport errno\\n\\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\\nfrom .util import PtyProcessError\\n\\ndef fork_pty():\\n '''This implements a substitute for the forkpty system call. This\\n should be more portable than the pty.fork() function. Specifically,\\n this should work on Solaris.\\n\\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\\n resolve the issue with Python's pty.fork() not supporting Solaris,\\n particularly ssh. Based on patch to posixmodule.c authored by Noah\\n Spurrier::\\n\\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\\n\\n '''\\n\\n parent_fd, child_fd = os.openpty()\\n if parent_fd < 0 or child_fd < 0:\\n raise OSError(\\\"os.openpty() failed\\\")\\n\\n pid = os.fork()\\n if pid == CHILD:\\n # Child.\\n os.close(parent_fd)\\n pty_make_controlling_tty(child_fd)\\n\\n os.dup2(child_fd, STDIN_FILENO)\\n os.dup2(child_fd, STDOUT_FILENO)\\n os.dup2(child_fd, STDERR_FILENO)\\n\\n else:\\n # Parent.\\n os.close(child_fd)\\n\\n return pid, parent_fd\\n\\ndef pty_make_controlling_tty(tty_fd):\\n '''This makes the pseudo-terminal the controlling tty. This should be\\n more portable than the pty.fork() function. Specifically, this should\\n work on Solaris. '''\\n\\n child_name = os.ttyname(tty_fd)\\n\\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\\n # if there was no controlling tty to begin with, such as when\\n # executed by a cron(1) job.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n os.setsid()\\n\\n # Verify we are disconnected from controlling tty by attempting to open\\n # it again. We expect that OSError of ENXIO should always be raised.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n raise PtyProcessError(\\\"OSError of errno.ENXIO should be raised.\\\")\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n # Verify we can open child pty.\\n fd = os.open(child_name, os.O_RDWR)\\n os.close(fd)\\n\\n # Verify we now have a controlling tty.\\n fd = os.open(\\\"/dev/tty\\\", os.O_WRONLY)\\n os.close(fd)\\n\\n[end of ptyprocess/_fork_pty.py]\",\n \"filename\": \"ptyprocess/_fork_pty.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"import codecs\\nimport errno\\nimport fcntl\\nimport io\\nimport os\\nimport pty\\nimport resource\\nimport signal\\nimport struct\\nimport sys\\nimport termios\\nimport time\\n\\ntry:\\n import builtins # Python 3\\nexcept ImportError:\\n import __builtin__ as builtins # Python 2\\n\\n# Constants\\nfrom pty import (STDIN_FILENO, CHILD)\\n\\nfrom .util import which, PtyProcessError\\n\\n_platform = sys.platform.lower()\\n\\n# Solaris uses internal __fork_pty(). All others use pty.fork().\\n_is_solaris = (\\n _platform.startswith('solaris') or\\n _platform.startswith('sunos'))\\n\\nif _is_solaris:\\n use_native_pty_fork = False\\n from . import _fork_pty\\nelse:\\n use_native_pty_fork = True\\n\\nPY3 = sys.version_info[0] >= 3\\n\\nif PY3:\\n def _byte(i):\\n return bytes([i])\\nelse:\\n def _byte(i):\\n return chr(i)\\n \\n class FileNotFoundError(OSError): pass\\n class TimeoutError(OSError): pass\\n\\n_EOF, _INTR = None, None\\n\\ndef _make_eof_intr():\\n \\\"\\\"\\\"Set constants _EOF and _INTR.\\n \\n This avoids doing potentially costly operations on module load.\\n \\\"\\\"\\\"\\n global _EOF, _INTR\\n if (_EOF is not None) and (_INTR is not None):\\n return\\n\\n # inherit EOF and INTR definitions from controlling process.\\n try:\\n from termios import VEOF, VINTR\\n fd = None\\n for name in 'stdin', 'stdout':\\n stream = getattr(sys, '__%s__' % name, None)\\n if stream is None or not hasattr(stream, 'fileno'):\\n continue\\n try:\\n fd = stream.fileno()\\n except ValueError:\\n continue\\n if fd is None:\\n # no fd, raise ValueError to fallback on CEOF, CINTR\\n raise ValueError(\\\"No stream has a fileno\\\")\\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\\n except (ImportError, OSError, IOError, ValueError, termios.error):\\n # unless the controlling process is also not a terminal,\\n # such as cron(1), or when stdin and stdout are both closed.\\n # Fall-back to using CEOF and CINTR. There\\n try:\\n from termios import CEOF, CINTR\\n (intr, eof) = (CINTR, CEOF)\\n except ImportError:\\n # ^C, ^D\\n (intr, eof) = (3, 4)\\n \\n _INTR = _byte(intr)\\n _EOF = _byte(eof)\\n\\n# setecho and setwinsize are pulled out here because on some platforms, we need\\n# to do this from the child before we exec()\\n \\ndef _setecho(fd, state):\\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\\n\\n try:\\n attr = termios.tcgetattr(fd)\\n except termios.error as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n if state:\\n attr[3] = attr[3] | termios.ECHO\\n else:\\n attr[3] = attr[3] & ~termios.ECHO\\n\\n try:\\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\\n # blocked on some platforms. TCSADRAIN would probably be ideal.\\n termios.tcsetattr(fd, termios.TCSANOW, attr)\\n except IOError as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\ndef _setwinsize(fd, rows, cols):\\n # Some very old platforms have a bug that causes the value for\\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\\n # around this, but it caused problems with newer platforms so has been\\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\\n # Note, assume ws_xpixel and ws_ypixel are zero.\\n s = struct.pack('HHHH', rows, cols, 0, 0)\\n fcntl.ioctl(fd, TIOCSWINSZ, s)\\n\\nclass PtyProcess(object):\\n '''This class represents a process running in a pseudoterminal.\\n \\n The main constructor is the :meth:`spawn` classmethod.\\n '''\\n string_type = bytes\\n if PY3:\\n linesep = os.linesep.encode('ascii')\\n crlf = '\\\\r\\\\n'.encode('ascii')\\n\\n @staticmethod\\n def write_to_stdout(b):\\n try:\\n return sys.stdout.buffer.write(b)\\n except AttributeError:\\n # If stdout has been replaced, it may not have .buffer\\n return sys.stdout.write(b.decode('ascii', 'replace'))\\n else:\\n linesep = os.linesep\\n crlf = '\\\\r\\\\n'\\n write_to_stdout = sys.stdout.write\\n\\n encoding = None\\n \\n argv = None\\n env = None\\n launch_dir = None\\n\\n def __init__(self, pid, fd):\\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\\n self.pid = pid\\n self.fd = fd\\n readf = io.open(fd, 'rb', buffering=0)\\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\\n self.fileobj = io.BufferedRWPair(readf, writef)\\n\\n self.terminated = False\\n self.closed = False\\n self.exitstatus = None\\n self.signalstatus = None\\n # status returned by os.waitpid\\n self.status = None\\n self.flag_eof = False\\n # Used by close() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterclose = 0.1\\n # Used by terminate() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterterminate = 0.1\\n\\n @classmethod\\n def spawn(\\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\\n dimensions=(24, 80), pass_fds=()):\\n '''Start the given command in a child process in a pseudo terminal.\\n\\n This does all the fork/exec type of stuff for a pty, and returns an\\n instance of PtyProcess.\\n\\n If preexec_fn is supplied, it will be called with no arguments in the\\n child process before exec-ing the specified command.\\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\\n\\n Dimensions of the psuedoterminal used for the subprocess can be\\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\\n\\n By default, all file descriptors except 0, 1 and 2 are closed. This\\n behavior can be overridden with pass_fds, a list of file descriptors to\\n keep open between the parent and the child.\\n '''\\n # Note that it is difficult for this method to fail.\\n # You cannot detect if the child process cannot start.\\n # So the only way you can tell if the child process started\\n # or not is to try to read from the file descriptor. If you get\\n # EOF immediately then it means that the child is already dead.\\n # That may not necessarily be bad because you may have spawned a child\\n # that performs some task; creates no stdout output; and then dies.\\n\\n if not isinstance(argv, (list, tuple)):\\n raise TypeError(\\\"Expected a list or tuple for argv, got %r\\\" % argv)\\n\\n # Shallow copy of argv so we can modify it\\n argv = argv[:]\\n command = argv[0]\\n\\n command_with_path = which(command)\\n if command_with_path is None:\\n raise FileNotFoundError('The command was not found or was not ' +\\n 'executable: %s.' % command)\\n command = command_with_path\\n argv[0] = command\\n\\n # [issue #119] To prevent the case where exec fails and the user is\\n # stuck interacting with a python child process instead of whatever\\n # was expected, we implement the solution from\\n # http://stackoverflow.com/a/3703179 to pass the exception to the\\n # parent process\\n\\n # [issue #119] 1. Before forking, open a pipe in the parent process.\\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\\n\\n if use_native_pty_fork:\\n pid, fd = pty.fork()\\n else:\\n # Use internal fork_pty, for Solaris\\n pid, fd = _fork_pty.fork_pty()\\n\\n # Some platforms must call setwinsize() and setecho() from the\\n # child process, and others from the master process. We do both,\\n # allowing IOError for either.\\n\\n if pid == CHILD:\\n # set window size\\n try:\\n _setwinsize(STDIN_FILENO, *dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # disable echo if spawn argument echo was unset\\n if not echo:\\n try:\\n _setecho(STDIN_FILENO, False)\\n except (IOError, termios.error) as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # [issue #119] 3. The child closes the reading end and sets the\\n # close-on-exec flag for the writing end.\\n os.close(exec_err_pipe_read)\\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\\n\\n # Do not allow child to inherit open file descriptors from parent,\\n # with the exception of the exec_err_pipe_write of the pipe\\n # and pass_fds.\\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\\n # occasionally raises out of range error\\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\\n os.closerange(pair[0]+1, pair[1])\\n\\n if cwd is not None:\\n os.chdir(cwd)\\n\\n if preexec_fn is not None:\\n try:\\n preexec_fn()\\n except Exception as e:\\n ename = type(e).__name__\\n tosend = '{}:0:{}'.format(ename, str(e))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(1)\\n\\n try:\\n if env is None:\\n os.execv(command, argv)\\n else:\\n os.execvpe(command, argv, env)\\n except OSError as err:\\n # [issue #119] 5. If exec fails, the child writes the error\\n # code back to the parent using the pipe, then exits.\\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(os.EX_OSERR)\\n\\n # Parent\\n inst = cls(pid, fd)\\n \\n # Set some informational attributes\\n inst.argv = argv\\n if env is not None:\\n inst.env = env\\n if cwd is not None:\\n inst.launch_dir = cwd\\n\\n # [issue #119] 2. After forking, the parent closes the writing end\\n # of the pipe and reads from the reading end.\\n os.close(exec_err_pipe_write)\\n exec_err_data = os.read(exec_err_pipe_read, 4096)\\n os.close(exec_err_pipe_read)\\n\\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\\n # child successfully performed exec, since close-on-exec made\\n # successful exec close the writing end of the pipe. Or, if exec\\n # failed, the parent reads the error code and can proceed\\n # accordingly. Either way, the parent blocks until the child calls\\n # exec.\\n if len(exec_err_data) != 0:\\n try:\\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\\n\\n exception = exctype(errmsg.decode('utf-8', 'replace'))\\n if exctype is OSError:\\n exception.errno = int(errno_s)\\n except:\\n raise Exception('Subprocess failed, got bad error data: %r'\\n % exec_err_data)\\n else:\\n raise exception\\n\\n try:\\n inst.setwinsize(*dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\\n raise\\n\\n return inst\\n\\n def __repr__(self):\\n clsname = type(self).__name__\\n if self.argv is not None:\\n args = [repr(self.argv)]\\n if self.env is not None:\\n args.append(\\\"env=%r\\\" % self.env)\\n if self.launch_dir is not None:\\n args.append(\\\"cwd=%r\\\" % self.launch_dir)\\n \\n return \\\"{}.spawn({})\\\".format(clsname, \\\", \\\".join(args))\\n \\n else:\\n return \\\"{}(pid={}, fd={})\\\".format(clsname, self.pid, self.fd)\\n\\n @staticmethod\\n def _coerce_send_string(s):\\n if not isinstance(s, bytes):\\n return s.encode('utf-8')\\n return s\\n\\n @staticmethod\\n def _coerce_read_string(s):\\n return s\\n\\n def __del__(self):\\n '''This makes sure that no system resources are left open. Python only\\n garbage collects Python objects. OS file descriptors are not Python\\n objects, so they must be handled explicitly. If the child file\\n descriptor was opened outside of this class (passed to the constructor)\\n then this does not close it. '''\\n\\n if not self.closed:\\n # It is possible for __del__ methods to execute during the\\n # teardown of the Python VM itself. Thus self.close() may\\n # trigger an exception because os.close may be None.\\n try:\\n self.close()\\n # which exception, shouldn't we catch explicitly .. ?\\n except:\\n pass\\n\\n\\n def fileno(self):\\n '''This returns the file descriptor of the pty for the child.\\n '''\\n return self.fd\\n\\n def close(self, force=True):\\n '''This closes the connection with the child application. Note that\\n calling close() more than once is valid. This emulates standard Python\\n behavior with files. Set force to True if you want to make sure that\\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\\n and SIGINT). '''\\n if not self.closed:\\n self.flush()\\n self.fileobj.close() # Closes the file descriptor\\n # Give kernel time to update process status.\\n time.sleep(self.delayafterclose)\\n if self.isalive():\\n if not self.terminate(force):\\n raise PtyProcessError('Could not terminate the child.')\\n self.fd = -1\\n self.closed = True\\n #self.pid = None\\n\\n def flush(self):\\n '''This does nothing. It is here to support the interface for a\\n File-like object. '''\\n\\n pass\\n\\n def isatty(self):\\n '''This returns True if the file descriptor is open and connected to a\\n tty(-like) device, else False.\\n\\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\\n the child pty may not appear as a terminal device. This means\\n methods such as setecho(), setwinsize(), getwinsize() may raise an\\n IOError. '''\\n\\n return os.isatty(self.fd)\\n\\n def waitnoecho(self, timeout=None):\\n '''Wait until the terminal ECHO flag is set False.\\n\\n This returns True if the echo mode is off, or False if echo was not\\n disabled before the timeout. This can be used to detect when the\\n child is waiting for a password. Usually a child application will turn\\n off echo mode when it is waiting for the user to enter a password. For\\n example, instead of expecting the \\\"password:\\\" prompt you can wait for\\n the child to turn echo off::\\n\\n p = pexpect.spawn('ssh user@example.com')\\n p.waitnoecho()\\n p.sendline(mypassword)\\n\\n If ``timeout=None`` then this method to block until ECHO flag is False.\\n '''\\n\\n if timeout is not None:\\n end_time = time.time() + timeout\\n while True:\\n if not self.getecho():\\n return True\\n if timeout < 0 and timeout is not None:\\n return False\\n if timeout is not None:\\n timeout = end_time - time.time()\\n time.sleep(0.1)\\n\\n def getecho(self):\\n '''Returns True if terminal echo is on, or False if echo is off.\\n\\n Child applications that are expecting you to enter a password often\\n disable echo. See also :meth:`waitnoecho`.\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n\\n try:\\n attr = termios.tcgetattr(self.fd)\\n except termios.error as err:\\n errmsg = 'getecho() may not be called on this platform'\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n self.echo = bool(attr[3] & termios.ECHO)\\n return self.echo\\n\\n def setecho(self, state):\\n '''Enable or disable terminal echo.\\n\\n Anything the child sent before the echo will be lost, so you should be\\n sure that your input buffer is empty before you call setecho().\\n For example, the following will work as expected::\\n\\n p = pexpect.spawn('cat') # Echo is on by default.\\n p.sendline('1234') # We expect see this twice from the child...\\n p.expect(['1234']) # ... once from the tty echo...\\n p.expect(['1234']) # ... and again from cat itself.\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n The following WILL NOT WORK because the lines sent before the setecho\\n will be lost::\\n\\n p = pexpect.spawn('cat')\\n p.sendline('1234')\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['1234'])\\n p.expect(['1234'])\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n _setecho(self.fd, state)\\n\\n self.echo = state\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read and return at most ``size`` bytes from the pty.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\\n with the vagaries of EOF on platforms that do strange things, like IRIX\\n or older Solaris systems. It handles the errno=EIO pattern used on\\n Linux, and the empty-string return used on BSD platforms and (seemingly)\\n on recent Solaris.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.read1(size)\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.readline()\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def _writeb(self, b, flush=True):\\n n = self.fileobj.write(b)\\n if flush:\\n self.fileobj.flush()\\n return n\\n\\n def write(self, s, flush=True):\\n \\\"\\\"\\\"Write bytes to the pseudoterminal.\\n \\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n return self._writeb(s, flush=flush)\\n\\n def sendcontrol(self, char):\\n '''Helper method for sending control characters to the terminal.\\n\\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\\\\\a'``)::\\n\\n child.sendcontrol('g')\\n\\n See also, :meth:`sendintr` and :meth:`sendeof`.\\n '''\\n char = char.lower()\\n a = ord(char)\\n if 97 <= a <= 122:\\n a = a - ord('a') + 1\\n byte = _byte(a)\\n return self._writeb(byte), byte\\n d = {'@': 0, '`': 0,\\n '[': 27, '{': 27,\\n '\\\\\\\\': 28, '|': 28,\\n ']': 29, '}': 29,\\n '^': 30, '~': 30,\\n '_': 31,\\n '?': 127}\\n if char not in d:\\n return 0, b''\\n\\n byte = _byte(d[char])\\n return self._writeb(byte), byte\\n\\n def sendeof(self):\\n '''Sends an EOF (typically Ctrl-D) through the terminal.\\n\\n This sends a character which causes\\n the pending parent output buffer to be sent to the waiting child\\n program without waiting for end-of-line. If it is the first character\\n of the line, the read() in the user program returns 0, which signifies\\n end-of-file. This means to work as expected a sendeof() has to be\\n called at the beginning of a line. This method does not send a newline.\\n It is the responsibility of the caller to ensure the eof is sent at the\\n beginning of a line.\\n '''\\n return self._writeb(_EOF), _EOF\\n\\n def sendintr(self):\\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\\n\\n This will normally trigger the kernel to send SIGINT to the current\\n foreground process group. Processes can turn off this translation, in\\n which case they can read the raw data sent, e.g. ``b'\\\\\\\\x03'`` for Ctrl-C.\\n\\n See also the :meth:`kill` method, which sends a signal directly to the\\n immediate child process in the terminal (which is not necessarily the\\n foreground process).\\n '''\\n return self._writeb(_INTR), _INTR\\n\\n def eof(self):\\n '''This returns True if the EOF exception was ever raised.\\n '''\\n\\n return self.flag_eof\\n\\n def terminate(self, force=False):\\n '''This forces a child process to terminate. It starts nicely with\\n SIGHUP and SIGINT. If \\\"force\\\" is True then moves onto SIGKILL. This\\n returns True if the child was terminated. This returns False if the\\n child could not be terminated. '''\\n\\n if not self.isalive():\\n return True\\n try:\\n self.kill(signal.SIGHUP)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGCONT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGINT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n if force:\\n self.kill(signal.SIGKILL)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n return False\\n except OSError:\\n # I think there are kernel timing issues that sometimes cause\\n # this to happen. I think isalive() reports True, but the\\n # process is dead to the kernel.\\n # Make one last attempt to see if the kernel is up to date.\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n\\n def wait(self):\\n '''This waits until the child exits. This is a blocking call. This will\\n not read any data from the child, so this will block forever if the\\n child has unread output and has terminated. In other words, the child\\n may have printed output then called exit(), but, the child is\\n technically still alive until its output is read by the parent. '''\\n\\n if self.isalive():\\n pid, status = os.waitpid(self.pid, 0)\\n else:\\n return self.exitstatus\\n self.exitstatus = os.WEXITSTATUS(status)\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status): # pragma: no cover\\n # You can't call wait() on a child process in the stopped state.\\n raise PtyProcessError('Called wait() on a stopped child ' +\\n 'process. This is not supported. Is some other ' +\\n 'process attempting job control with our child pid?')\\n return self.exitstatus\\n\\n def isalive(self):\\n '''This tests if the child process is running or not. This is\\n non-blocking. If the child was terminated then this will read the\\n exitstatus or signalstatus of the child. This returns True if the child\\n process appears to be running or False if not. It can take literally\\n SECONDS for Solaris to return the right status. '''\\n\\n if self.terminated:\\n return False\\n\\n if self.flag_eof:\\n # This is for Linux, which requires the blocking form\\n # of waitpid to get the status of a defunct process.\\n # This is super-lame. The flag_eof would have been set\\n # in read_nonblocking(), so this should be safe.\\n waitpid_options = 0\\n else:\\n waitpid_options = os.WNOHANG\\n\\n try:\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e:\\n # No child processes\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where \\\"terminated\\\" is 0, but there was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # I have to do this twice for Solaris.\\n # I can't even believe that I figured this out...\\n # If waitpid() returns 0 it means that no child process\\n # wishes to report, and the value of status is undefined.\\n if pid == 0:\\n try:\\n ### os.WNOHANG) # Solaris!\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e: # pragma: no cover\\n # This should never happen...\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'that should never happen. There was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # If pid is still 0 after two calls to waitpid() then the process\\n # really is alive. This seems to work on all platforms, except for\\n # Irix which seems to require a blocking call on waitpid or select,\\n # so I let read_nonblocking take care of this situation\\n # (unfortunately, this requires waiting through the timeout).\\n if pid == 0:\\n return True\\n\\n if pid == 0:\\n return True\\n\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status):\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where child process is stopped. This is not ' +\\n 'supported. Is some other process attempting ' +\\n 'job control with our child pid?')\\n return False\\n\\n def kill(self, sig):\\n \\\"\\\"\\\"Send the given signal to the child application.\\n\\n In keeping with UNIX tradition it has a misleading name. It does not\\n necessarily kill the child unless you send the right signal. See the\\n :mod:`signal` module for constants representing signal numbers.\\n \\\"\\\"\\\"\\n\\n # Same as os.kill, but the pid is given for you.\\n if self.isalive():\\n os.kill(self.pid, sig)\\n\\n def getwinsize(self):\\n \\\"\\\"\\\"Return the window size of the pseudoterminal as a tuple (rows, cols).\\n \\\"\\\"\\\"\\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\\n s = struct.pack('HHHH', 0, 0, 0, 0)\\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\\n return struct.unpack('HHHH', x)[0:2]\\n\\n def setwinsize(self, rows, cols):\\n \\\"\\\"\\\"Set the terminal window size of the child tty.\\n\\n This will cause a SIGWINCH signal to be sent to the child. This does not\\n change the physical window size. It changes the size reported to\\n TTY-aware applications like vi or curses -- applications that respond to\\n the SIGWINCH signal.\\n \\\"\\\"\\\"\\n return _setwinsize(self.fd, rows, cols)\\n\\n\\nclass PtyProcessUnicode(PtyProcess):\\n \\\"\\\"\\\"Unicode wrapper around a process running in a pseudoterminal.\\n\\n This class exposes a similar interface to :class:`PtyProcess`, but its read\\n methods return unicode, and its :meth:`write` accepts unicode.\\n \\\"\\\"\\\"\\n if PY3:\\n string_type = str\\n else:\\n string_type = unicode # analysis:ignore\\n\\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\\n super(PtyProcessUnicode, self).__init__(pid, fd)\\n self.encoding = encoding\\n self.codec_errors = codec_errors\\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read at most ``size`` bytes from the pty, return them as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n\\n The size argument still refers to bytes, not unicode code points.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).read(size)\\n return self.decoder.decode(b, final=False)\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).readline()\\n return self.decoder.decode(b, final=False)\\n\\n def write(self, s):\\n \\\"\\\"\\\"Write the unicode string ``s`` to the pseudoterminal.\\n\\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n b = s.encode(self.encoding)\\n return super(PtyProcessUnicode, self).write(b)\\n\\n[end of ptyprocess/ptyprocess.py]\",\n \"filename\": \"ptyprocess/ptyprocess.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Run a subprocess in a pseudo terminal\\\"\\\"\\\"\\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\\n\\n__version__ = '0.7.0'\\n\\n[end of ptyprocess/__init__.py]\",\n \"filename\": \"ptyprocess/__init__.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"no\\\"?>\\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\\n\\n<svg\\n xmlns:dc=\\\"http://purl.org/dc/elements/1.1/\\\"\\n xmlns:cc=\\\"http://creativecommons.org/ns#\\\"\\n xmlns:rdf=\\\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\\\"\\n xmlns:svg=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns:sodipodi=\\\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\\\"\\n xmlns:inkscape=\\\"http://www.inkscape.org/namespaces/inkscape\\\"\\n width=\\\"554.44196\\\"\\n height=\\\"327.38452\\\"\\n id=\\\"svg2\\\"\\n version=\\\"1.1\\\"\\n inkscape:version=\\\"0.48.4 r9939\\\"\\n sodipodi:docname=\\\"pty_vs_popen.svg\\\">\\n <defs\\n id=\\\"defs4\\\">\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3838\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3783\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(1.1,0,0,1.1,1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Tail\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Tail\\\"\\n style=\\\"overflow:visible\\\">\\n <g\\n id=\\\"g3801\\\"\\n transform=\\\"scale(-1.2,-1.2)\\\">\\n <path\\n id=\\\"path3803\\\"\\n d=\\\"M -3.8048674,-3.9585227 0.54352094,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3805\\\"\\n d=\\\"M -1.2866832,-3.9585227 3.0617053,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3807\\\"\\n d=\\\"M 1.3053582,-3.9585227 5.6537466,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3809\\\"\\n d=\\\"M -3.8048674,4.1775838 0.54352094,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3811\\\"\\n d=\\\"M -1.2866832,4.1775838 3.0617053,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3813\\\"\\n d=\\\"M 1.3053582,4.1775838 5.6537466,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </g>\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3765\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(0.8,0,0,0.8,10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3786\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3768\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(-0.8,0,0,-0.8,-10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-9\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-2\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-6\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-27\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM-5\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3838-7\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10742\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10744\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10746\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10748\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10750\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10752\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10754\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10756\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10758\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10760\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n </defs>\\n <sodipodi:namedview\\n id=\\\"base\\\"\\n pagecolor=\\\"#ffffff\\\"\\n bordercolor=\\\"#666666\\\"\\n borderopacity=\\\"1.0\\\"\\n inkscape:pageopacity=\\\"0.0\\\"\\n inkscape:pageshadow=\\\"2\\\"\\n inkscape:zoom=\\\"0.98994949\\\"\\n inkscape:cx=\\\"77.797977\\\"\\n inkscape:cy=\\\"137.24456\\\"\\n inkscape:document-units=\\\"px\\\"\\n inkscape:current-layer=\\\"layer1\\\"\\n showgrid=\\\"false\\\"\\n inkscape:window-width=\\\"1301\\\"\\n inkscape:window-height=\\\"744\\\"\\n inkscape:window-x=\\\"65\\\"\\n inkscape:window-y=\\\"24\\\"\\n inkscape:window-maximized=\\\"1\\\"\\n fit-margin-top=\\\"1\\\"\\n fit-margin-left=\\\"1\\\"\\n fit-margin-right=\\\"1\\\"\\n fit-margin-bottom=\\\"1\\\"\\n units=\\\"cm\\\" />\\n <metadata\\n id=\\\"metadata7\\\">\\n <rdf:RDF>\\n <cc:Work\\n rdf:about=\\\"\\\">\\n <dc:format>image/svg+xml</dc:format>\\n <dc:type\\n rdf:resource=\\\"http://purl.org/dc/dcmitype/StillImage\\\" />\\n <dc:title></dc:title>\\n </cc:Work>\\n </rdf:RDF>\\n </metadata>\\n <g\\n inkscape:label=\\\"Layer 1\\\"\\n inkscape:groupmode=\\\"layer\\\"\\n id=\\\"layer1\\\"\\n transform=\\\"translate(-40.758533,29.820888)\\\">\\n <g\\n id=\\\"g11880\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591\\\"\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n id=\\\"tspan10593\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <g\\n id=\\\"g10626\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991\\\"\\n d=\\\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7\\\"\\n d=\\\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\\\"\\n id=\\\"path2991-7-8\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5637\\\"\\n d=\\\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5641\\\"\\n d=\\\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5643\\\"\\n d=\\\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n id=\\\"tspan6247\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(18,0)\\\"\\n id=\\\"g11773\\\">\\n <g\\n id=\\\"g11763\\\">\\n <rect\\n y=\\\"120.8597\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308\\\"\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n id=\\\"tspan6310\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g11768\\\">\\n <rect\\n y=\\\"135.43114\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304\\\"\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n id=\\\"tspan6306\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(54,-16)\\\"\\n id=\\\"g10674\\\">\\n <g\\n id=\\\"g10664\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(86.857134,-15.571435)\\\"\\n id=\\\"g10674-6\\\">\\n <g\\n id=\\\"g10664-6\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0-5\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-9\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7-6\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669-5\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5-3\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6-1\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n id=\\\"tspan10728\\\"\\n sodipodi:role=\\\"line\\\">Popen</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-89\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-24\\\"\\n style=\\\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n sodipodi:role=\\\"line\\\">pipes</tspan></text>\\n </g>\\n <g\\n id=\\\"g11847\\\"\\n transform=\\\"translate(-10,0.39179)\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328-0\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-8\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591-3\\\"\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n id=\\\"tspan10593-2\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path11075\\\"\\n d=\\\"m 397.80427,110.64896 0,-52.85714\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\\\" />\\n <g\\n id=\\\"g10626-5\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2-4\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334-0\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336-9\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-4\\\"\\n d=\\\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7-87\\\"\\n d=\\\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331-7\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\\\"\\n id=\\\"path2991-7-8-4\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-6\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n id=\\\"tspan6247-3\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-6\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-2\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8-1\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298-3\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(227.5656,-301.02546)\\\"\\n id=\\\"g11065\\\">\\n <g\\n id=\\\"g11055\\\">\\n <rect\\n y=\\\"421.34998\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55\\\"\\n style=\\\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6\\\"\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n id=\\\"tspan6310-7-9\\\"\\n sodipodi:role=\\\"line\\\">slave</tspan></text>\\n </g>\\n <g\\n id=\\\"g11060\\\">\\n <rect\\n y=\\\"407.25223\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55-9\\\"\\n style=\\\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6-7\\\"\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n id=\\\"tspan6310-7-9-7\\\"\\n sodipodi:role=\\\"line\\\">master</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726-9\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n id=\\\"tspan10728-7\\\"\\n sodipodi:role=\\\"line\\\">Pseudoterminal</tspan><tspan\\n id=\\\"tspan11761\\\"\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"136.71899\\\"\\n x=\\\"429.1268\\\"\\n sodipodi:role=\\\"line\\\">(pty)</tspan></text>\\n </g>\\n </g>\\n</svg>\\n\\n[end of docs/images/pty_vs_popen.svg]\",\n \"filename\": \"docs/images/pty_vs_popen.svg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"None\\n[end of docs/images/pty_vs_popen.png]\",\n \"filename\": \"docs/images/pty_vs_popen.png\",\n \"id\": \"13\"\n }\n]","isConversational":false}}},{"rowIdx":83,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 83,\n \"num_files\": 14,\n \"repo_id\": \"repo_0083\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"python:\n version: 3\n\n[end of readthedocs.yml]","filename":"readthedocs.yml","id":"0"},{"content":"ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, Pexpect development team\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\n\n Permission to use, copy, modify, and/or distribute this software for any\n purpose with or without fee is hereby granted, provided that the above\n copyright notice and this permission notice appear in all copies.\n \n THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"[build-system]\nrequires = [\"flit_core >=2,<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.metadata]\nmodule = \"ptyprocess\"\nauthor = \"Thomas Kluyver\"\nauthor-email = \"thomas@kluyver.me.uk\"\nhome-page = \"https://github.com/pexpect/ptyprocess\"\ndescription-file = \"README.rst\"\nrequires-python = \">=3.7\"\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: ISC License (ISCL)\",\n \"Operating System :: POSIX\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Topic :: Terminals\"\n]\n\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"Launch a subprocess in a pseudo terminal (pty), and interact with both the\nprocess and its pty.\n\nSometimes, piping stdin and stdout is not enough. There might be a password\nprompt that doesn't read from stdin, output that changes when it's going to a\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\nIf you need to automate these things, running the process in a pseudo terminal\n(pty) is the answer.\n\nInterface:\n\n.. code:: python\n\n from ptyprocess import PtyProcessUnicode\n p = PtyProcessUnicode.spawn(['python'])\n p.read(20)\n p.write('6+6\\n')\n p.read(20)\n\n[end of README.rst]","filename":"README.rst","id":"3"},{"content":"Ptyprocess\n==========\n\n.. include:: ../README.rst\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n\n api\n\nWhat is a pty?\n--------------\n\nA pty is a kernel-level object which processes can write data to and read data\nfrom, a bit like a pipe.\n\nUnlike a pipe, data moves through a single pty in both directions. When you use\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\nto three pipes are created for the process's standard streams (stdin, stdout\nand stderr). When you run a program using ptyprocess, all three of its standard\nstreams are connected to a single pty:\n\n.. image:: images/pty_vs_popen.png\n\nA pty also does more than a pipe. It keeps track of the window size (rows and\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\nSIGINT to be sent to the child process.\n\nMany command line programs behave differently if they detect that stdin or stdout\nis connected to a terminal instead of a pipe (using \n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\nthat they're being used interactively by a human user.\nThey may format output differently (e.g. ``ls`` lists files in columns)\nor prompt the user to confirm actions.\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\n\n.. seealso::\n\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\n Detailed article by Linus Akesson\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"4"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = _build\n\n# User-friendly check for sphinx-build\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\nendif\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" xml to make Docutils-native XML files\"\n\t@echo \" pseudoxml to make pseudoxml-XML files for display purposes\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\trm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\nlatexpdfja:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through platex and dvipdfmx...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\nxml:\n\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\n\t@echo\n\t@echo \"Build finished. The XML files are in $(BUILDDIR)/xml.\"\n\npseudoxml:\n\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\n\t@echo\n\t@echo \"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\"\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"5"},{"content":"# -*- coding: utf-8 -*-\n#\n# Ptyprocess documentation build configuration file, created by\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\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\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.insert(0, os.path.abspath('..'))\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.viewcode',\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'Ptyprocess'\ncopyright = u'2014, Thomas Kluyver'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.7'\n# The full version, including alpha/beta/rc tags.\nrelease = version #+ '.2'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\n\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#html_extra_path = []\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'Ptyprocessdoc'\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\n [u'Thomas Kluyver'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {'http://docs.python.org/': None}\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"6"},{"content":"Ptyprocess API\n==============\n\n.. module:: ptyprocess\n\n.. autoclass:: PtyProcess\n\n .. automethod:: spawn\n\n .. automethod:: read\n\n .. automethod:: readline\n\n .. automethod:: write\n\n .. automethod:: sendcontrol\n\n .. automethod:: sendeof\n\n .. automethod:: sendintr\n\n .. automethod:: getecho\n\n .. automethod:: waitnoecho\n\n .. automethod:: setecho\n\n .. automethod:: getwinsize\n\n .. automethod:: setwinsize\n\n .. automethod:: eof\n\n .. automethod:: isalive\n\n .. automethod:: wait\n\n .. automethod:: kill\n\n .. automethod:: terminate\n\n .. automethod:: close\n\n.. autoclass:: PtyProcessUnicode\n\n[end of docs/api.rst]","filename":"docs/api.rst","id":"7"},{"content":"try:\n from shutil import which # Python >= 3.3\nexcept ImportError:\n import os, sys\n \n # This is copied from Python 3.4.1\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\n \"\"\"Given a command, mode, and a PATH string, return the path which\n conforms to the given mode on the PATH, or None if there is no such\n file.\n \n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\n of os.environ.get(\"PATH\"), or can be overridden with a custom search\n path.\n \n \"\"\"\n # Check that a given file can be accessed with the correct mode.\n # Additionally check that `file` is not a directory, as on Windows\n # directories pass the os.access check.\n def _access_check(fn, mode):\n return (os.path.exists(fn) and os.access(fn, mode)\n and not os.path.isdir(fn))\n \n # If we're given a path with a directory part, look it up directly rather\n # than referring to PATH directories. This includes checking relative to the\n # current directory, e.g. ./script\n if os.path.dirname(cmd):\n if _access_check(cmd, mode):\n return cmd\n return None\n \n if path is None:\n path = os.environ.get(\"PATH\", os.defpath)\n if not path:\n return None\n path = path.split(os.pathsep)\n \n if sys.platform == \"win32\":\n # The current directory takes precedence on Windows.\n if not os.curdir in path:\n path.insert(0, os.curdir)\n \n # PATHEXT is necessary to check on Windows.\n pathext = os.environ.get(\"PATHEXT\", \"\").split(os.pathsep)\n # See if the given file matches any of the expected path extensions.\n # This will allow us to short circuit when given \"python.exe\".\n # If it does match, only test that one, otherwise we have to try\n # others.\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\n files = [cmd]\n else:\n files = [cmd + ext for ext in pathext]\n else:\n # On other platforms you don't have things like PATHEXT to tell you\n # what file suffixes are executable, so just pass on cmd as-is.\n files = [cmd]\n \n seen = set()\n for dir in path:\n normdir = os.path.normcase(dir)\n if not normdir in seen:\n seen.add(normdir)\n for thefile in files:\n name = os.path.join(dir, thefile)\n if _access_check(name, mode):\n return name\n return None\n\n\nclass PtyProcessError(Exception):\n \"\"\"Generic error class for this package.\"\"\"\n\n[end of ptyprocess/util.py]","filename":"ptyprocess/util.py","id":"8"},{"content":"\"\"\"Substitute for the forkpty system call, to support Solaris.\n\"\"\"\nimport os\nimport errno\n\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\nfrom .util import PtyProcessError\n\ndef fork_pty():\n '''This implements a substitute for the forkpty system call. This\n should be more portable than the pty.fork() function. Specifically,\n this should work on Solaris.\n\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\n resolve the issue with Python's pty.fork() not supporting Solaris,\n particularly ssh. Based on patch to posixmodule.c authored by Noah\n Spurrier::\n\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\n\n '''\n\n parent_fd, child_fd = os.openpty()\n if parent_fd < 0 or child_fd < 0:\n raise OSError(\"os.openpty() failed\")\n\n pid = os.fork()\n if pid == CHILD:\n # Child.\n os.close(parent_fd)\n pty_make_controlling_tty(child_fd)\n\n os.dup2(child_fd, STDIN_FILENO)\n os.dup2(child_fd, STDOUT_FILENO)\n os.dup2(child_fd, STDERR_FILENO)\n\n else:\n # Parent.\n os.close(child_fd)\n\n return pid, parent_fd\n\ndef pty_make_controlling_tty(tty_fd):\n '''This makes the pseudo-terminal the controlling tty. This should be\n more portable than the pty.fork() function. Specifically, this should\n work on Solaris. '''\n\n child_name = os.ttyname(tty_fd)\n\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\n # if there was no controlling tty to begin with, such as when\n # executed by a cron(1) job.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n os.setsid()\n\n # Verify we are disconnected from controlling tty by attempting to open\n # it again. We expect that OSError of ENXIO should always be raised.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n raise PtyProcessError(\"OSError of errno.ENXIO should be raised.\")\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n # Verify we can open child pty.\n fd = os.open(child_name, os.O_RDWR)\n os.close(fd)\n\n # Verify we now have a controlling tty.\n fd = os.open(\"/dev/tty\", os.O_WRONLY)\n os.close(fd)\n\n[end of ptyprocess/_fork_pty.py]","filename":"ptyprocess/_fork_pty.py","id":"9"},{"content":"import codecs\nimport errno\nimport fcntl\nimport io\nimport os\nimport pty\nimport resource\nimport signal\nimport struct\nimport sys\nimport termios\nimport time\n\ntry:\n import builtins # Python 3\nexcept ImportError:\n import __builtin__ as builtins # Python 2\n\n# Constants\nfrom pty import (STDIN_FILENO, CHILD)\n\nfrom .util import which, PtyProcessError\n\n_platform = sys.platform.lower()\n\n# Solaris uses internal __fork_pty(). All others use pty.fork().\n_is_solaris = (\n _platform.startswith('solaris') or\n _platform.startswith('sunos'))\n\nif _is_solaris:\n use_native_pty_fork = False\n from . import _fork_pty\nelse:\n use_native_pty_fork = True\n\nPY3 = sys.version_info[0] >= 3\n\nif PY3:\n def _byte(i):\n return bytes([i])\nelse:\n def _byte(i):\n return chr(i)\n \n class FileNotFoundError(OSError): pass\n class TimeoutError(OSError): pass\n\n_EOF, _INTR = None, None\n\ndef _make_eof_intr():\n \"\"\"Set constants _EOF and _INTR.\n \n This avoids doing potentially costly operations on module load.\n \"\"\"\n global _EOF, _INTR\n if (_EOF is not None) and (_INTR is not None):\n return\n\n # inherit EOF and INTR definitions from controlling process.\n try:\n from termios import VEOF, VINTR\n fd = None\n for name in 'stdin', 'stdout':\n stream = getattr(sys, '__%s__' % name, None)\n if stream is None or not hasattr(stream, 'fileno'):\n continue\n try:\n fd = stream.fileno()\n except ValueError:\n continue\n if fd is None:\n # no fd, raise ValueError to fallback on CEOF, CINTR\n raise ValueError(\"No stream has a fileno\")\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\n except (ImportError, OSError, IOError, ValueError, termios.error):\n # unless the controlling process is also not a terminal,\n # such as cron(1), or when stdin and stdout are both closed.\n # Fall-back to using CEOF and CINTR. There\n try:\n from termios import CEOF, CINTR\n (intr, eof) = (CINTR, CEOF)\n except ImportError:\n # ^C, ^D\n (intr, eof) = (3, 4)\n \n _INTR = _byte(intr)\n _EOF = _byte(eof)\n\n# setecho and setwinsize are pulled out here because on some platforms, we need\n# to do this from the child before we exec()\n \ndef _setecho(fd, state):\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\n\n try:\n attr = termios.tcgetattr(fd)\n except termios.error as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n if state:\n attr[3] = attr[3] | termios.ECHO\n else:\n attr[3] = attr[3] & ~termios.ECHO\n\n try:\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\n # blocked on some platforms. TCSADRAIN would probably be ideal.\n termios.tcsetattr(fd, termios.TCSANOW, attr)\n except IOError as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\ndef _setwinsize(fd, rows, cols):\n # Some very old platforms have a bug that causes the value for\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\n # around this, but it caused problems with newer platforms so has been\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\n # Note, assume ws_xpixel and ws_ypixel are zero.\n s = struct.pack('HHHH', rows, cols, 0, 0)\n fcntl.ioctl(fd, TIOCSWINSZ, s)\n\nclass PtyProcess(object):\n '''This class represents a process running in a pseudoterminal.\n \n The main constructor is the :meth:`spawn` classmethod.\n '''\n string_type = bytes\n if PY3:\n linesep = os.linesep.encode('ascii')\n crlf = '\\r\\n'.encode('ascii')\n\n @staticmethod\n def write_to_stdout(b):\n try:\n return sys.stdout.buffer.write(b)\n except AttributeError:\n # If stdout has been replaced, it may not have .buffer\n return sys.stdout.write(b.decode('ascii', 'replace'))\n else:\n linesep = os.linesep\n crlf = '\\r\\n'\n write_to_stdout = sys.stdout.write\n\n encoding = None\n \n argv = None\n env = None\n launch_dir = None\n\n def __init__(self, pid, fd):\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\n self.pid = pid\n self.fd = fd\n readf = io.open(fd, 'rb', buffering=0)\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\n self.fileobj = io.BufferedRWPair(readf, writef)\n\n self.terminated = False\n self.closed = False\n self.exitstatus = None\n self.signalstatus = None\n # status returned by os.waitpid\n self.status = None\n self.flag_eof = False\n # Used by close() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterclose = 0.1\n # Used by terminate() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterterminate = 0.1\n\n @classmethod\n def spawn(\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\n dimensions=(24, 80), pass_fds=()):\n '''Start the given command in a child process in a pseudo terminal.\n\n This does all the fork/exec type of stuff for a pty, and returns an\n instance of PtyProcess.\n\n If preexec_fn is supplied, it will be called with no arguments in the\n child process before exec-ing the specified command.\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\n\n Dimensions of the psuedoterminal used for the subprocess can be\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\n\n By default, all file descriptors except 0, 1 and 2 are closed. This\n behavior can be overridden with pass_fds, a list of file descriptors to\n keep open between the parent and the child.\n '''\n # Note that it is difficult for this method to fail.\n # You cannot detect if the child process cannot start.\n # So the only way you can tell if the child process started\n # or not is to try to read from the file descriptor. If you get\n # EOF immediately then it means that the child is already dead.\n # That may not necessarily be bad because you may have spawned a child\n # that performs some task; creates no stdout output; and then dies.\n\n if not isinstance(argv, (list, tuple)):\n raise TypeError(\"Expected a list or tuple for argv, got %r\" % argv)\n\n # Shallow copy of argv so we can modify it\n argv = argv[:]\n command = argv[0]\n\n command_with_path = which(command)\n if command_with_path is None:\n raise FileNotFoundError('The command was not found or was not ' +\n 'executable: %s.' % command)\n command = command_with_path\n argv[0] = command\n\n # [issue #119] To prevent the case where exec fails and the user is\n # stuck interacting with a python child process instead of whatever\n # was expected, we implement the solution from\n # http://stackoverflow.com/a/3703179 to pass the exception to the\n # parent process\n\n # [issue #119] 1. Before forking, open a pipe in the parent process.\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\n\n if use_native_pty_fork:\n pid, fd = pty.fork()\n else:\n # Use internal fork_pty, for Solaris\n pid, fd = _fork_pty.fork_pty()\n\n # Some platforms must call setwinsize() and setecho() from the\n # child process, and others from the master process. We do both,\n # allowing IOError for either.\n\n if pid == CHILD:\n # set window size\n try:\n _setwinsize(STDIN_FILENO, *dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # disable echo if spawn argument echo was unset\n if not echo:\n try:\n _setecho(STDIN_FILENO, False)\n except (IOError, termios.error) as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # [issue #119] 3. The child closes the reading end and sets the\n # close-on-exec flag for the writing end.\n os.close(exec_err_pipe_read)\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\n\n # Do not allow child to inherit open file descriptors from parent,\n # with the exception of the exec_err_pipe_write of the pipe\n # and pass_fds.\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\n # occasionally raises out of range error\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\n os.closerange(pair[0]+1, pair[1])\n\n if cwd is not None:\n os.chdir(cwd)\n\n if preexec_fn is not None:\n try:\n preexec_fn()\n except Exception as e:\n ename = type(e).__name__\n tosend = '{}:0:{}'.format(ename, str(e))\n if PY3:\n tosend = tosend.encode('utf-8')\n\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(1)\n\n try:\n if env is None:\n os.execv(command, argv)\n else:\n os.execvpe(command, argv, env)\n except OSError as err:\n # [issue #119] 5. If exec fails, the child writes the error\n # code back to the parent using the pipe, then exits.\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\n if PY3:\n tosend = tosend.encode('utf-8')\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(os.EX_OSERR)\n\n # Parent\n inst = cls(pid, fd)\n \n # Set some informational attributes\n inst.argv = argv\n if env is not None:\n inst.env = env\n if cwd is not None:\n inst.launch_dir = cwd\n\n # [issue #119] 2. After forking, the parent closes the writing end\n # of the pipe and reads from the reading end.\n os.close(exec_err_pipe_write)\n exec_err_data = os.read(exec_err_pipe_read, 4096)\n os.close(exec_err_pipe_read)\n\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\n # child successfully performed exec, since close-on-exec made\n # successful exec close the writing end of the pipe. Or, if exec\n # failed, the parent reads the error code and can proceed\n # accordingly. Either way, the parent blocks until the child calls\n # exec.\n if len(exec_err_data) != 0:\n try:\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\n\n exception = exctype(errmsg.decode('utf-8', 'replace'))\n if exctype is OSError:\n exception.errno = int(errno_s)\n except:\n raise Exception('Subprocess failed, got bad error data: %r'\n % exec_err_data)\n else:\n raise exception\n\n try:\n inst.setwinsize(*dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\n raise\n\n return inst\n\n def __repr__(self):\n clsname = type(self).__name__\n if self.argv is not None:\n args = [repr(self.argv)]\n if self.env is not None:\n args.append(\"env=%r\" % self.env)\n if self.launch_dir is not None:\n args.append(\"cwd=%r\" % self.launch_dir)\n \n return \"{}.spawn({})\".format(clsname, \", \".join(args))\n \n else:\n return \"{}(pid={}, fd={})\".format(clsname, self.pid, self.fd)\n\n @staticmethod\n def _coerce_send_string(s):\n if not isinstance(s, bytes):\n return s.encode('utf-8')\n return s\n\n @staticmethod\n def _coerce_read_string(s):\n return s\n\n def __del__(self):\n '''This makes sure that no system resources are left open. Python only\n garbage collects Python objects. OS file descriptors are not Python\n objects, so they must be handled explicitly. If the child file\n descriptor was opened outside of this class (passed to the constructor)\n then this does not close it. '''\n\n if not self.closed:\n # It is possible for __del__ methods to execute during the\n # teardown of the Python VM itself. Thus self.close() may\n # trigger an exception because os.close may be None.\n try:\n self.close()\n # which exception, shouldn't we catch explicitly .. ?\n except:\n pass\n\n\n def fileno(self):\n '''This returns the file descriptor of the pty for the child.\n '''\n return self.fd\n\n def close(self, force=True):\n '''This closes the connection with the child application. Note that\n calling close() more than once is valid. This emulates standard Python\n behavior with files. Set force to True if you want to make sure that\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\n and SIGINT). '''\n if not self.closed:\n self.flush()\n self.fileobj.close() # Closes the file descriptor\n # Give kernel time to update process status.\n time.sleep(self.delayafterclose)\n if self.isalive():\n if not self.terminate(force):\n raise PtyProcessError('Could not terminate the child.')\n self.fd = -1\n self.closed = True\n #self.pid = None\n\n def flush(self):\n '''This does nothing. It is here to support the interface for a\n File-like object. '''\n\n pass\n\n def isatty(self):\n '''This returns True if the file descriptor is open and connected to a\n tty(-like) device, else False.\n\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\n the child pty may not appear as a terminal device. This means\n methods such as setecho(), setwinsize(), getwinsize() may raise an\n IOError. '''\n\n return os.isatty(self.fd)\n\n def waitnoecho(self, timeout=None):\n '''Wait until the terminal ECHO flag is set False.\n\n This returns True if the echo mode is off, or False if echo was not\n disabled before the timeout. This can be used to detect when the\n child is waiting for a password. Usually a child application will turn\n off echo mode when it is waiting for the user to enter a password. For\n example, instead of expecting the \"password:\" prompt you can wait for\n the child to turn echo off::\n\n p = pexpect.spawn('ssh user@example.com')\n p.waitnoecho()\n p.sendline(mypassword)\n\n If ``timeout=None`` then this method to block until ECHO flag is False.\n '''\n\n if timeout is not None:\n end_time = time.time() + timeout\n while True:\n if not self.getecho():\n return True\n if timeout < 0 and timeout is not None:\n return False\n if timeout is not None:\n timeout = end_time - time.time()\n time.sleep(0.1)\n\n def getecho(self):\n '''Returns True if terminal echo is on, or False if echo is off.\n\n Child applications that are expecting you to enter a password often\n disable echo. See also :meth:`waitnoecho`.\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n\n try:\n attr = termios.tcgetattr(self.fd)\n except termios.error as err:\n errmsg = 'getecho() may not be called on this platform'\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n self.echo = bool(attr[3] & termios.ECHO)\n return self.echo\n\n def setecho(self, state):\n '''Enable or disable terminal echo.\n\n Anything the child sent before the echo will be lost, so you should be\n sure that your input buffer is empty before you call setecho().\n For example, the following will work as expected::\n\n p = pexpect.spawn('cat') # Echo is on by default.\n p.sendline('1234') # We expect see this twice from the child...\n p.expect(['1234']) # ... once from the tty echo...\n p.expect(['1234']) # ... and again from cat itself.\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n The following WILL NOT WORK because the lines sent before the setecho\n will be lost::\n\n p = pexpect.spawn('cat')\n p.sendline('1234')\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['1234'])\n p.expect(['1234'])\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n _setecho(self.fd, state)\n\n self.echo = state\n\n def read(self, size=1024):\n \"\"\"Read and return at most ``size`` bytes from the pty.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\n with the vagaries of EOF on platforms that do strange things, like IRIX\n or older Solaris systems. It handles the errno=EIO pattern used on\n Linux, and the empty-string return used on BSD platforms and (seemingly)\n on recent Solaris.\n \"\"\"\n try:\n s = self.fileobj.read1(size)\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n try:\n s = self.fileobj.readline()\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def _writeb(self, b, flush=True):\n n = self.fileobj.write(b)\n if flush:\n self.fileobj.flush()\n return n\n\n def write(self, s, flush=True):\n \"\"\"Write bytes to the pseudoterminal.\n \n Returns the number of bytes written.\n \"\"\"\n return self._writeb(s, flush=flush)\n\n def sendcontrol(self, char):\n '''Helper method for sending control characters to the terminal.\n\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\a'``)::\n\n child.sendcontrol('g')\n\n See also, :meth:`sendintr` and :meth:`sendeof`.\n '''\n char = char.lower()\n a = ord(char)\n if 97 <= a <= 122:\n a = a - ord('a') + 1\n byte = _byte(a)\n return self._writeb(byte), byte\n d = {'@': 0, '`': 0,\n '[': 27, '{': 27,\n '\\\\': 28, '|': 28,\n ']': 29, '}': 29,\n '^': 30, '~': 30,\n '_': 31,\n '?': 127}\n if char not in d:\n return 0, b''\n\n byte = _byte(d[char])\n return self._writeb(byte), byte\n\n def sendeof(self):\n '''Sends an EOF (typically Ctrl-D) through the terminal.\n\n This sends a character which causes\n the pending parent output buffer to be sent to the waiting child\n program without waiting for end-of-line. If it is the first character\n of the line, the read() in the user program returns 0, which signifies\n end-of-file. This means to work as expected a sendeof() has to be\n called at the beginning of a line. This method does not send a newline.\n It is the responsibility of the caller to ensure the eof is sent at the\n beginning of a line.\n '''\n return self._writeb(_EOF), _EOF\n\n def sendintr(self):\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\n\n This will normally trigger the kernel to send SIGINT to the current\n foreground process group. Processes can turn off this translation, in\n which case they can read the raw data sent, e.g. ``b'\\\\x03'`` for Ctrl-C.\n\n See also the :meth:`kill` method, which sends a signal directly to the\n immediate child process in the terminal (which is not necessarily the\n foreground process).\n '''\n return self._writeb(_INTR), _INTR\n\n def eof(self):\n '''This returns True if the EOF exception was ever raised.\n '''\n\n return self.flag_eof\n\n def terminate(self, force=False):\n '''This forces a child process to terminate. It starts nicely with\n SIGHUP and SIGINT. If \"force\" is True then moves onto SIGKILL. This\n returns True if the child was terminated. This returns False if the\n child could not be terminated. '''\n\n if not self.isalive():\n return True\n try:\n self.kill(signal.SIGHUP)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGCONT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGINT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n if force:\n self.kill(signal.SIGKILL)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n return False\n except OSError:\n # I think there are kernel timing issues that sometimes cause\n # this to happen. I think isalive() reports True, but the\n # process is dead to the kernel.\n # Make one last attempt to see if the kernel is up to date.\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n\n def wait(self):\n '''This waits until the child exits. This is a blocking call. This will\n not read any data from the child, so this will block forever if the\n child has unread output and has terminated. In other words, the child\n may have printed output then called exit(), but, the child is\n technically still alive until its output is read by the parent. '''\n\n if self.isalive():\n pid, status = os.waitpid(self.pid, 0)\n else:\n return self.exitstatus\n self.exitstatus = os.WEXITSTATUS(status)\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status): # pragma: no cover\n # You can't call wait() on a child process in the stopped state.\n raise PtyProcessError('Called wait() on a stopped child ' +\n 'process. This is not supported. Is some other ' +\n 'process attempting job control with our child pid?')\n return self.exitstatus\n\n def isalive(self):\n '''This tests if the child process is running or not. This is\n non-blocking. If the child was terminated then this will read the\n exitstatus or signalstatus of the child. This returns True if the child\n process appears to be running or False if not. It can take literally\n SECONDS for Solaris to return the right status. '''\n\n if self.terminated:\n return False\n\n if self.flag_eof:\n # This is for Linux, which requires the blocking form\n # of waitpid to get the status of a defunct process.\n # This is super-lame. The flag_eof would have been set\n # in read_nonblocking(), so this should be safe.\n waitpid_options = 0\n else:\n waitpid_options = os.WNOHANG\n\n try:\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e:\n # No child processes\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'where \"terminated\" is 0, but there was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # I have to do this twice for Solaris.\n # I can't even believe that I figured this out...\n # If waitpid() returns 0 it means that no child process\n # wishes to report, and the value of status is undefined.\n if pid == 0:\n try:\n ### os.WNOHANG) # Solaris!\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e: # pragma: no cover\n # This should never happen...\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'that should never happen. There was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # If pid is still 0 after two calls to waitpid() then the process\n # really is alive. This seems to work on all platforms, except for\n # Irix which seems to require a blocking call on waitpid or select,\n # so I let read_nonblocking take care of this situation\n # (unfortunately, this requires waiting through the timeout).\n if pid == 0:\n return True\n\n if pid == 0:\n return True\n\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status):\n raise PtyProcessError('isalive() encountered condition ' +\n 'where child process is stopped. This is not ' +\n 'supported. Is some other process attempting ' +\n 'job control with our child pid?')\n return False\n\n def kill(self, sig):\n \"\"\"Send the given signal to the child application.\n\n In keeping with UNIX tradition it has a misleading name. It does not\n necessarily kill the child unless you send the right signal. See the\n :mod:`signal` module for constants representing signal numbers.\n \"\"\"\n\n # Same as os.kill, but the pid is given for you.\n if self.isalive():\n os.kill(self.pid, sig)\n\n def getwinsize(self):\n \"\"\"Return the window size of the pseudoterminal as a tuple (rows, cols).\n \"\"\"\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\n s = struct.pack('HHHH', 0, 0, 0, 0)\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\n return struct.unpack('HHHH', x)[0:2]\n\n def setwinsize(self, rows, cols):\n \"\"\"Set the terminal window size of the child tty.\n\n This will cause a SIGWINCH signal to be sent to the child. This does not\n change the physical window size. It changes the size reported to\n TTY-aware applications like vi or curses -- applications that respond to\n the SIGWINCH signal.\n \"\"\"\n return _setwinsize(self.fd, rows, cols)\n\n\nclass PtyProcessUnicode(PtyProcess):\n \"\"\"Unicode wrapper around a process running in a pseudoterminal.\n\n This class exposes a similar interface to :class:`PtyProcess`, but its read\n methods return unicode, and its :meth:`write` accepts unicode.\n \"\"\"\n if PY3:\n string_type = str\n else:\n string_type = unicode # analysis:ignore\n\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\n super(PtyProcessUnicode, self).__init__(pid, fd)\n self.encoding = encoding\n self.codec_errors = codec_errors\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\n\n def read(self, size=1024):\n \"\"\"Read at most ``size`` bytes from the pty, return them as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n\n The size argument still refers to bytes, not unicode code points.\n \"\"\"\n b = super(PtyProcessUnicode, self).read(size)\n return self.decoder.decode(b, final=False)\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n b = super(PtyProcessUnicode, self).readline()\n return self.decoder.decode(b, final=False)\n\n def write(self, s):\n \"\"\"Write the unicode string ``s`` to the pseudoterminal.\n\n Returns the number of bytes written.\n \"\"\"\n b = s.encode(self.encoding)\n return super(PtyProcessUnicode, self).write(b)\n\n[end of ptyprocess/ptyprocess.py]","filename":"ptyprocess/ptyprocess.py","id":"10"},{"content":"\"\"\"Run a subprocess in a pseudo terminal\"\"\"\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\n\n__version__ = '0.7.0'\n\n[end of ptyprocess/__init__.py]","filename":"ptyprocess/__init__.py","id":"11"},{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\n\n<svg\n xmlns:dc=\"http://purl.org/dc/elements/1.1/\"\n xmlns:cc=\"http://creativecommons.org/ns#\"\n xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n xmlns:svg=\"http://www.w3.org/2000/svg\"\n xmlns=\"http://www.w3.org/2000/svg\"\n xmlns:sodipodi=\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\"\n xmlns:inkscape=\"http://www.inkscape.org/namespaces/inkscape\"\n width=\"554.44196\"\n height=\"327.38452\"\n id=\"svg2\"\n version=\"1.1\"\n inkscape:version=\"0.48.4 r9939\"\n sodipodi:docname=\"pty_vs_popen.svg\">\n <defs\n id=\"defs4\">\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM\"\n style=\"overflow:visible\">\n <path\n id=\"path3838\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3783\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(1.1,0,0,1.1,1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Tail\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Tail\"\n style=\"overflow:visible\">\n <g\n id=\"g3801\"\n transform=\"scale(-1.2,-1.2)\">\n <path\n id=\"path3803\"\n d=\"M -3.8048674,-3.9585227 0.54352094,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3805\"\n d=\"M -1.2866832,-3.9585227 3.0617053,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3807\"\n d=\"M 1.3053582,-3.9585227 5.6537466,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3809\"\n d=\"M -3.8048674,4.1775838 0.54352094,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3811\"\n d=\"M -1.2866832,4.1775838 3.0617053,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3813\"\n d=\"M 1.3053582,4.1775838 5.6537466,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n </g>\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3765\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(0.8,0,0,0.8,10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3786\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3768\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(-0.8,0,0,-0.8,-10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-9\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-2\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-6\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-27\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM-5\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3838-7\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10742\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10744\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10746\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10748\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10750\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10752\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10754\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10756\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10758\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10760\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n </defs>\n <sodipodi:namedview\n id=\"base\"\n pagecolor=\"#ffffff\"\n bordercolor=\"#666666\"\n borderopacity=\"1.0\"\n inkscape:pageopacity=\"0.0\"\n inkscape:pageshadow=\"2\"\n inkscape:zoom=\"0.98994949\"\n inkscape:cx=\"77.797977\"\n inkscape:cy=\"137.24456\"\n inkscape:document-units=\"px\"\n inkscape:current-layer=\"layer1\"\n showgrid=\"false\"\n inkscape:window-width=\"1301\"\n inkscape:window-height=\"744\"\n inkscape:window-x=\"65\"\n inkscape:window-y=\"24\"\n inkscape:window-maximized=\"1\"\n fit-margin-top=\"1\"\n fit-margin-left=\"1\"\n fit-margin-right=\"1\"\n fit-margin-bottom=\"1\"\n units=\"cm\" />\n <metadata\n id=\"metadata7\">\n <rdf:RDF>\n <cc:Work\n rdf:about=\"\">\n <dc:format>image/svg+xml</dc:format>\n <dc:type\n rdf:resource=\"http://purl.org/dc/dcmitype/StillImage\" />\n <dc:title></dc:title>\n </cc:Work>\n </rdf:RDF>\n </metadata>\n <g\n inkscape:label=\"Layer 1\"\n inkscape:groupmode=\"layer\"\n id=\"layer1\"\n transform=\"translate(-40.758533,29.820888)\">\n <g\n id=\"g11880\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591\"\n y=\"240.97427\"\n x=\"138.65004\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.97427\"\n x=\"138.65004\"\n id=\"tspan10593\"\n sodipodi:role=\"line\">Child</tspan></text>\n <g\n id=\"g10626\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991\"\n d=\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7\"\n d=\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\"\n id=\"path2991-7-8\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5637\"\n d=\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5641\"\n d=\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5643\"\n d=\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245\"\n y=\"240.57648\"\n x=\"90\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.57648\"\n x=\"90\"\n id=\"tspan6247\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8\"\n y=\"213.07455\"\n x=\"184.47076\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"213.07455\"\n x=\"184.47076\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8\"\n y=\"262.00311\"\n x=\"192.32663\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"262.00311\"\n x=\"192.32663\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(18,0)\"\n id=\"g11773\">\n <g\n id=\"g11763\">\n <rect\n y=\"120.8597\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308\"\n y=\"129.96561\"\n x=\"63.277264\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"129.96561\"\n x=\"63.277264\"\n id=\"tspan6310\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g11768\">\n <rect\n y=\"135.43114\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304\"\n y=\"144.58977\"\n x=\"64.540932\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"144.58977\"\n x=\"64.540932\"\n id=\"tspan6306\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(54,-16)\"\n id=\"g10674\">\n <g\n id=\"g10664\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(86.857134,-15.571435)\"\n id=\"g10674-6\">\n <g\n id=\"g10664-6\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0-5\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-9\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7-6\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669-5\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5-3\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6-1\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726\"\n y=\"139.6479\"\n x=\"135.03683\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"139.6479\"\n x=\"135.03683\"\n id=\"tspan10728\"\n sodipodi:role=\"line\">Popen</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-89\"\n y=\"158.43169\"\n x=\"234.46947\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-24\"\n style=\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\"\n y=\"158.43169\"\n x=\"234.46947\"\n sodipodi:role=\"line\">pipes</tspan></text>\n </g>\n <g\n id=\"g11847\"\n transform=\"translate(-10,0.39179)\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328-0\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-8\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591-3\"\n y=\"240.5825\"\n x=\"372.50137\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.5825\"\n x=\"372.50137\"\n id=\"tspan10593-2\"\n sodipodi:role=\"line\">Child</tspan></text>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path11075\"\n d=\"m 397.80427,110.64896 0,-52.85714\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\" />\n <g\n id=\"g10626-5\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2-4\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334-0\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336-9\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-4\"\n d=\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7-87\"\n d=\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331-7\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\"\n id=\"path2991-7-8-4\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-6\"\n y=\"240.18468\"\n x=\"323.85132\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.18468\"\n x=\"323.85132\"\n id=\"tspan6247-3\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-6\"\n y=\"207.68279\"\n x=\"410.10779\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-2\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"207.68279\"\n x=\"410.10779\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8-1\"\n y=\"261.61133\"\n x=\"426.17795\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298-3\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"261.61133\"\n x=\"426.17795\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(227.5656,-301.02546)\"\n id=\"g11065\">\n <g\n id=\"g11055\">\n <rect\n y=\"421.34998\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55\"\n style=\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6\"\n y=\"431.01376\"\n x=\"159.1624\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"431.01376\"\n x=\"159.1624\"\n id=\"tspan6310-7-9\"\n sodipodi:role=\"line\">slave</tspan></text>\n </g>\n <g\n id=\"g11060\">\n <rect\n y=\"407.25223\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55-9\"\n style=\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6-7\"\n y=\"416.68555\"\n x=\"155.16631\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"416.68555\"\n x=\"155.16631\"\n id=\"tspan6310-7-9-7\"\n sodipodi:role=\"line\">master</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726-9\"\n y=\"116.71899\"\n x=\"429.1268\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"116.71899\"\n x=\"429.1268\"\n id=\"tspan10728-7\"\n sodipodi:role=\"line\">Pseudoterminal</tspan><tspan\n id=\"tspan11761\"\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"136.71899\"\n x=\"429.1268\"\n sodipodi:role=\"line\">(pty)</tspan></text>\n </g>\n </g>\n</svg>\n\n[end of docs/images/pty_vs_popen.svg]","filename":"docs/images/pty_vs_popen.svg","id":"12"},{"content":"None\n[end of docs/images/pty_vs_popen.png]","filename":"docs/images/pty_vs_popen.png","id":"13"}],"string":"[\n {\n \"content\": \"python:\\n version: 3\\n\\n[end of readthedocs.yml]\",\n \"filename\": \"readthedocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"ISC LICENSE\\n\\n This license is approved by the OSI and FSF as GPL-compatible.\\n http://opensource.org/licenses/isc-license.txt\\n\\n Copyright (c) 2013-2014, Pexpect development team\\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\\n\\n Permission to use, copy, modify, and/or distribute this software for any\\n purpose with or without fee is hereby granted, provided that the above\\n copyright notice and this permission notice appear in all copies.\\n \\n THE SOFTWARE IS PROVIDED \\\"AS IS\\\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"flit_core >=2,<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.metadata]\\nmodule = \\\"ptyprocess\\\"\\nauthor = \\\"Thomas Kluyver\\\"\\nauthor-email = \\\"thomas@kluyver.me.uk\\\"\\nhome-page = \\\"https://github.com/pexpect/ptyprocess\\\"\\ndescription-file = \\\"README.rst\\\"\\nrequires-python = \\\">=3.7\\\"\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: ISC License (ISCL)\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Topic :: Terminals\\\"\\n]\\n\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"Launch a subprocess in a pseudo terminal (pty), and interact with both the\\nprocess and its pty.\\n\\nSometimes, piping stdin and stdout is not enough. There might be a password\\nprompt that doesn't read from stdin, output that changes when it's going to a\\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\\nIf you need to automate these things, running the process in a pseudo terminal\\n(pty) is the answer.\\n\\nInterface:\\n\\n.. code:: python\\n\\n from ptyprocess import PtyProcessUnicode\\n p = PtyProcessUnicode.spawn(['python'])\\n p.read(20)\\n p.write('6+6\\\\n')\\n p.read(20)\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"3\"\n },\n {\n \"content\": \"Ptyprocess\\n==========\\n\\n.. include:: ../README.rst\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n\\n api\\n\\nWhat is a pty?\\n--------------\\n\\nA pty is a kernel-level object which processes can write data to and read data\\nfrom, a bit like a pipe.\\n\\nUnlike a pipe, data moves through a single pty in both directions. When you use\\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\\nto three pipes are created for the process's standard streams (stdin, stdout\\nand stderr). When you run a program using ptyprocess, all three of its standard\\nstreams are connected to a single pty:\\n\\n.. image:: images/pty_vs_popen.png\\n\\nA pty also does more than a pipe. It keeps track of the window size (rows and\\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\\nSIGINT to be sent to the child process.\\n\\nMany command line programs behave differently if they detect that stdin or stdout\\nis connected to a terminal instead of a pipe (using \\n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\\nthat they're being used interactively by a human user.\\nThey may format output differently (e.g. ``ls`` lists files in columns)\\nor prompt the user to confirm actions.\\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\\n\\n.. seealso::\\n\\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\\n Detailed article by Linus Akesson\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"4\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = _build\\n\\n# User-friendly check for sphinx-build\\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\\nendif\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n# the i18n builder cannot share the environment and doctrees with the others\\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n\\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" singlehtml to make a single large HTML file\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" devhelp to make HTML files and a Devhelp project\\\"\\n\\t@echo \\\" epub to make an epub\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" latexpdf to make LaTeX files and run them through pdflatex\\\"\\n\\t@echo \\\" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\\\"\\n\\t@echo \\\" text to make text files\\\"\\n\\t@echo \\\" man to make manual pages\\\"\\n\\t@echo \\\" texinfo to make Texinfo files\\\"\\n\\t@echo \\\" info to make Texinfo files and run them through makeinfo\\\"\\n\\t@echo \\\" gettext to make PO message catalogs\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" xml to make Docutils-native XML files\\\"\\n\\t@echo \\\" pseudoxml to make pseudoxml-XML files for display purposes\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\trm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\nsinglehtml:\\n\\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\\\"\\n\\ndevhelp:\\n\\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\\n\\t@echo\\n\\t@echo \\\"Build finished.\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# devhelp\\\"\\n\\nepub:\\n\\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\\n\\t@echo\\n\\t@echo \\\"Build finished. The epub file is in $(BUILDDIR)/epub.\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through (pdf)latex\\\" \\\\\\n\\t \\\"(use \\\\`make latexpdf' here to do that automatically).\\\"\\n\\nlatexpdf:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through pdflatex...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\nlatexpdfja:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through platex and dvipdfmx...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\ntext:\\n\\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\\n\\t@echo\\n\\t@echo \\\"Build finished. The text files are in $(BUILDDIR)/text.\\\"\\n\\nman:\\n\\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\\n\\t@echo\\n\\t@echo \\\"Build finished. The manual pages are in $(BUILDDIR)/man.\\\"\\n\\ntexinfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo\\n\\t@echo \\\"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through makeinfo\\\" \\\\\\n\\t \\\"(use \\\\`make info' here to do that automatically).\\\"\\n\\ninfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo \\\"Running Texinfo files through makeinfo...\\\"\\n\\tmake -C $(BUILDDIR)/texinfo info\\n\\t@echo \\\"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\\\"\\n\\ngettext:\\n\\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\\n\\t@echo\\n\\t@echo \\\"Build finished. The message catalogs are in $(BUILDDIR)/locale.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\nxml:\\n\\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\\n\\t@echo\\n\\t@echo \\\"Build finished. The XML files are in $(BUILDDIR)/xml.\\\"\\n\\npseudoxml:\\n\\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\\n\\t@echo\\n\\t@echo \\\"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\\\"\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n#\\n# Ptyprocess documentation build configuration file, created by\\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\\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\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.insert(0, os.path.abspath('..'))\\n\\n# -- General configuration ------------------------------------------------\\n\\n# If your documentation needs a minimal Sphinx version, state it here.\\n#needs_sphinx = '1.0'\\n\\n# Add any Sphinx extension module names here, as strings. They can be\\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\\n# ones.\\nextensions = [\\n 'sphinx.ext.autodoc',\\n 'sphinx.ext.intersphinx',\\n 'sphinx.ext.viewcode',\\n]\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['_templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8-sig'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = u'Ptyprocess'\\ncopyright = u'2014, Thomas Kluyver'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.7'\\n# The full version, including alpha/beta/rc tags.\\nrelease = version #+ '.2'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of patterns, relative to source directory, that match files and\\n# directories to ignore when looking for source files.\\nexclude_patterns = ['_build']\\n\\n# The reST default role (used for this markup: `text`) to use for all\\n# documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n# If true, keep warnings as \\\"system message\\\" paragraphs in the built documents.\\n#keep_warnings = False\\n\\n\\n# -- Options for HTML output ----------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. See the documentation for\\n# a list of builtin themes.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['_static']\\n\\n# Add any extra paths that contain custom files (such as robots.txt or\\n# .htaccess) here, relative to this directory. These files are copied\\n# directly to the root of the documentation.\\n#html_extra_path = []\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_domain_indices = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, \\\"Created using Sphinx\\\" is shown in the HTML footer. Default is True.\\n#html_show_sphinx = True\\n\\n# If true, \\\"(C) Copyright ...\\\" is shown in the HTML footer. Default is True.\\n#html_show_copyright = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# This is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = None\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'Ptyprocessdoc'\\n\\n\\n# -- Options for LaTeX output ---------------------------------------------\\n\\nlatex_elements = {\\n# The paper size ('letterpaper' or 'a4paper').\\n#'papersize': 'letterpaper',\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#'pointsize': '10pt',\\n\\n# Additional stuff for the LaTeX preamble.\\n#'preamble': '',\\n}\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title,\\n# author, documentclass [howto, manual, or own class]).\\nlatex_documents = [\\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# If true, show page references after internal links.\\n#latex_show_pagerefs = False\\n\\n# If true, show URL addresses after external links.\\n#latex_show_urls = False\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_domain_indices = True\\n\\n\\n# -- Options for manual page output ---------------------------------------\\n\\n# One entry per manual page. List of tuples\\n# (source start file, name, description, authors, manual section).\\nman_pages = [\\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\\n [u'Thomas Kluyver'], 1)\\n]\\n\\n# If true, show URL addresses after external links.\\n#man_show_urls = False\\n\\n\\n# -- Options for Texinfo output -------------------------------------------\\n\\n# Grouping the document tree into Texinfo files. List of tuples\\n# (source start file, target name, title, author,\\n# dir menu entry, description, category)\\ntexinfo_documents = [\\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\\n 'Miscellaneous'),\\n]\\n\\n# Documents to append as an appendix to all manuals.\\n#texinfo_appendices = []\\n\\n# If false, no module index is generated.\\n#texinfo_domain_indices = True\\n\\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\\n#texinfo_show_urls = 'footnote'\\n\\n# If true, do not generate a @detailmenu in the \\\"Top\\\" node's menu.\\n#texinfo_no_detailmenu = False\\n\\n\\n# Example configuration for intersphinx: refer to the Python standard library.\\nintersphinx_mapping = {'http://docs.python.org/': None}\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Ptyprocess API\\n==============\\n\\n.. module:: ptyprocess\\n\\n.. autoclass:: PtyProcess\\n\\n .. automethod:: spawn\\n\\n .. automethod:: read\\n\\n .. automethod:: readline\\n\\n .. automethod:: write\\n\\n .. automethod:: sendcontrol\\n\\n .. automethod:: sendeof\\n\\n .. automethod:: sendintr\\n\\n .. automethod:: getecho\\n\\n .. automethod:: waitnoecho\\n\\n .. automethod:: setecho\\n\\n .. automethod:: getwinsize\\n\\n .. automethod:: setwinsize\\n\\n .. automethod:: eof\\n\\n .. automethod:: isalive\\n\\n .. automethod:: wait\\n\\n .. automethod:: kill\\n\\n .. automethod:: terminate\\n\\n .. automethod:: close\\n\\n.. autoclass:: PtyProcessUnicode\\n\\n[end of docs/api.rst]\",\n \"filename\": \"docs/api.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"try:\\n from shutil import which # Python >= 3.3\\nexcept ImportError:\\n import os, sys\\n \\n # This is copied from Python 3.4.1\\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\\n \\\"\\\"\\\"Given a command, mode, and a PATH string, return the path which\\n conforms to the given mode on the PATH, or None if there is no such\\n file.\\n \\n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\\n of os.environ.get(\\\"PATH\\\"), or can be overridden with a custom search\\n path.\\n \\n \\\"\\\"\\\"\\n # Check that a given file can be accessed with the correct mode.\\n # Additionally check that `file` is not a directory, as on Windows\\n # directories pass the os.access check.\\n def _access_check(fn, mode):\\n return (os.path.exists(fn) and os.access(fn, mode)\\n and not os.path.isdir(fn))\\n \\n # If we're given a path with a directory part, look it up directly rather\\n # than referring to PATH directories. This includes checking relative to the\\n # current directory, e.g. ./script\\n if os.path.dirname(cmd):\\n if _access_check(cmd, mode):\\n return cmd\\n return None\\n \\n if path is None:\\n path = os.environ.get(\\\"PATH\\\", os.defpath)\\n if not path:\\n return None\\n path = path.split(os.pathsep)\\n \\n if sys.platform == \\\"win32\\\":\\n # The current directory takes precedence on Windows.\\n if not os.curdir in path:\\n path.insert(0, os.curdir)\\n \\n # PATHEXT is necessary to check on Windows.\\n pathext = os.environ.get(\\\"PATHEXT\\\", \\\"\\\").split(os.pathsep)\\n # See if the given file matches any of the expected path extensions.\\n # This will allow us to short circuit when given \\\"python.exe\\\".\\n # If it does match, only test that one, otherwise we have to try\\n # others.\\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\\n files = [cmd]\\n else:\\n files = [cmd + ext for ext in pathext]\\n else:\\n # On other platforms you don't have things like PATHEXT to tell you\\n # what file suffixes are executable, so just pass on cmd as-is.\\n files = [cmd]\\n \\n seen = set()\\n for dir in path:\\n normdir = os.path.normcase(dir)\\n if not normdir in seen:\\n seen.add(normdir)\\n for thefile in files:\\n name = os.path.join(dir, thefile)\\n if _access_check(name, mode):\\n return name\\n return None\\n\\n\\nclass PtyProcessError(Exception):\\n \\\"\\\"\\\"Generic error class for this package.\\\"\\\"\\\"\\n\\n[end of ptyprocess/util.py]\",\n \"filename\": \"ptyprocess/util.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Substitute for the forkpty system call, to support Solaris.\\n\\\"\\\"\\\"\\nimport os\\nimport errno\\n\\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\\nfrom .util import PtyProcessError\\n\\ndef fork_pty():\\n '''This implements a substitute for the forkpty system call. This\\n should be more portable than the pty.fork() function. Specifically,\\n this should work on Solaris.\\n\\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\\n resolve the issue with Python's pty.fork() not supporting Solaris,\\n particularly ssh. Based on patch to posixmodule.c authored by Noah\\n Spurrier::\\n\\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\\n\\n '''\\n\\n parent_fd, child_fd = os.openpty()\\n if parent_fd < 0 or child_fd < 0:\\n raise OSError(\\\"os.openpty() failed\\\")\\n\\n pid = os.fork()\\n if pid == CHILD:\\n # Child.\\n os.close(parent_fd)\\n pty_make_controlling_tty(child_fd)\\n\\n os.dup2(child_fd, STDIN_FILENO)\\n os.dup2(child_fd, STDOUT_FILENO)\\n os.dup2(child_fd, STDERR_FILENO)\\n\\n else:\\n # Parent.\\n os.close(child_fd)\\n\\n return pid, parent_fd\\n\\ndef pty_make_controlling_tty(tty_fd):\\n '''This makes the pseudo-terminal the controlling tty. This should be\\n more portable than the pty.fork() function. Specifically, this should\\n work on Solaris. '''\\n\\n child_name = os.ttyname(tty_fd)\\n\\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\\n # if there was no controlling tty to begin with, such as when\\n # executed by a cron(1) job.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n os.setsid()\\n\\n # Verify we are disconnected from controlling tty by attempting to open\\n # it again. We expect that OSError of ENXIO should always be raised.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n raise PtyProcessError(\\\"OSError of errno.ENXIO should be raised.\\\")\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n # Verify we can open child pty.\\n fd = os.open(child_name, os.O_RDWR)\\n os.close(fd)\\n\\n # Verify we now have a controlling tty.\\n fd = os.open(\\\"/dev/tty\\\", os.O_WRONLY)\\n os.close(fd)\\n\\n[end of ptyprocess/_fork_pty.py]\",\n \"filename\": \"ptyprocess/_fork_pty.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"import codecs\\nimport errno\\nimport fcntl\\nimport io\\nimport os\\nimport pty\\nimport resource\\nimport signal\\nimport struct\\nimport sys\\nimport termios\\nimport time\\n\\ntry:\\n import builtins # Python 3\\nexcept ImportError:\\n import __builtin__ as builtins # Python 2\\n\\n# Constants\\nfrom pty import (STDIN_FILENO, CHILD)\\n\\nfrom .util import which, PtyProcessError\\n\\n_platform = sys.platform.lower()\\n\\n# Solaris uses internal __fork_pty(). All others use pty.fork().\\n_is_solaris = (\\n _platform.startswith('solaris') or\\n _platform.startswith('sunos'))\\n\\nif _is_solaris:\\n use_native_pty_fork = False\\n from . import _fork_pty\\nelse:\\n use_native_pty_fork = True\\n\\nPY3 = sys.version_info[0] >= 3\\n\\nif PY3:\\n def _byte(i):\\n return bytes([i])\\nelse:\\n def _byte(i):\\n return chr(i)\\n \\n class FileNotFoundError(OSError): pass\\n class TimeoutError(OSError): pass\\n\\n_EOF, _INTR = None, None\\n\\ndef _make_eof_intr():\\n \\\"\\\"\\\"Set constants _EOF and _INTR.\\n \\n This avoids doing potentially costly operations on module load.\\n \\\"\\\"\\\"\\n global _EOF, _INTR\\n if (_EOF is not None) and (_INTR is not None):\\n return\\n\\n # inherit EOF and INTR definitions from controlling process.\\n try:\\n from termios import VEOF, VINTR\\n fd = None\\n for name in 'stdin', 'stdout':\\n stream = getattr(sys, '__%s__' % name, None)\\n if stream is None or not hasattr(stream, 'fileno'):\\n continue\\n try:\\n fd = stream.fileno()\\n except ValueError:\\n continue\\n if fd is None:\\n # no fd, raise ValueError to fallback on CEOF, CINTR\\n raise ValueError(\\\"No stream has a fileno\\\")\\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\\n except (ImportError, OSError, IOError, ValueError, termios.error):\\n # unless the controlling process is also not a terminal,\\n # such as cron(1), or when stdin and stdout are both closed.\\n # Fall-back to using CEOF and CINTR. There\\n try:\\n from termios import CEOF, CINTR\\n (intr, eof) = (CINTR, CEOF)\\n except ImportError:\\n # ^C, ^D\\n (intr, eof) = (3, 4)\\n \\n _INTR = _byte(intr)\\n _EOF = _byte(eof)\\n\\n# setecho and setwinsize are pulled out here because on some platforms, we need\\n# to do this from the child before we exec()\\n \\ndef _setecho(fd, state):\\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\\n\\n try:\\n attr = termios.tcgetattr(fd)\\n except termios.error as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n if state:\\n attr[3] = attr[3] | termios.ECHO\\n else:\\n attr[3] = attr[3] & ~termios.ECHO\\n\\n try:\\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\\n # blocked on some platforms. TCSADRAIN would probably be ideal.\\n termios.tcsetattr(fd, termios.TCSANOW, attr)\\n except IOError as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\ndef _setwinsize(fd, rows, cols):\\n # Some very old platforms have a bug that causes the value for\\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\\n # around this, but it caused problems with newer platforms so has been\\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\\n # Note, assume ws_xpixel and ws_ypixel are zero.\\n s = struct.pack('HHHH', rows, cols, 0, 0)\\n fcntl.ioctl(fd, TIOCSWINSZ, s)\\n\\nclass PtyProcess(object):\\n '''This class represents a process running in a pseudoterminal.\\n \\n The main constructor is the :meth:`spawn` classmethod.\\n '''\\n string_type = bytes\\n if PY3:\\n linesep = os.linesep.encode('ascii')\\n crlf = '\\\\r\\\\n'.encode('ascii')\\n\\n @staticmethod\\n def write_to_stdout(b):\\n try:\\n return sys.stdout.buffer.write(b)\\n except AttributeError:\\n # If stdout has been replaced, it may not have .buffer\\n return sys.stdout.write(b.decode('ascii', 'replace'))\\n else:\\n linesep = os.linesep\\n crlf = '\\\\r\\\\n'\\n write_to_stdout = sys.stdout.write\\n\\n encoding = None\\n \\n argv = None\\n env = None\\n launch_dir = None\\n\\n def __init__(self, pid, fd):\\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\\n self.pid = pid\\n self.fd = fd\\n readf = io.open(fd, 'rb', buffering=0)\\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\\n self.fileobj = io.BufferedRWPair(readf, writef)\\n\\n self.terminated = False\\n self.closed = False\\n self.exitstatus = None\\n self.signalstatus = None\\n # status returned by os.waitpid\\n self.status = None\\n self.flag_eof = False\\n # Used by close() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterclose = 0.1\\n # Used by terminate() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterterminate = 0.1\\n\\n @classmethod\\n def spawn(\\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\\n dimensions=(24, 80), pass_fds=()):\\n '''Start the given command in a child process in a pseudo terminal.\\n\\n This does all the fork/exec type of stuff for a pty, and returns an\\n instance of PtyProcess.\\n\\n If preexec_fn is supplied, it will be called with no arguments in the\\n child process before exec-ing the specified command.\\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\\n\\n Dimensions of the psuedoterminal used for the subprocess can be\\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\\n\\n By default, all file descriptors except 0, 1 and 2 are closed. This\\n behavior can be overridden with pass_fds, a list of file descriptors to\\n keep open between the parent and the child.\\n '''\\n # Note that it is difficult for this method to fail.\\n # You cannot detect if the child process cannot start.\\n # So the only way you can tell if the child process started\\n # or not is to try to read from the file descriptor. If you get\\n # EOF immediately then it means that the child is already dead.\\n # That may not necessarily be bad because you may have spawned a child\\n # that performs some task; creates no stdout output; and then dies.\\n\\n if not isinstance(argv, (list, tuple)):\\n raise TypeError(\\\"Expected a list or tuple for argv, got %r\\\" % argv)\\n\\n # Shallow copy of argv so we can modify it\\n argv = argv[:]\\n command = argv[0]\\n\\n command_with_path = which(command)\\n if command_with_path is None:\\n raise FileNotFoundError('The command was not found or was not ' +\\n 'executable: %s.' % command)\\n command = command_with_path\\n argv[0] = command\\n\\n # [issue #119] To prevent the case where exec fails and the user is\\n # stuck interacting with a python child process instead of whatever\\n # was expected, we implement the solution from\\n # http://stackoverflow.com/a/3703179 to pass the exception to the\\n # parent process\\n\\n # [issue #119] 1. Before forking, open a pipe in the parent process.\\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\\n\\n if use_native_pty_fork:\\n pid, fd = pty.fork()\\n else:\\n # Use internal fork_pty, for Solaris\\n pid, fd = _fork_pty.fork_pty()\\n\\n # Some platforms must call setwinsize() and setecho() from the\\n # child process, and others from the master process. We do both,\\n # allowing IOError for either.\\n\\n if pid == CHILD:\\n # set window size\\n try:\\n _setwinsize(STDIN_FILENO, *dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # disable echo if spawn argument echo was unset\\n if not echo:\\n try:\\n _setecho(STDIN_FILENO, False)\\n except (IOError, termios.error) as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # [issue #119] 3. The child closes the reading end and sets the\\n # close-on-exec flag for the writing end.\\n os.close(exec_err_pipe_read)\\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\\n\\n # Do not allow child to inherit open file descriptors from parent,\\n # with the exception of the exec_err_pipe_write of the pipe\\n # and pass_fds.\\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\\n # occasionally raises out of range error\\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\\n os.closerange(pair[0]+1, pair[1])\\n\\n if cwd is not None:\\n os.chdir(cwd)\\n\\n if preexec_fn is not None:\\n try:\\n preexec_fn()\\n except Exception as e:\\n ename = type(e).__name__\\n tosend = '{}:0:{}'.format(ename, str(e))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(1)\\n\\n try:\\n if env is None:\\n os.execv(command, argv)\\n else:\\n os.execvpe(command, argv, env)\\n except OSError as err:\\n # [issue #119] 5. If exec fails, the child writes the error\\n # code back to the parent using the pipe, then exits.\\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(os.EX_OSERR)\\n\\n # Parent\\n inst = cls(pid, fd)\\n \\n # Set some informational attributes\\n inst.argv = argv\\n if env is not None:\\n inst.env = env\\n if cwd is not None:\\n inst.launch_dir = cwd\\n\\n # [issue #119] 2. After forking, the parent closes the writing end\\n # of the pipe and reads from the reading end.\\n os.close(exec_err_pipe_write)\\n exec_err_data = os.read(exec_err_pipe_read, 4096)\\n os.close(exec_err_pipe_read)\\n\\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\\n # child successfully performed exec, since close-on-exec made\\n # successful exec close the writing end of the pipe. Or, if exec\\n # failed, the parent reads the error code and can proceed\\n # accordingly. Either way, the parent blocks until the child calls\\n # exec.\\n if len(exec_err_data) != 0:\\n try:\\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\\n\\n exception = exctype(errmsg.decode('utf-8', 'replace'))\\n if exctype is OSError:\\n exception.errno = int(errno_s)\\n except:\\n raise Exception('Subprocess failed, got bad error data: %r'\\n % exec_err_data)\\n else:\\n raise exception\\n\\n try:\\n inst.setwinsize(*dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\\n raise\\n\\n return inst\\n\\n def __repr__(self):\\n clsname = type(self).__name__\\n if self.argv is not None:\\n args = [repr(self.argv)]\\n if self.env is not None:\\n args.append(\\\"env=%r\\\" % self.env)\\n if self.launch_dir is not None:\\n args.append(\\\"cwd=%r\\\" % self.launch_dir)\\n \\n return \\\"{}.spawn({})\\\".format(clsname, \\\", \\\".join(args))\\n \\n else:\\n return \\\"{}(pid={}, fd={})\\\".format(clsname, self.pid, self.fd)\\n\\n @staticmethod\\n def _coerce_send_string(s):\\n if not isinstance(s, bytes):\\n return s.encode('utf-8')\\n return s\\n\\n @staticmethod\\n def _coerce_read_string(s):\\n return s\\n\\n def __del__(self):\\n '''This makes sure that no system resources are left open. Python only\\n garbage collects Python objects. OS file descriptors are not Python\\n objects, so they must be handled explicitly. If the child file\\n descriptor was opened outside of this class (passed to the constructor)\\n then this does not close it. '''\\n\\n if not self.closed:\\n # It is possible for __del__ methods to execute during the\\n # teardown of the Python VM itself. Thus self.close() may\\n # trigger an exception because os.close may be None.\\n try:\\n self.close()\\n # which exception, shouldn't we catch explicitly .. ?\\n except:\\n pass\\n\\n\\n def fileno(self):\\n '''This returns the file descriptor of the pty for the child.\\n '''\\n return self.fd\\n\\n def close(self, force=True):\\n '''This closes the connection with the child application. Note that\\n calling close() more than once is valid. This emulates standard Python\\n behavior with files. Set force to True if you want to make sure that\\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\\n and SIGINT). '''\\n if not self.closed:\\n self.flush()\\n self.fileobj.close() # Closes the file descriptor\\n # Give kernel time to update process status.\\n time.sleep(self.delayafterclose)\\n if self.isalive():\\n if not self.terminate(force):\\n raise PtyProcessError('Could not terminate the child.')\\n self.fd = -1\\n self.closed = True\\n #self.pid = None\\n\\n def flush(self):\\n '''This does nothing. It is here to support the interface for a\\n File-like object. '''\\n\\n pass\\n\\n def isatty(self):\\n '''This returns True if the file descriptor is open and connected to a\\n tty(-like) device, else False.\\n\\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\\n the child pty may not appear as a terminal device. This means\\n methods such as setecho(), setwinsize(), getwinsize() may raise an\\n IOError. '''\\n\\n return os.isatty(self.fd)\\n\\n def waitnoecho(self, timeout=None):\\n '''Wait until the terminal ECHO flag is set False.\\n\\n This returns True if the echo mode is off, or False if echo was not\\n disabled before the timeout. This can be used to detect when the\\n child is waiting for a password. Usually a child application will turn\\n off echo mode when it is waiting for the user to enter a password. For\\n example, instead of expecting the \\\"password:\\\" prompt you can wait for\\n the child to turn echo off::\\n\\n p = pexpect.spawn('ssh user@example.com')\\n p.waitnoecho()\\n p.sendline(mypassword)\\n\\n If ``timeout=None`` then this method to block until ECHO flag is False.\\n '''\\n\\n if timeout is not None:\\n end_time = time.time() + timeout\\n while True:\\n if not self.getecho():\\n return True\\n if timeout < 0 and timeout is not None:\\n return False\\n if timeout is not None:\\n timeout = end_time - time.time()\\n time.sleep(0.1)\\n\\n def getecho(self):\\n '''Returns True if terminal echo is on, or False if echo is off.\\n\\n Child applications that are expecting you to enter a password often\\n disable echo. See also :meth:`waitnoecho`.\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n\\n try:\\n attr = termios.tcgetattr(self.fd)\\n except termios.error as err:\\n errmsg = 'getecho() may not be called on this platform'\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n self.echo = bool(attr[3] & termios.ECHO)\\n return self.echo\\n\\n def setecho(self, state):\\n '''Enable or disable terminal echo.\\n\\n Anything the child sent before the echo will be lost, so you should be\\n sure that your input buffer is empty before you call setecho().\\n For example, the following will work as expected::\\n\\n p = pexpect.spawn('cat') # Echo is on by default.\\n p.sendline('1234') # We expect see this twice from the child...\\n p.expect(['1234']) # ... once from the tty echo...\\n p.expect(['1234']) # ... and again from cat itself.\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n The following WILL NOT WORK because the lines sent before the setecho\\n will be lost::\\n\\n p = pexpect.spawn('cat')\\n p.sendline('1234')\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['1234'])\\n p.expect(['1234'])\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n _setecho(self.fd, state)\\n\\n self.echo = state\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read and return at most ``size`` bytes from the pty.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\\n with the vagaries of EOF on platforms that do strange things, like IRIX\\n or older Solaris systems. It handles the errno=EIO pattern used on\\n Linux, and the empty-string return used on BSD platforms and (seemingly)\\n on recent Solaris.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.read1(size)\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.readline()\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def _writeb(self, b, flush=True):\\n n = self.fileobj.write(b)\\n if flush:\\n self.fileobj.flush()\\n return n\\n\\n def write(self, s, flush=True):\\n \\\"\\\"\\\"Write bytes to the pseudoterminal.\\n \\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n return self._writeb(s, flush=flush)\\n\\n def sendcontrol(self, char):\\n '''Helper method for sending control characters to the terminal.\\n\\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\\\\\a'``)::\\n\\n child.sendcontrol('g')\\n\\n See also, :meth:`sendintr` and :meth:`sendeof`.\\n '''\\n char = char.lower()\\n a = ord(char)\\n if 97 <= a <= 122:\\n a = a - ord('a') + 1\\n byte = _byte(a)\\n return self._writeb(byte), byte\\n d = {'@': 0, '`': 0,\\n '[': 27, '{': 27,\\n '\\\\\\\\': 28, '|': 28,\\n ']': 29, '}': 29,\\n '^': 30, '~': 30,\\n '_': 31,\\n '?': 127}\\n if char not in d:\\n return 0, b''\\n\\n byte = _byte(d[char])\\n return self._writeb(byte), byte\\n\\n def sendeof(self):\\n '''Sends an EOF (typically Ctrl-D) through the terminal.\\n\\n This sends a character which causes\\n the pending parent output buffer to be sent to the waiting child\\n program without waiting for end-of-line. If it is the first character\\n of the line, the read() in the user program returns 0, which signifies\\n end-of-file. This means to work as expected a sendeof() has to be\\n called at the beginning of a line. This method does not send a newline.\\n It is the responsibility of the caller to ensure the eof is sent at the\\n beginning of a line.\\n '''\\n return self._writeb(_EOF), _EOF\\n\\n def sendintr(self):\\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\\n\\n This will normally trigger the kernel to send SIGINT to the current\\n foreground process group. Processes can turn off this translation, in\\n which case they can read the raw data sent, e.g. ``b'\\\\\\\\x03'`` for Ctrl-C.\\n\\n See also the :meth:`kill` method, which sends a signal directly to the\\n immediate child process in the terminal (which is not necessarily the\\n foreground process).\\n '''\\n return self._writeb(_INTR), _INTR\\n\\n def eof(self):\\n '''This returns True if the EOF exception was ever raised.\\n '''\\n\\n return self.flag_eof\\n\\n def terminate(self, force=False):\\n '''This forces a child process to terminate. It starts nicely with\\n SIGHUP and SIGINT. If \\\"force\\\" is True then moves onto SIGKILL. This\\n returns True if the child was terminated. This returns False if the\\n child could not be terminated. '''\\n\\n if not self.isalive():\\n return True\\n try:\\n self.kill(signal.SIGHUP)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGCONT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGINT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n if force:\\n self.kill(signal.SIGKILL)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n return False\\n except OSError:\\n # I think there are kernel timing issues that sometimes cause\\n # this to happen. I think isalive() reports True, but the\\n # process is dead to the kernel.\\n # Make one last attempt to see if the kernel is up to date.\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n\\n def wait(self):\\n '''This waits until the child exits. This is a blocking call. This will\\n not read any data from the child, so this will block forever if the\\n child has unread output and has terminated. In other words, the child\\n may have printed output then called exit(), but, the child is\\n technically still alive until its output is read by the parent. '''\\n\\n if self.isalive():\\n pid, status = os.waitpid(self.pid, 0)\\n else:\\n return self.exitstatus\\n self.exitstatus = os.WEXITSTATUS(status)\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status): # pragma: no cover\\n # You can't call wait() on a child process in the stopped state.\\n raise PtyProcessError('Called wait() on a stopped child ' +\\n 'process. This is not supported. Is some other ' +\\n 'process attempting job control with our child pid?')\\n return self.exitstatus\\n\\n def isalive(self):\\n '''This tests if the child process is running or not. This is\\n non-blocking. If the child was terminated then this will read the\\n exitstatus or signalstatus of the child. This returns True if the child\\n process appears to be running or False if not. It can take literally\\n SECONDS for Solaris to return the right status. '''\\n\\n if self.terminated:\\n return False\\n\\n if self.flag_eof:\\n # This is for Linux, which requires the blocking form\\n # of waitpid to get the status of a defunct process.\\n # This is super-lame. The flag_eof would have been set\\n # in read_nonblocking(), so this should be safe.\\n waitpid_options = 0\\n else:\\n waitpid_options = os.WNOHANG\\n\\n try:\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e:\\n # No child processes\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where \\\"terminated\\\" is 0, but there was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # I have to do this twice for Solaris.\\n # I can't even believe that I figured this out...\\n # If waitpid() returns 0 it means that no child process\\n # wishes to report, and the value of status is undefined.\\n if pid == 0:\\n try:\\n ### os.WNOHANG) # Solaris!\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e: # pragma: no cover\\n # This should never happen...\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'that should never happen. There was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # If pid is still 0 after two calls to waitpid() then the process\\n # really is alive. This seems to work on all platforms, except for\\n # Irix which seems to require a blocking call on waitpid or select,\\n # so I let read_nonblocking take care of this situation\\n # (unfortunately, this requires waiting through the timeout).\\n if pid == 0:\\n return True\\n\\n if pid == 0:\\n return True\\n\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status):\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where child process is stopped. This is not ' +\\n 'supported. Is some other process attempting ' +\\n 'job control with our child pid?')\\n return False\\n\\n def kill(self, sig):\\n \\\"\\\"\\\"Send the given signal to the child application.\\n\\n In keeping with UNIX tradition it has a misleading name. It does not\\n necessarily kill the child unless you send the right signal. See the\\n :mod:`signal` module for constants representing signal numbers.\\n \\\"\\\"\\\"\\n\\n # Same as os.kill, but the pid is given for you.\\n if self.isalive():\\n os.kill(self.pid, sig)\\n\\n def getwinsize(self):\\n \\\"\\\"\\\"Return the window size of the pseudoterminal as a tuple (rows, cols).\\n \\\"\\\"\\\"\\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\\n s = struct.pack('HHHH', 0, 0, 0, 0)\\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\\n return struct.unpack('HHHH', x)[0:2]\\n\\n def setwinsize(self, rows, cols):\\n \\\"\\\"\\\"Set the terminal window size of the child tty.\\n\\n This will cause a SIGWINCH signal to be sent to the child. This does not\\n change the physical window size. It changes the size reported to\\n TTY-aware applications like vi or curses -- applications that respond to\\n the SIGWINCH signal.\\n \\\"\\\"\\\"\\n return _setwinsize(self.fd, rows, cols)\\n\\n\\nclass PtyProcessUnicode(PtyProcess):\\n \\\"\\\"\\\"Unicode wrapper around a process running in a pseudoterminal.\\n\\n This class exposes a similar interface to :class:`PtyProcess`, but its read\\n methods return unicode, and its :meth:`write` accepts unicode.\\n \\\"\\\"\\\"\\n if PY3:\\n string_type = str\\n else:\\n string_type = unicode # analysis:ignore\\n\\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\\n super(PtyProcessUnicode, self).__init__(pid, fd)\\n self.encoding = encoding\\n self.codec_errors = codec_errors\\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read at most ``size`` bytes from the pty, return them as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n\\n The size argument still refers to bytes, not unicode code points.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).read(size)\\n return self.decoder.decode(b, final=False)\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).readline()\\n return self.decoder.decode(b, final=False)\\n\\n def write(self, s):\\n \\\"\\\"\\\"Write the unicode string ``s`` to the pseudoterminal.\\n\\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n b = s.encode(self.encoding)\\n return super(PtyProcessUnicode, self).write(b)\\n\\n[end of ptyprocess/ptyprocess.py]\",\n \"filename\": \"ptyprocess/ptyprocess.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Run a subprocess in a pseudo terminal\\\"\\\"\\\"\\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\\n\\n__version__ = '0.7.0'\\n\\n[end of ptyprocess/__init__.py]\",\n \"filename\": \"ptyprocess/__init__.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"no\\\"?>\\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\\n\\n<svg\\n xmlns:dc=\\\"http://purl.org/dc/elements/1.1/\\\"\\n xmlns:cc=\\\"http://creativecommons.org/ns#\\\"\\n xmlns:rdf=\\\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\\\"\\n xmlns:svg=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns:sodipodi=\\\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\\\"\\n xmlns:inkscape=\\\"http://www.inkscape.org/namespaces/inkscape\\\"\\n width=\\\"554.44196\\\"\\n height=\\\"327.38452\\\"\\n id=\\\"svg2\\\"\\n version=\\\"1.1\\\"\\n inkscape:version=\\\"0.48.4 r9939\\\"\\n sodipodi:docname=\\\"pty_vs_popen.svg\\\">\\n <defs\\n id=\\\"defs4\\\">\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3838\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3783\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(1.1,0,0,1.1,1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Tail\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Tail\\\"\\n style=\\\"overflow:visible\\\">\\n <g\\n id=\\\"g3801\\\"\\n transform=\\\"scale(-1.2,-1.2)\\\">\\n <path\\n id=\\\"path3803\\\"\\n d=\\\"M -3.8048674,-3.9585227 0.54352094,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3805\\\"\\n d=\\\"M -1.2866832,-3.9585227 3.0617053,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3807\\\"\\n d=\\\"M 1.3053582,-3.9585227 5.6537466,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3809\\\"\\n d=\\\"M -3.8048674,4.1775838 0.54352094,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3811\\\"\\n d=\\\"M -1.2866832,4.1775838 3.0617053,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3813\\\"\\n d=\\\"M 1.3053582,4.1775838 5.6537466,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </g>\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3765\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(0.8,0,0,0.8,10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3786\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3768\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(-0.8,0,0,-0.8,-10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-9\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-2\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-6\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-27\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM-5\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3838-7\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10742\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10744\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10746\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10748\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10750\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10752\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10754\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10756\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10758\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10760\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n </defs>\\n <sodipodi:namedview\\n id=\\\"base\\\"\\n pagecolor=\\\"#ffffff\\\"\\n bordercolor=\\\"#666666\\\"\\n borderopacity=\\\"1.0\\\"\\n inkscape:pageopacity=\\\"0.0\\\"\\n inkscape:pageshadow=\\\"2\\\"\\n inkscape:zoom=\\\"0.98994949\\\"\\n inkscape:cx=\\\"77.797977\\\"\\n inkscape:cy=\\\"137.24456\\\"\\n inkscape:document-units=\\\"px\\\"\\n inkscape:current-layer=\\\"layer1\\\"\\n showgrid=\\\"false\\\"\\n inkscape:window-width=\\\"1301\\\"\\n inkscape:window-height=\\\"744\\\"\\n inkscape:window-x=\\\"65\\\"\\n inkscape:window-y=\\\"24\\\"\\n inkscape:window-maximized=\\\"1\\\"\\n fit-margin-top=\\\"1\\\"\\n fit-margin-left=\\\"1\\\"\\n fit-margin-right=\\\"1\\\"\\n fit-margin-bottom=\\\"1\\\"\\n units=\\\"cm\\\" />\\n <metadata\\n id=\\\"metadata7\\\">\\n <rdf:RDF>\\n <cc:Work\\n rdf:about=\\\"\\\">\\n <dc:format>image/svg+xml</dc:format>\\n <dc:type\\n rdf:resource=\\\"http://purl.org/dc/dcmitype/StillImage\\\" />\\n <dc:title></dc:title>\\n </cc:Work>\\n </rdf:RDF>\\n </metadata>\\n <g\\n inkscape:label=\\\"Layer 1\\\"\\n inkscape:groupmode=\\\"layer\\\"\\n id=\\\"layer1\\\"\\n transform=\\\"translate(-40.758533,29.820888)\\\">\\n <g\\n id=\\\"g11880\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591\\\"\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n id=\\\"tspan10593\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <g\\n id=\\\"g10626\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991\\\"\\n d=\\\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7\\\"\\n d=\\\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\\\"\\n id=\\\"path2991-7-8\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5637\\\"\\n d=\\\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5641\\\"\\n d=\\\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5643\\\"\\n d=\\\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n id=\\\"tspan6247\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(18,0)\\\"\\n id=\\\"g11773\\\">\\n <g\\n id=\\\"g11763\\\">\\n <rect\\n y=\\\"120.8597\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308\\\"\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n id=\\\"tspan6310\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g11768\\\">\\n <rect\\n y=\\\"135.43114\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304\\\"\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n id=\\\"tspan6306\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(54,-16)\\\"\\n id=\\\"g10674\\\">\\n <g\\n id=\\\"g10664\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(86.857134,-15.571435)\\\"\\n id=\\\"g10674-6\\\">\\n <g\\n id=\\\"g10664-6\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0-5\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-9\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7-6\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669-5\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5-3\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6-1\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n id=\\\"tspan10728\\\"\\n sodipodi:role=\\\"line\\\">Popen</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-89\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-24\\\"\\n style=\\\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n sodipodi:role=\\\"line\\\">pipes</tspan></text>\\n </g>\\n <g\\n id=\\\"g11847\\\"\\n transform=\\\"translate(-10,0.39179)\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328-0\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-8\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591-3\\\"\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n id=\\\"tspan10593-2\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path11075\\\"\\n d=\\\"m 397.80427,110.64896 0,-52.85714\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\\\" />\\n <g\\n id=\\\"g10626-5\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2-4\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334-0\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336-9\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-4\\\"\\n d=\\\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7-87\\\"\\n d=\\\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331-7\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\\\"\\n id=\\\"path2991-7-8-4\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-6\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n id=\\\"tspan6247-3\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-6\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-2\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8-1\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298-3\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(227.5656,-301.02546)\\\"\\n id=\\\"g11065\\\">\\n <g\\n id=\\\"g11055\\\">\\n <rect\\n y=\\\"421.34998\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55\\\"\\n style=\\\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6\\\"\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n id=\\\"tspan6310-7-9\\\"\\n sodipodi:role=\\\"line\\\">slave</tspan></text>\\n </g>\\n <g\\n id=\\\"g11060\\\">\\n <rect\\n y=\\\"407.25223\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55-9\\\"\\n style=\\\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6-7\\\"\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n id=\\\"tspan6310-7-9-7\\\"\\n sodipodi:role=\\\"line\\\">master</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726-9\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n id=\\\"tspan10728-7\\\"\\n sodipodi:role=\\\"line\\\">Pseudoterminal</tspan><tspan\\n id=\\\"tspan11761\\\"\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"136.71899\\\"\\n x=\\\"429.1268\\\"\\n sodipodi:role=\\\"line\\\">(pty)</tspan></text>\\n </g>\\n </g>\\n</svg>\\n\\n[end of docs/images/pty_vs_popen.svg]\",\n \"filename\": \"docs/images/pty_vs_popen.svg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"None\\n[end of docs/images/pty_vs_popen.png]\",\n \"filename\": \"docs/images/pty_vs_popen.png\",\n \"id\": \"13\"\n }\n]","isConversational":false}}},{"rowIdx":84,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 84,\n \"num_files\": 14,\n \"repo_id\": \"repo_0084\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"python:\n version: 3\n\n[end of readthedocs.yml]","filename":"readthedocs.yml","id":"0"},{"content":"ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, Pexpect development team\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\n\n Permission to use, copy, modify, and/or distribute this software for any\n purpose with or without fee is hereby granted, provided that the above\n copyright notice and this permission notice appear in all copies.\n \n THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"1"},{"content":"[build-system]\nrequires = [\"flit_core >=2,<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.metadata]\nmodule = \"ptyprocess\"\nauthor = \"Thomas Kluyver\"\nauthor-email = \"thomas@kluyver.me.uk\"\nhome-page = \"https://github.com/pexpect/ptyprocess\"\ndescription-file = \"README.rst\"\nrequires-python = \">=3.7\"\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: System Administrators\",\n \"License :: OSI Approved :: ISC License (ISCL)\",\n \"Operating System :: POSIX\",\n \"Operating System :: MacOS :: MacOS X\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Topic :: Terminals\"\n]\n\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"2"},{"content":"Launch a subprocess in a pseudo terminal (pty), and interact with both the\nprocess and its pty.\n\nSometimes, piping stdin and stdout is not enough. There might be a password\nprompt that doesn't read from stdin, output that changes when it's going to a\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\nIf you need to automate these things, running the process in a pseudo terminal\n(pty) is the answer.\n\nInterface:\n\n.. code:: python\n\n from ptyprocess import PtyProcessUnicode\n p = PtyProcessUnicode.spawn(['python'])\n p.read(20)\n p.write('6+6\\n')\n p.read(20)\n\n[end of README.rst]","filename":"README.rst","id":"3"},{"content":"Ptyprocess\n==========\n\n.. include:: ../README.rst\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n\n api\n\nWhat is a pty?\n--------------\n\nA pty is a kernel-level object which processes can write data to and read data\nfrom, a bit like a pipe.\n\nUnlike a pipe, data moves through a single pty in both directions. When you use\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\nto three pipes are created for the process's standard streams (stdin, stdout\nand stderr). When you run a program using ptyprocess, all three of its standard\nstreams are connected to a single pty:\n\n.. image:: images/pty_vs_popen.png\n\nA pty also does more than a pipe. It keeps track of the window size (rows and\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\nSIGINT to be sent to the child process.\n\nMany command line programs behave differently if they detect that stdin or stdout\nis connected to a terminal instead of a pipe (using \n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\nthat they're being used interactively by a human user.\nThey may format output differently (e.g. ``ls`` lists files in columns)\nor prompt the user to confirm actions.\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\n\n.. seealso::\n\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\n Detailed article by Linus Akesson\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n\n[end of docs/index.rst]","filename":"docs/index.rst","id":"4"},{"content":"# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = _build\n\n# User-friendly check for sphinx-build\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\nendif\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make <target>' where <target> is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" xml to make Docutils-native XML files\"\n\t@echo \" pseudoxml to make pseudoxml-XML files for display purposes\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\trm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\nlatexpdfja:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through platex and dvipdfmx...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\nxml:\n\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\n\t@echo\n\t@echo \"Build finished. The XML files are in $(BUILDDIR)/xml.\"\n\npseudoxml:\n\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\n\t@echo\n\t@echo \"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\"\n\n[end of docs/Makefile]","filename":"docs/Makefile","id":"5"},{"content":"# -*- coding: utf-8 -*-\n#\n# Ptyprocess documentation build configuration file, created by\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\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\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.insert(0, os.path.abspath('..'))\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.viewcode',\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'Ptyprocess'\ncopyright = u'2014, Thomas Kluyver'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '0.7'\n# The full version, including alpha/beta/rc tags.\nrelease = version #+ '.2'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\n\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#html_extra_path = []\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'Ptyprocessdoc'\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\n [u'Thomas Kluyver'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {'http://docs.python.org/': None}\n\n[end of docs/conf.py]","filename":"docs/conf.py","id":"6"},{"content":"Ptyprocess API\n==============\n\n.. module:: ptyprocess\n\n.. autoclass:: PtyProcess\n\n .. automethod:: spawn\n\n .. automethod:: read\n\n .. automethod:: readline\n\n .. automethod:: write\n\n .. automethod:: sendcontrol\n\n .. automethod:: sendeof\n\n .. automethod:: sendintr\n\n .. automethod:: getecho\n\n .. automethod:: waitnoecho\n\n .. automethod:: setecho\n\n .. automethod:: getwinsize\n\n .. automethod:: setwinsize\n\n .. automethod:: eof\n\n .. automethod:: isalive\n\n .. automethod:: wait\n\n .. automethod:: kill\n\n .. automethod:: terminate\n\n .. automethod:: close\n\n.. autoclass:: PtyProcessUnicode\n\n[end of docs/api.rst]","filename":"docs/api.rst","id":"7"},{"content":"try:\n from shutil import which # Python >= 3.3\nexcept ImportError:\n import os, sys\n \n # This is copied from Python 3.4.1\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\n \"\"\"Given a command, mode, and a PATH string, return the path which\n conforms to the given mode on the PATH, or None if there is no such\n file.\n \n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\n of os.environ.get(\"PATH\"), or can be overridden with a custom search\n path.\n \n \"\"\"\n # Check that a given file can be accessed with the correct mode.\n # Additionally check that `file` is not a directory, as on Windows\n # directories pass the os.access check.\n def _access_check(fn, mode):\n return (os.path.exists(fn) and os.access(fn, mode)\n and not os.path.isdir(fn))\n \n # If we're given a path with a directory part, look it up directly rather\n # than referring to PATH directories. This includes checking relative to the\n # current directory, e.g. ./script\n if os.path.dirname(cmd):\n if _access_check(cmd, mode):\n return cmd\n return None\n \n if path is None:\n path = os.environ.get(\"PATH\", os.defpath)\n if not path:\n return None\n path = path.split(os.pathsep)\n \n if sys.platform == \"win32\":\n # The current directory takes precedence on Windows.\n if not os.curdir in path:\n path.insert(0, os.curdir)\n \n # PATHEXT is necessary to check on Windows.\n pathext = os.environ.get(\"PATHEXT\", \"\").split(os.pathsep)\n # See if the given file matches any of the expected path extensions.\n # This will allow us to short circuit when given \"python.exe\".\n # If it does match, only test that one, otherwise we have to try\n # others.\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\n files = [cmd]\n else:\n files = [cmd + ext for ext in pathext]\n else:\n # On other platforms you don't have things like PATHEXT to tell you\n # what file suffixes are executable, so just pass on cmd as-is.\n files = [cmd]\n \n seen = set()\n for dir in path:\n normdir = os.path.normcase(dir)\n if not normdir in seen:\n seen.add(normdir)\n for thefile in files:\n name = os.path.join(dir, thefile)\n if _access_check(name, mode):\n return name\n return None\n\n\nclass PtyProcessError(Exception):\n \"\"\"Generic error class for this package.\"\"\"\n\n[end of ptyprocess/util.py]","filename":"ptyprocess/util.py","id":"8"},{"content":"\"\"\"Substitute for the forkpty system call, to support Solaris.\n\"\"\"\nimport os\nimport errno\n\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\nfrom .util import PtyProcessError\n\ndef fork_pty():\n '''This implements a substitute for the forkpty system call. This\n should be more portable than the pty.fork() function. Specifically,\n this should work on Solaris.\n\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\n resolve the issue with Python's pty.fork() not supporting Solaris,\n particularly ssh. Based on patch to posixmodule.c authored by Noah\n Spurrier::\n\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\n\n '''\n\n parent_fd, child_fd = os.openpty()\n if parent_fd < 0 or child_fd < 0:\n raise OSError(\"os.openpty() failed\")\n\n pid = os.fork()\n if pid == CHILD:\n # Child.\n os.close(parent_fd)\n pty_make_controlling_tty(child_fd)\n\n os.dup2(child_fd, STDIN_FILENO)\n os.dup2(child_fd, STDOUT_FILENO)\n os.dup2(child_fd, STDERR_FILENO)\n\n else:\n # Parent.\n os.close(child_fd)\n\n return pid, parent_fd\n\ndef pty_make_controlling_tty(tty_fd):\n '''This makes the pseudo-terminal the controlling tty. This should be\n more portable than the pty.fork() function. Specifically, this should\n work on Solaris. '''\n\n child_name = os.ttyname(tty_fd)\n\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\n # if there was no controlling tty to begin with, such as when\n # executed by a cron(1) job.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n os.setsid()\n\n # Verify we are disconnected from controlling tty by attempting to open\n # it again. We expect that OSError of ENXIO should always be raised.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY)\n os.close(fd)\n raise PtyProcessError(\"OSError of errno.ENXIO should be raised.\")\n except OSError as err:\n if err.errno != errno.ENXIO:\n raise\n\n # Verify we can open child pty.\n fd = os.open(child_name, os.O_RDWR)\n os.close(fd)\n\n # Verify we now have a controlling tty.\n fd = os.open(\"/dev/tty\", os.O_WRONLY)\n os.close(fd)\n\n[end of ptyprocess/_fork_pty.py]","filename":"ptyprocess/_fork_pty.py","id":"9"},{"content":"import codecs\nimport errno\nimport fcntl\nimport io\nimport os\nimport pty\nimport resource\nimport signal\nimport struct\nimport sys\nimport termios\nimport time\n\ntry:\n import builtins # Python 3\nexcept ImportError:\n import __builtin__ as builtins # Python 2\n\n# Constants\nfrom pty import (STDIN_FILENO, CHILD)\n\nfrom .util import which, PtyProcessError\n\n_platform = sys.platform.lower()\n\n# Solaris uses internal __fork_pty(). All others use pty.fork().\n_is_solaris = (\n _platform.startswith('solaris') or\n _platform.startswith('sunos'))\n\nif _is_solaris:\n use_native_pty_fork = False\n from . import _fork_pty\nelse:\n use_native_pty_fork = True\n\nPY3 = sys.version_info[0] >= 3\n\nif PY3:\n def _byte(i):\n return bytes([i])\nelse:\n def _byte(i):\n return chr(i)\n \n class FileNotFoundError(OSError): pass\n class TimeoutError(OSError): pass\n\n_EOF, _INTR = None, None\n\ndef _make_eof_intr():\n \"\"\"Set constants _EOF and _INTR.\n \n This avoids doing potentially costly operations on module load.\n \"\"\"\n global _EOF, _INTR\n if (_EOF is not None) and (_INTR is not None):\n return\n\n # inherit EOF and INTR definitions from controlling process.\n try:\n from termios import VEOF, VINTR\n fd = None\n for name in 'stdin', 'stdout':\n stream = getattr(sys, '__%s__' % name, None)\n if stream is None or not hasattr(stream, 'fileno'):\n continue\n try:\n fd = stream.fileno()\n except ValueError:\n continue\n if fd is None:\n # no fd, raise ValueError to fallback on CEOF, CINTR\n raise ValueError(\"No stream has a fileno\")\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\n except (ImportError, OSError, IOError, ValueError, termios.error):\n # unless the controlling process is also not a terminal,\n # such as cron(1), or when stdin and stdout are both closed.\n # Fall-back to using CEOF and CINTR. There\n try:\n from termios import CEOF, CINTR\n (intr, eof) = (CINTR, CEOF)\n except ImportError:\n # ^C, ^D\n (intr, eof) = (3, 4)\n \n _INTR = _byte(intr)\n _EOF = _byte(eof)\n\n# setecho and setwinsize are pulled out here because on some platforms, we need\n# to do this from the child before we exec()\n \ndef _setecho(fd, state):\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\n\n try:\n attr = termios.tcgetattr(fd)\n except termios.error as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n if state:\n attr[3] = attr[3] | termios.ECHO\n else:\n attr[3] = attr[3] & ~termios.ECHO\n\n try:\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\n # blocked on some platforms. TCSADRAIN would probably be ideal.\n termios.tcsetattr(fd, termios.TCSANOW, attr)\n except IOError as err:\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\ndef _setwinsize(fd, rows, cols):\n # Some very old platforms have a bug that causes the value for\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\n # around this, but it caused problems with newer platforms so has been\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\n # Note, assume ws_xpixel and ws_ypixel are zero.\n s = struct.pack('HHHH', rows, cols, 0, 0)\n fcntl.ioctl(fd, TIOCSWINSZ, s)\n\nclass PtyProcess(object):\n '''This class represents a process running in a pseudoterminal.\n \n The main constructor is the :meth:`spawn` classmethod.\n '''\n string_type = bytes\n if PY3:\n linesep = os.linesep.encode('ascii')\n crlf = '\\r\\n'.encode('ascii')\n\n @staticmethod\n def write_to_stdout(b):\n try:\n return sys.stdout.buffer.write(b)\n except AttributeError:\n # If stdout has been replaced, it may not have .buffer\n return sys.stdout.write(b.decode('ascii', 'replace'))\n else:\n linesep = os.linesep\n crlf = '\\r\\n'\n write_to_stdout = sys.stdout.write\n\n encoding = None\n \n argv = None\n env = None\n launch_dir = None\n\n def __init__(self, pid, fd):\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\n self.pid = pid\n self.fd = fd\n readf = io.open(fd, 'rb', buffering=0)\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\n self.fileobj = io.BufferedRWPair(readf, writef)\n\n self.terminated = False\n self.closed = False\n self.exitstatus = None\n self.signalstatus = None\n # status returned by os.waitpid\n self.status = None\n self.flag_eof = False\n # Used by close() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterclose = 0.1\n # Used by terminate() to give kernel time to update process status.\n # Time in seconds.\n self.delayafterterminate = 0.1\n\n @classmethod\n def spawn(\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\n dimensions=(24, 80), pass_fds=()):\n '''Start the given command in a child process in a pseudo terminal.\n\n This does all the fork/exec type of stuff for a pty, and returns an\n instance of PtyProcess.\n\n If preexec_fn is supplied, it will be called with no arguments in the\n child process before exec-ing the specified command.\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\n\n Dimensions of the psuedoterminal used for the subprocess can be\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\n\n By default, all file descriptors except 0, 1 and 2 are closed. This\n behavior can be overridden with pass_fds, a list of file descriptors to\n keep open between the parent and the child.\n '''\n # Note that it is difficult for this method to fail.\n # You cannot detect if the child process cannot start.\n # So the only way you can tell if the child process started\n # or not is to try to read from the file descriptor. If you get\n # EOF immediately then it means that the child is already dead.\n # That may not necessarily be bad because you may have spawned a child\n # that performs some task; creates no stdout output; and then dies.\n\n if not isinstance(argv, (list, tuple)):\n raise TypeError(\"Expected a list or tuple for argv, got %r\" % argv)\n\n # Shallow copy of argv so we can modify it\n argv = argv[:]\n command = argv[0]\n\n command_with_path = which(command)\n if command_with_path is None:\n raise FileNotFoundError('The command was not found or was not ' +\n 'executable: %s.' % command)\n command = command_with_path\n argv[0] = command\n\n # [issue #119] To prevent the case where exec fails and the user is\n # stuck interacting with a python child process instead of whatever\n # was expected, we implement the solution from\n # http://stackoverflow.com/a/3703179 to pass the exception to the\n # parent process\n\n # [issue #119] 1. Before forking, open a pipe in the parent process.\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\n\n if use_native_pty_fork:\n pid, fd = pty.fork()\n else:\n # Use internal fork_pty, for Solaris\n pid, fd = _fork_pty.fork_pty()\n\n # Some platforms must call setwinsize() and setecho() from the\n # child process, and others from the master process. We do both,\n # allowing IOError for either.\n\n if pid == CHILD:\n # set window size\n try:\n _setwinsize(STDIN_FILENO, *dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # disable echo if spawn argument echo was unset\n if not echo:\n try:\n _setecho(STDIN_FILENO, False)\n except (IOError, termios.error) as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\n raise\n\n # [issue #119] 3. The child closes the reading end and sets the\n # close-on-exec flag for the writing end.\n os.close(exec_err_pipe_read)\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\n\n # Do not allow child to inherit open file descriptors from parent,\n # with the exception of the exec_err_pipe_write of the pipe\n # and pass_fds.\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\n # occasionally raises out of range error\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\n os.closerange(pair[0]+1, pair[1])\n\n if cwd is not None:\n os.chdir(cwd)\n\n if preexec_fn is not None:\n try:\n preexec_fn()\n except Exception as e:\n ename = type(e).__name__\n tosend = '{}:0:{}'.format(ename, str(e))\n if PY3:\n tosend = tosend.encode('utf-8')\n\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(1)\n\n try:\n if env is None:\n os.execv(command, argv)\n else:\n os.execvpe(command, argv, env)\n except OSError as err:\n # [issue #119] 5. If exec fails, the child writes the error\n # code back to the parent using the pipe, then exits.\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\n if PY3:\n tosend = tosend.encode('utf-8')\n os.write(exec_err_pipe_write, tosend)\n os.close(exec_err_pipe_write)\n os._exit(os.EX_OSERR)\n\n # Parent\n inst = cls(pid, fd)\n \n # Set some informational attributes\n inst.argv = argv\n if env is not None:\n inst.env = env\n if cwd is not None:\n inst.launch_dir = cwd\n\n # [issue #119] 2. After forking, the parent closes the writing end\n # of the pipe and reads from the reading end.\n os.close(exec_err_pipe_write)\n exec_err_data = os.read(exec_err_pipe_read, 4096)\n os.close(exec_err_pipe_read)\n\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\n # child successfully performed exec, since close-on-exec made\n # successful exec close the writing end of the pipe. Or, if exec\n # failed, the parent reads the error code and can proceed\n # accordingly. Either way, the parent blocks until the child calls\n # exec.\n if len(exec_err_data) != 0:\n try:\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\n\n exception = exctype(errmsg.decode('utf-8', 'replace'))\n if exctype is OSError:\n exception.errno = int(errno_s)\n except:\n raise Exception('Subprocess failed, got bad error data: %r'\n % exec_err_data)\n else:\n raise exception\n\n try:\n inst.setwinsize(*dimensions)\n except IOError as err:\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\n raise\n\n return inst\n\n def __repr__(self):\n clsname = type(self).__name__\n if self.argv is not None:\n args = [repr(self.argv)]\n if self.env is not None:\n args.append(\"env=%r\" % self.env)\n if self.launch_dir is not None:\n args.append(\"cwd=%r\" % self.launch_dir)\n \n return \"{}.spawn({})\".format(clsname, \", \".join(args))\n \n else:\n return \"{}(pid={}, fd={})\".format(clsname, self.pid, self.fd)\n\n @staticmethod\n def _coerce_send_string(s):\n if not isinstance(s, bytes):\n return s.encode('utf-8')\n return s\n\n @staticmethod\n def _coerce_read_string(s):\n return s\n\n def __del__(self):\n '''This makes sure that no system resources are left open. Python only\n garbage collects Python objects. OS file descriptors are not Python\n objects, so they must be handled explicitly. If the child file\n descriptor was opened outside of this class (passed to the constructor)\n then this does not close it. '''\n\n if not self.closed:\n # It is possible for __del__ methods to execute during the\n # teardown of the Python VM itself. Thus self.close() may\n # trigger an exception because os.close may be None.\n try:\n self.close()\n # which exception, shouldn't we catch explicitly .. ?\n except:\n pass\n\n\n def fileno(self):\n '''This returns the file descriptor of the pty for the child.\n '''\n return self.fd\n\n def close(self, force=True):\n '''This closes the connection with the child application. Note that\n calling close() more than once is valid. This emulates standard Python\n behavior with files. Set force to True if you want to make sure that\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\n and SIGINT). '''\n if not self.closed:\n self.flush()\n self.fileobj.close() # Closes the file descriptor\n # Give kernel time to update process status.\n time.sleep(self.delayafterclose)\n if self.isalive():\n if not self.terminate(force):\n raise PtyProcessError('Could not terminate the child.')\n self.fd = -1\n self.closed = True\n #self.pid = None\n\n def flush(self):\n '''This does nothing. It is here to support the interface for a\n File-like object. '''\n\n pass\n\n def isatty(self):\n '''This returns True if the file descriptor is open and connected to a\n tty(-like) device, else False.\n\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\n the child pty may not appear as a terminal device. This means\n methods such as setecho(), setwinsize(), getwinsize() may raise an\n IOError. '''\n\n return os.isatty(self.fd)\n\n def waitnoecho(self, timeout=None):\n '''Wait until the terminal ECHO flag is set False.\n\n This returns True if the echo mode is off, or False if echo was not\n disabled before the timeout. This can be used to detect when the\n child is waiting for a password. Usually a child application will turn\n off echo mode when it is waiting for the user to enter a password. For\n example, instead of expecting the \"password:\" prompt you can wait for\n the child to turn echo off::\n\n p = pexpect.spawn('ssh user@example.com')\n p.waitnoecho()\n p.sendline(mypassword)\n\n If ``timeout=None`` then this method to block until ECHO flag is False.\n '''\n\n if timeout is not None:\n end_time = time.time() + timeout\n while True:\n if not self.getecho():\n return True\n if timeout < 0 and timeout is not None:\n return False\n if timeout is not None:\n timeout = end_time - time.time()\n time.sleep(0.1)\n\n def getecho(self):\n '''Returns True if terminal echo is on, or False if echo is off.\n\n Child applications that are expecting you to enter a password often\n disable echo. See also :meth:`waitnoecho`.\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n\n try:\n attr = termios.tcgetattr(self.fd)\n except termios.error as err:\n errmsg = 'getecho() may not be called on this platform'\n if err.args[0] == errno.EINVAL:\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\n raise\n\n self.echo = bool(attr[3] & termios.ECHO)\n return self.echo\n\n def setecho(self, state):\n '''Enable or disable terminal echo.\n\n Anything the child sent before the echo will be lost, so you should be\n sure that your input buffer is empty before you call setecho().\n For example, the following will work as expected::\n\n p = pexpect.spawn('cat') # Echo is on by default.\n p.sendline('1234') # We expect see this twice from the child...\n p.expect(['1234']) # ... once from the tty echo...\n p.expect(['1234']) # ... and again from cat itself.\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n The following WILL NOT WORK because the lines sent before the setecho\n will be lost::\n\n p = pexpect.spawn('cat')\n p.sendline('1234')\n p.setecho(False) # Turn off tty echo\n p.sendline('abcd') # We will set this only once (echoed by cat).\n p.sendline('wxyz') # We will set this only once (echoed by cat)\n p.expect(['1234'])\n p.expect(['1234'])\n p.expect(['abcd'])\n p.expect(['wxyz'])\n\n\n Not supported on platforms where ``isatty()`` returns False.\n '''\n _setecho(self.fd, state)\n\n self.echo = state\n\n def read(self, size=1024):\n \"\"\"Read and return at most ``size`` bytes from the pty.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\n with the vagaries of EOF on platforms that do strange things, like IRIX\n or older Solaris systems. It handles the errno=EIO pattern used on\n Linux, and the empty-string return used on BSD platforms and (seemingly)\n on recent Solaris.\n \"\"\"\n try:\n s = self.fileobj.read1(size)\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n try:\n s = self.fileobj.readline()\n except (OSError, IOError) as err:\n if err.args[0] == errno.EIO:\n # Linux-style EOF\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Exception style platform.')\n raise\n if s == b'':\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\n self.flag_eof = True\n raise EOFError('End Of File (EOF). Empty string style platform.')\n\n return s\n\n def _writeb(self, b, flush=True):\n n = self.fileobj.write(b)\n if flush:\n self.fileobj.flush()\n return n\n\n def write(self, s, flush=True):\n \"\"\"Write bytes to the pseudoterminal.\n \n Returns the number of bytes written.\n \"\"\"\n return self._writeb(s, flush=flush)\n\n def sendcontrol(self, char):\n '''Helper method for sending control characters to the terminal.\n\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\a'``)::\n\n child.sendcontrol('g')\n\n See also, :meth:`sendintr` and :meth:`sendeof`.\n '''\n char = char.lower()\n a = ord(char)\n if 97 <= a <= 122:\n a = a - ord('a') + 1\n byte = _byte(a)\n return self._writeb(byte), byte\n d = {'@': 0, '`': 0,\n '[': 27, '{': 27,\n '\\\\': 28, '|': 28,\n ']': 29, '}': 29,\n '^': 30, '~': 30,\n '_': 31,\n '?': 127}\n if char not in d:\n return 0, b''\n\n byte = _byte(d[char])\n return self._writeb(byte), byte\n\n def sendeof(self):\n '''Sends an EOF (typically Ctrl-D) through the terminal.\n\n This sends a character which causes\n the pending parent output buffer to be sent to the waiting child\n program without waiting for end-of-line. If it is the first character\n of the line, the read() in the user program returns 0, which signifies\n end-of-file. This means to work as expected a sendeof() has to be\n called at the beginning of a line. This method does not send a newline.\n It is the responsibility of the caller to ensure the eof is sent at the\n beginning of a line.\n '''\n return self._writeb(_EOF), _EOF\n\n def sendintr(self):\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\n\n This will normally trigger the kernel to send SIGINT to the current\n foreground process group. Processes can turn off this translation, in\n which case they can read the raw data sent, e.g. ``b'\\\\x03'`` for Ctrl-C.\n\n See also the :meth:`kill` method, which sends a signal directly to the\n immediate child process in the terminal (which is not necessarily the\n foreground process).\n '''\n return self._writeb(_INTR), _INTR\n\n def eof(self):\n '''This returns True if the EOF exception was ever raised.\n '''\n\n return self.flag_eof\n\n def terminate(self, force=False):\n '''This forces a child process to terminate. It starts nicely with\n SIGHUP and SIGINT. If \"force\" is True then moves onto SIGKILL. This\n returns True if the child was terminated. This returns False if the\n child could not be terminated. '''\n\n if not self.isalive():\n return True\n try:\n self.kill(signal.SIGHUP)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGCONT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGINT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n if force:\n self.kill(signal.SIGKILL)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n return False\n except OSError:\n # I think there are kernel timing issues that sometimes cause\n # this to happen. I think isalive() reports True, but the\n # process is dead to the kernel.\n # Make one last attempt to see if the kernel is up to date.\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n\n def wait(self):\n '''This waits until the child exits. This is a blocking call. This will\n not read any data from the child, so this will block forever if the\n child has unread output and has terminated. In other words, the child\n may have printed output then called exit(), but, the child is\n technically still alive until its output is read by the parent. '''\n\n if self.isalive():\n pid, status = os.waitpid(self.pid, 0)\n else:\n return self.exitstatus\n self.exitstatus = os.WEXITSTATUS(status)\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status): # pragma: no cover\n # You can't call wait() on a child process in the stopped state.\n raise PtyProcessError('Called wait() on a stopped child ' +\n 'process. This is not supported. Is some other ' +\n 'process attempting job control with our child pid?')\n return self.exitstatus\n\n def isalive(self):\n '''This tests if the child process is running or not. This is\n non-blocking. If the child was terminated then this will read the\n exitstatus or signalstatus of the child. This returns True if the child\n process appears to be running or False if not. It can take literally\n SECONDS for Solaris to return the right status. '''\n\n if self.terminated:\n return False\n\n if self.flag_eof:\n # This is for Linux, which requires the blocking form\n # of waitpid to get the status of a defunct process.\n # This is super-lame. The flag_eof would have been set\n # in read_nonblocking(), so this should be safe.\n waitpid_options = 0\n else:\n waitpid_options = os.WNOHANG\n\n try:\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e:\n # No child processes\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'where \"terminated\" is 0, but there was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # I have to do this twice for Solaris.\n # I can't even believe that I figured this out...\n # If waitpid() returns 0 it means that no child process\n # wishes to report, and the value of status is undefined.\n if pid == 0:\n try:\n ### os.WNOHANG) # Solaris!\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError as e: # pragma: no cover\n # This should never happen...\n if e.errno == errno.ECHILD:\n raise PtyProcessError('isalive() encountered condition ' +\n 'that should never happen. There was no child ' +\n 'process. Did someone else call waitpid() ' +\n 'on our process?')\n else:\n raise\n\n # If pid is still 0 after two calls to waitpid() then the process\n # really is alive. This seems to work on all platforms, except for\n # Irix which seems to require a blocking call on waitpid or select,\n # so I let read_nonblocking take care of this situation\n # (unfortunately, this requires waiting through the timeout).\n if pid == 0:\n return True\n\n if pid == 0:\n return True\n\n if os.WIFEXITED(status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED(status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED(status):\n raise PtyProcessError('isalive() encountered condition ' +\n 'where child process is stopped. This is not ' +\n 'supported. Is some other process attempting ' +\n 'job control with our child pid?')\n return False\n\n def kill(self, sig):\n \"\"\"Send the given signal to the child application.\n\n In keeping with UNIX tradition it has a misleading name. It does not\n necessarily kill the child unless you send the right signal. See the\n :mod:`signal` module for constants representing signal numbers.\n \"\"\"\n\n # Same as os.kill, but the pid is given for you.\n if self.isalive():\n os.kill(self.pid, sig)\n\n def getwinsize(self):\n \"\"\"Return the window size of the pseudoterminal as a tuple (rows, cols).\n \"\"\"\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\n s = struct.pack('HHHH', 0, 0, 0, 0)\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\n return struct.unpack('HHHH', x)[0:2]\n\n def setwinsize(self, rows, cols):\n \"\"\"Set the terminal window size of the child tty.\n\n This will cause a SIGWINCH signal to be sent to the child. This does not\n change the physical window size. It changes the size reported to\n TTY-aware applications like vi or curses -- applications that respond to\n the SIGWINCH signal.\n \"\"\"\n return _setwinsize(self.fd, rows, cols)\n\n\nclass PtyProcessUnicode(PtyProcess):\n \"\"\"Unicode wrapper around a process running in a pseudoterminal.\n\n This class exposes a similar interface to :class:`PtyProcess`, but its read\n methods return unicode, and its :meth:`write` accepts unicode.\n \"\"\"\n if PY3:\n string_type = str\n else:\n string_type = unicode # analysis:ignore\n\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\n super(PtyProcessUnicode, self).__init__(pid, fd)\n self.encoding = encoding\n self.codec_errors = codec_errors\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\n\n def read(self, size=1024):\n \"\"\"Read at most ``size`` bytes from the pty, return them as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n\n The size argument still refers to bytes, not unicode code points.\n \"\"\"\n b = super(PtyProcessUnicode, self).read(size)\n return self.decoder.decode(b, final=False)\n\n def readline(self):\n \"\"\"Read one line from the pseudoterminal, and return it as unicode.\n\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\n terminal was closed.\n \"\"\"\n b = super(PtyProcessUnicode, self).readline()\n return self.decoder.decode(b, final=False)\n\n def write(self, s):\n \"\"\"Write the unicode string ``s`` to the pseudoterminal.\n\n Returns the number of bytes written.\n \"\"\"\n b = s.encode(self.encoding)\n return super(PtyProcessUnicode, self).write(b)\n\n[end of ptyprocess/ptyprocess.py]","filename":"ptyprocess/ptyprocess.py","id":"10"},{"content":"\"\"\"Run a subprocess in a pseudo terminal\"\"\"\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\n\n__version__ = '0.7.0'\n\n[end of ptyprocess/__init__.py]","filename":"ptyprocess/__init__.py","id":"11"},{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\n\n<svg\n xmlns:dc=\"http://purl.org/dc/elements/1.1/\"\n xmlns:cc=\"http://creativecommons.org/ns#\"\n xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n xmlns:svg=\"http://www.w3.org/2000/svg\"\n xmlns=\"http://www.w3.org/2000/svg\"\n xmlns:sodipodi=\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\"\n xmlns:inkscape=\"http://www.inkscape.org/namespaces/inkscape\"\n width=\"554.44196\"\n height=\"327.38452\"\n id=\"svg2\"\n version=\"1.1\"\n inkscape:version=\"0.48.4 r9939\"\n sodipodi:docname=\"pty_vs_popen.svg\">\n <defs\n id=\"defs4\">\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM\"\n style=\"overflow:visible\">\n <path\n id=\"path3838\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3783\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(1.1,0,0,1.1,1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Tail\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Tail\"\n style=\"overflow:visible\">\n <g\n id=\"g3801\"\n transform=\"scale(-1.2,-1.2)\">\n <path\n id=\"path3803\"\n d=\"M -3.8048674,-3.9585227 0.54352094,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3805\"\n d=\"M -1.2866832,-3.9585227 3.0617053,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3807\"\n d=\"M 1.3053582,-3.9585227 5.6537466,0\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3809\"\n d=\"M -3.8048674,4.1775838 0.54352094,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3811\"\n d=\"M -1.2866832,4.1775838 3.0617053,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n <path\n id=\"path3813\"\n d=\"M 1.3053582,4.1775838 5.6537466,0.21974226\"\n style=\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\"\n inkscape:connector-curvature=\"0\" />\n </g>\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lstart\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lstart\"\n style=\"overflow:visible\">\n <path\n id=\"path3765\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(0.8,0,0,0.8,10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3786\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow1Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow1Lend\"\n style=\"overflow:visible\">\n <path\n id=\"path3768\"\n d=\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"matrix(-0.8,0,0,-0.8,-10,0)\"\n inkscape:connector-curvature=\"0\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-9\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-2\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"Arrow2Lend\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"Arrow2Lend-6\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3786-27\"\n style=\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\"\n d=\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\"\n transform=\"matrix(-1.1,0,0,-1.1,-1.1,0)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"SquareM-5\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path3838-7\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10742\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10744\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10746\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10748\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10750\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10752\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10754\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10756\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n <marker\n inkscape:stockid=\"SquareM\"\n orient=\"auto\"\n refY=\"0\"\n refX=\"0\"\n id=\"marker10758\"\n style=\"overflow:visible\">\n <path\n inkscape:connector-curvature=\"0\"\n id=\"path10760\"\n d=\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\"\n style=\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\"\n transform=\"scale(0.4,0.4)\" />\n </marker>\n </defs>\n <sodipodi:namedview\n id=\"base\"\n pagecolor=\"#ffffff\"\n bordercolor=\"#666666\"\n borderopacity=\"1.0\"\n inkscape:pageopacity=\"0.0\"\n inkscape:pageshadow=\"2\"\n inkscape:zoom=\"0.98994949\"\n inkscape:cx=\"77.797977\"\n inkscape:cy=\"137.24456\"\n inkscape:document-units=\"px\"\n inkscape:current-layer=\"layer1\"\n showgrid=\"false\"\n inkscape:window-width=\"1301\"\n inkscape:window-height=\"744\"\n inkscape:window-x=\"65\"\n inkscape:window-y=\"24\"\n inkscape:window-maximized=\"1\"\n fit-margin-top=\"1\"\n fit-margin-left=\"1\"\n fit-margin-right=\"1\"\n fit-margin-bottom=\"1\"\n units=\"cm\" />\n <metadata\n id=\"metadata7\">\n <rdf:RDF>\n <cc:Work\n rdf:about=\"\">\n <dc:format>image/svg+xml</dc:format>\n <dc:type\n rdf:resource=\"http://purl.org/dc/dcmitype/StillImage\" />\n <dc:title></dc:title>\n </cc:Work>\n </rdf:RDF>\n </metadata>\n <g\n inkscape:label=\"Layer 1\"\n inkscape:groupmode=\"layer\"\n id=\"layer1\"\n transform=\"translate(-40.758533,29.820888)\">\n <g\n id=\"g11880\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591\"\n y=\"240.97427\"\n x=\"138.65004\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.97427\"\n x=\"138.65004\"\n id=\"tspan10593\"\n sodipodi:role=\"line\">Child</tspan></text>\n <g\n id=\"g10626\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991\"\n d=\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7\"\n d=\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\"\n id=\"path2991-7-8\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5637\"\n d=\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5641\"\n d=\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path5643\"\n d=\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\"\n style=\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245\"\n y=\"240.57648\"\n x=\"90\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.57648\"\n x=\"90\"\n id=\"tspan6247\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8\"\n y=\"213.07455\"\n x=\"184.47076\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"213.07455\"\n x=\"184.47076\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8\"\n y=\"262.00311\"\n x=\"192.32663\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"262.00311\"\n x=\"192.32663\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(18,0)\"\n id=\"g11773\">\n <g\n id=\"g11763\">\n <rect\n y=\"120.8597\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308\"\n y=\"129.96561\"\n x=\"63.277264\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"129.96561\"\n x=\"63.277264\"\n id=\"tspan6310\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g11768\">\n <rect\n y=\"135.43114\"\n x=\"58.558922\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304\"\n y=\"144.58977\"\n x=\"64.540932\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"144.58977\"\n x=\"64.540932\"\n id=\"tspan6306\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(54,-16)\"\n id=\"g10674\">\n <g\n id=\"g10664\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <g\n transform=\"translate(86.857134,-15.571435)\"\n id=\"g10674-6\">\n <g\n id=\"g10664-6\"\n transform=\"translate(0,29.14287)\">\n <rect\n y=\"121.72949\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-0-5\"\n style=\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-9\"\n y=\"130.8354\"\n x=\"173.51424\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"130.8354\"\n x=\"173.51424\"\n id=\"tspan6310-7-6\"\n sodipodi:role=\"line\">w</tspan></text>\n </g>\n <g\n id=\"g10669-5\">\n <rect\n y=\"136.30093\"\n x=\"168.7959\"\n height=\"13.836793\"\n width=\"15.97965\"\n id=\"rect4573-0-7-4-7-4\"\n style=\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6304-5-3\"\n y=\"145.45956\"\n x=\"174.77791\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"145.45956\"\n x=\"174.77791\"\n id=\"tspan6306-6-1\"\n sodipodi:role=\"line\">r</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726\"\n y=\"139.6479\"\n x=\"135.03683\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"139.6479\"\n x=\"135.03683\"\n id=\"tspan10728\"\n sodipodi:role=\"line\">Popen</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-89\"\n y=\"158.43169\"\n x=\"234.46947\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-24\"\n style=\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\"\n y=\"158.43169\"\n x=\"234.46947\"\n sodipodi:role=\"line\">pipes</tspan></text>\n </g>\n <g\n id=\"g11847\"\n transform=\"translate(-10,0.39179)\">\n <a\n style=\"fill:#b380ff\"\n id=\"a6328-0\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-8\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(-4.6428572,12.857143)\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10591-3\"\n y=\"240.5825\"\n x=\"372.50137\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"240.5825\"\n x=\"372.50137\"\n id=\"tspan10593-2\"\n sodipodi:role=\"line\">Child</tspan></text>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path11075\"\n d=\"m 397.80427,110.64896 0,-52.85714\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\" />\n <g\n id=\"g10626-5\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n sodipodi:type=\"arc\"\n style=\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\"\n id=\"path4575-2-4\"\n sodipodi:cx=\"160.71428\"\n sodipodi:cy=\"222.89789\"\n sodipodi:rx=\"41.07143\"\n sodipodi:ry=\"25.535715\"\n d=\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\"\n transform=\"translate(2.6428639,-191.24999)\" />\n <text\n xml:space=\"preserve\"\n style=\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n x=\"140.40549\"\n y=\"36.651806\"\n id=\"text6334-0\"\n sodipodi:linespacing=\"125%\"><tspan\n sodipodi:role=\"line\"\n id=\"tspan6336-9\"\n x=\"140.40549\"\n y=\"36.651806\">Parent</tspan></text>\n </g>\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-4\"\n d=\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <path\n sodipodi:nodetypes=\"cc\"\n inkscape:connector-curvature=\"0\"\n id=\"path2991-7-87\"\n d=\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\"\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\" />\n <a\n id=\"a6331-7\"\n transform=\"translate(233.85132,-0.39179)\">\n <path\n style=\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\"\n d=\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\"\n id=\"path2991-7-8-4\"\n inkscape:connector-curvature=\"0\"\n sodipodi:nodetypes=\"cc\" />\n </a>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-6\"\n y=\"240.18468\"\n x=\"323.85132\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"240.18468\"\n x=\"323.85132\"\n id=\"tspan6247-3\"\n sodipodi:role=\"line\">stdin</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-6\"\n y=\"207.68279\"\n x=\"410.10779\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6270-2\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"207.68279\"\n x=\"410.10779\"\n sodipodi:role=\"line\">stdout</tspan></text>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6245-8-8-1\"\n y=\"261.61133\"\n x=\"426.17795\"\n style=\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n id=\"tspan6298-3\"\n style=\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\"\n y=\"261.61133\"\n x=\"426.17795\"\n sodipodi:role=\"line\">stderr</tspan></text>\n <g\n transform=\"translate(227.5656,-301.02546)\"\n id=\"g11065\">\n <g\n id=\"g11055\">\n <rect\n y=\"421.34998\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55\"\n style=\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6\"\n y=\"431.01376\"\n x=\"159.1624\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"431.01376\"\n x=\"159.1624\"\n id=\"tspan6310-7-9\"\n sodipodi:role=\"line\">slave</tspan></text>\n </g>\n <g\n id=\"g11060\">\n <rect\n y=\"407.25223\"\n x=\"147.24721\"\n height=\"13.362738\"\n width=\"44.791309\"\n id=\"rect4573-0-7-0-55-9\"\n style=\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\" />\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text6308-1-6-7\"\n y=\"416.68555\"\n x=\"155.16631\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n y=\"416.68555\"\n x=\"155.16631\"\n id=\"tspan6310-7-9-7\"\n sodipodi:role=\"line\">master</tspan></text>\n </g>\n </g>\n <text\n sodipodi:linespacing=\"125%\"\n id=\"text10726-9\"\n y=\"116.71899\"\n x=\"429.1268\"\n style=\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\"\n xml:space=\"preserve\"><tspan\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"116.71899\"\n x=\"429.1268\"\n id=\"tspan10728-7\"\n sodipodi:role=\"line\">Pseudoterminal</tspan><tspan\n id=\"tspan11761\"\n style=\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\"\n y=\"136.71899\"\n x=\"429.1268\"\n sodipodi:role=\"line\">(pty)</tspan></text>\n </g>\n </g>\n</svg>\n\n[end of docs/images/pty_vs_popen.svg]","filename":"docs/images/pty_vs_popen.svg","id":"12"},{"content":"None\n[end of docs/images/pty_vs_popen.png]","filename":"docs/images/pty_vs_popen.png","id":"13"}],"string":"[\n {\n \"content\": \"python:\\n version: 3\\n\\n[end of readthedocs.yml]\",\n \"filename\": \"readthedocs.yml\",\n \"id\": \"0\"\n },\n {\n \"content\": \"ISC LICENSE\\n\\n This license is approved by the OSI and FSF as GPL-compatible.\\n http://opensource.org/licenses/isc-license.txt\\n\\n Copyright (c) 2013-2014, Pexpect development team\\n Copyright (c) 2012, Noah Spurrier <noah@noah.org>\\n\\n Permission to use, copy, modify, and/or distribute this software for any\\n purpose with or without fee is hereby granted, provided that the above\\n copyright notice and this permission notice appear in all copies.\\n \\n THE SOFTWARE IS PROVIDED \\\"AS IS\\\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\\n WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\\n MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\\n ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\\n WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\\n ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\\n OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"1\"\n },\n {\n \"content\": \"[build-system]\\nrequires = [\\\"flit_core >=2,<4\\\"]\\nbuild-backend = \\\"flit_core.buildapi\\\"\\n\\n[tool.flit.metadata]\\nmodule = \\\"ptyprocess\\\"\\nauthor = \\\"Thomas Kluyver\\\"\\nauthor-email = \\\"thomas@kluyver.me.uk\\\"\\nhome-page = \\\"https://github.com/pexpect/ptyprocess\\\"\\ndescription-file = \\\"README.rst\\\"\\nrequires-python = \\\">=3.7\\\"\\nclassifiers = [\\n \\\"Development Status :: 5 - Production/Stable\\\",\\n \\\"Environment :: Console\\\",\\n \\\"Intended Audience :: Developers\\\",\\n \\\"Intended Audience :: System Administrators\\\",\\n \\\"License :: OSI Approved :: ISC License (ISCL)\\\",\\n \\\"Operating System :: POSIX\\\",\\n \\\"Operating System :: MacOS :: MacOS X\\\",\\n \\\"Programming Language :: Python\\\",\\n \\\"Programming Language :: Python :: 3\\\",\\n \\\"Topic :: Terminals\\\"\\n]\\n\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"2\"\n },\n {\n \"content\": \"Launch a subprocess in a pseudo terminal (pty), and interact with both the\\nprocess and its pty.\\n\\nSometimes, piping stdin and stdout is not enough. There might be a password\\nprompt that doesn't read from stdin, output that changes when it's going to a\\npipe rather than a terminal, or curses-style interfaces that rely on a terminal.\\nIf you need to automate these things, running the process in a pseudo terminal\\n(pty) is the answer.\\n\\nInterface:\\n\\n.. code:: python\\n\\n from ptyprocess import PtyProcessUnicode\\n p = PtyProcessUnicode.spawn(['python'])\\n p.read(20)\\n p.write('6+6\\\\n')\\n p.read(20)\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"3\"\n },\n {\n \"content\": \"Ptyprocess\\n==========\\n\\n.. include:: ../README.rst\\n\\nContents:\\n\\n.. toctree::\\n :maxdepth: 2\\n\\n api\\n\\nWhat is a pty?\\n--------------\\n\\nA pty is a kernel-level object which processes can write data to and read data\\nfrom, a bit like a pipe.\\n\\nUnlike a pipe, data moves through a single pty in both directions. When you use\\na program in a shell pipeline, or with :class:`subprocess.Popen` in Python, up\\nto three pipes are created for the process's standard streams (stdin, stdout\\nand stderr). When you run a program using ptyprocess, all three of its standard\\nstreams are connected to a single pty:\\n\\n.. image:: images/pty_vs_popen.png\\n\\nA pty also does more than a pipe. It keeps track of the window size (rows and\\ncolumns of characters) and notifies child processes (with a SIGWINCH signal)\\nwhen it changes. In *cooked mode*, it does some processing of data sent from the\\nparent process, so for instance the byte ``03`` (entered as Ctrl-C) will cause\\nSIGINT to be sent to the child process.\\n\\nMany command line programs behave differently if they detect that stdin or stdout\\nis connected to a terminal instead of a pipe (using \\n`isatty() <http://linux.die.net/man/3/isatty>`_), because this normally means\\nthat they're being used interactively by a human user.\\nThey may format output differently (e.g. ``ls`` lists files in columns)\\nor prompt the user to confirm actions.\\nWhen you run these programs in ptyprocess, they will exhibit their 'interactive'\\nbehaviour, instead of the 'pipe' behaviour you'll see using ``Popen()``.\\n\\n.. seealso::\\n\\n `The TTY demystified <http://www.linusakesson.net/programming/tty/>`_\\n Detailed article by Linus Akesson\\n\\nIndices and tables\\n==================\\n\\n* :ref:`genindex`\\n* :ref:`modindex`\\n* :ref:`search`\\n\\n\\n[end of docs/index.rst]\",\n \"filename\": \"docs/index.rst\",\n \"id\": \"4\"\n },\n {\n \"content\": \"# Makefile for Sphinx documentation\\n#\\n\\n# You can set these variables from the command line.\\nSPHINXOPTS =\\nSPHINXBUILD = sphinx-build\\nPAPER =\\nBUILDDIR = _build\\n\\n# User-friendly check for sphinx-build\\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\\nendif\\n\\n# Internal variables.\\nPAPEROPT_a4 = -D latex_paper_size=a4\\nPAPEROPT_letter = -D latex_paper_size=letter\\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n# the i18n builder cannot share the environment and doctrees with the others\\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\\n\\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\\n\\nhelp:\\n\\t@echo \\\"Please use \\\\`make <target>' where <target> is one of\\\"\\n\\t@echo \\\" html to make standalone HTML files\\\"\\n\\t@echo \\\" dirhtml to make HTML files named index.html in directories\\\"\\n\\t@echo \\\" singlehtml to make a single large HTML file\\\"\\n\\t@echo \\\" pickle to make pickle files\\\"\\n\\t@echo \\\" json to make JSON files\\\"\\n\\t@echo \\\" htmlhelp to make HTML files and a HTML help project\\\"\\n\\t@echo \\\" qthelp to make HTML files and a qthelp project\\\"\\n\\t@echo \\\" devhelp to make HTML files and a Devhelp project\\\"\\n\\t@echo \\\" epub to make an epub\\\"\\n\\t@echo \\\" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\\\"\\n\\t@echo \\\" latexpdf to make LaTeX files and run them through pdflatex\\\"\\n\\t@echo \\\" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\\\"\\n\\t@echo \\\" text to make text files\\\"\\n\\t@echo \\\" man to make manual pages\\\"\\n\\t@echo \\\" texinfo to make Texinfo files\\\"\\n\\t@echo \\\" info to make Texinfo files and run them through makeinfo\\\"\\n\\t@echo \\\" gettext to make PO message catalogs\\\"\\n\\t@echo \\\" changes to make an overview of all changed/added/deprecated items\\\"\\n\\t@echo \\\" xml to make Docutils-native XML files\\\"\\n\\t@echo \\\" pseudoxml to make pseudoxml-XML files for display purposes\\\"\\n\\t@echo \\\" linkcheck to check all external links for integrity\\\"\\n\\t@echo \\\" doctest to run all doctests embedded in the documentation (if enabled)\\\"\\n\\nclean:\\n\\trm -rf $(BUILDDIR)/*\\n\\nhtml:\\n\\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/html.\\\"\\n\\ndirhtml:\\n\\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\\\"\\n\\nsinglehtml:\\n\\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\\n\\t@echo\\n\\t@echo \\\"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\\\"\\n\\npickle:\\n\\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the pickle files.\\\"\\n\\njson:\\n\\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can process the JSON files.\\\"\\n\\nhtmlhelp:\\n\\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run HTML Help Workshop with the\\\" \\\\\\n\\t \\\".hhp project file in $(BUILDDIR)/htmlhelp.\\\"\\n\\nqthelp:\\n\\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\\n\\t@echo\\n\\t@echo \\\"Build finished; now you can run \\\"qcollectiongenerator\\\" with the\\\" \\\\\\n\\t \\\".qhcp project file in $(BUILDDIR)/qthelp, like this:\\\"\\n\\t@echo \\\"# qcollectiongenerator $(BUILDDIR)/qthelp/Ptyprocess.qhcp\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# assistant -collectionFile $(BUILDDIR)/qthelp/Ptyprocess.qhc\\\"\\n\\ndevhelp:\\n\\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\\n\\t@echo\\n\\t@echo \\\"Build finished.\\\"\\n\\t@echo \\\"To view the help file:\\\"\\n\\t@echo \\\"# mkdir -p $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ptyprocess\\\"\\n\\t@echo \\\"# devhelp\\\"\\n\\nepub:\\n\\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\\n\\t@echo\\n\\t@echo \\\"Build finished. The epub file is in $(BUILDDIR)/epub.\\\"\\n\\nlatex:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo\\n\\t@echo \\\"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through (pdf)latex\\\" \\\\\\n\\t \\\"(use \\\\`make latexpdf' here to do that automatically).\\\"\\n\\nlatexpdf:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through pdflatex...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\nlatexpdfja:\\n\\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\\n\\t@echo \\\"Running LaTeX files through platex and dvipdfmx...\\\"\\n\\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\\n\\t@echo \\\"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\\\"\\n\\ntext:\\n\\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\\n\\t@echo\\n\\t@echo \\\"Build finished. The text files are in $(BUILDDIR)/text.\\\"\\n\\nman:\\n\\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\\n\\t@echo\\n\\t@echo \\\"Build finished. The manual pages are in $(BUILDDIR)/man.\\\"\\n\\ntexinfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo\\n\\t@echo \\\"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\\\"\\n\\t@echo \\\"Run \\\\`make' in that directory to run these through makeinfo\\\" \\\\\\n\\t \\\"(use \\\\`make info' here to do that automatically).\\\"\\n\\ninfo:\\n\\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\\n\\t@echo \\\"Running Texinfo files through makeinfo...\\\"\\n\\tmake -C $(BUILDDIR)/texinfo info\\n\\t@echo \\\"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\\\"\\n\\ngettext:\\n\\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\\n\\t@echo\\n\\t@echo \\\"Build finished. The message catalogs are in $(BUILDDIR)/locale.\\\"\\n\\nchanges:\\n\\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\\n\\t@echo\\n\\t@echo \\\"The overview file is in $(BUILDDIR)/changes.\\\"\\n\\nlinkcheck:\\n\\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\\n\\t@echo\\n\\t@echo \\\"Link check complete; look for any errors in the above output \\\" \\\\\\n\\t \\\"or in $(BUILDDIR)/linkcheck/output.txt.\\\"\\n\\ndoctest:\\n\\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\\n\\t@echo \\\"Testing of doctests in the sources finished, look at the \\\" \\\\\\n\\t \\\"results in $(BUILDDIR)/doctest/output.txt.\\\"\\n\\nxml:\\n\\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\\n\\t@echo\\n\\t@echo \\\"Build finished. The XML files are in $(BUILDDIR)/xml.\\\"\\n\\npseudoxml:\\n\\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\\n\\t@echo\\n\\t@echo \\\"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\\\"\\n\\n[end of docs/Makefile]\",\n \"filename\": \"docs/Makefile\",\n \"id\": \"5\"\n },\n {\n \"content\": \"# -*- coding: utf-8 -*-\\n#\\n# Ptyprocess documentation build configuration file, created by\\n# sphinx-quickstart on Mon Oct 13 11:03:02 2014.\\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\\n# autogenerated file.\\n#\\n# All configuration values have a default; values that are commented out\\n# serve to show the default.\\n\\nimport sys\\nimport os\\n\\n# If extensions (or modules to document with autodoc) are in another directory,\\n# add these directories to sys.path here. If the directory is relative to the\\n# documentation root, use os.path.abspath to make it absolute, like shown here.\\nsys.path.insert(0, os.path.abspath('..'))\\n\\n# -- General configuration ------------------------------------------------\\n\\n# If your documentation needs a minimal Sphinx version, state it here.\\n#needs_sphinx = '1.0'\\n\\n# Add any Sphinx extension module names here, as strings. They can be\\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\\n# ones.\\nextensions = [\\n 'sphinx.ext.autodoc',\\n 'sphinx.ext.intersphinx',\\n 'sphinx.ext.viewcode',\\n]\\n\\n# Add any paths that contain templates here, relative to this directory.\\ntemplates_path = ['_templates']\\n\\n# The suffix of source filenames.\\nsource_suffix = '.rst'\\n\\n# The encoding of source files.\\n#source_encoding = 'utf-8-sig'\\n\\n# The master toctree document.\\nmaster_doc = 'index'\\n\\n# General information about the project.\\nproject = u'Ptyprocess'\\ncopyright = u'2014, Thomas Kluyver'\\n\\n# The version info for the project you're documenting, acts as replacement for\\n# |version| and |release|, also used in various other places throughout the\\n# built documents.\\n#\\n# The short X.Y version.\\nversion = '0.7'\\n# The full version, including alpha/beta/rc tags.\\nrelease = version #+ '.2'\\n\\n# The language for content autogenerated by Sphinx. Refer to documentation\\n# for a list of supported languages.\\n#language = None\\n\\n# There are two options for replacing |today|: either, you set today to some\\n# non-false value, then it is used:\\n#today = ''\\n# Else, today_fmt is used as the format for a strftime call.\\n#today_fmt = '%B %d, %Y'\\n\\n# List of patterns, relative to source directory, that match files and\\n# directories to ignore when looking for source files.\\nexclude_patterns = ['_build']\\n\\n# The reST default role (used for this markup: `text`) to use for all\\n# documents.\\n#default_role = None\\n\\n# If true, '()' will be appended to :func: etc. cross-reference text.\\n#add_function_parentheses = True\\n\\n# If true, the current module name will be prepended to all description\\n# unit titles (such as .. function::).\\n#add_module_names = True\\n\\n# If true, sectionauthor and moduleauthor directives will be shown in the\\n# output. They are ignored by default.\\n#show_authors = False\\n\\n# The name of the Pygments (syntax highlighting) style to use.\\npygments_style = 'sphinx'\\n\\n# A list of ignored prefixes for module index sorting.\\n#modindex_common_prefix = []\\n\\n# If true, keep warnings as \\\"system message\\\" paragraphs in the built documents.\\n#keep_warnings = False\\n\\n\\n# -- Options for HTML output ----------------------------------------------\\n\\n# The theme to use for HTML and HTML Help pages. See the documentation for\\n# a list of builtin themes.\\nhtml_theme = 'default'\\n\\n# Theme options are theme-specific and customize the look and feel of a theme\\n# further. For a list of options available for each theme, see the\\n# documentation.\\n#html_theme_options = {}\\n\\n# Add any paths that contain custom themes here, relative to this directory.\\n#html_theme_path = []\\n\\n# The name for this set of Sphinx documents. If None, it defaults to\\n# \\\"<project> v<release> documentation\\\".\\n#html_title = None\\n\\n# A shorter title for the navigation bar. Default is the same as html_title.\\n#html_short_title = None\\n\\n# The name of an image file (relative to this directory) to place at the top\\n# of the sidebar.\\n#html_logo = None\\n\\n# The name of an image file (within the static path) to use as favicon of the\\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\\n# pixels large.\\n#html_favicon = None\\n\\n# Add any paths that contain custom static files (such as style sheets) here,\\n# relative to this directory. They are copied after the builtin static files,\\n# so a file named \\\"default.css\\\" will overwrite the builtin \\\"default.css\\\".\\nhtml_static_path = ['_static']\\n\\n# Add any extra paths that contain custom files (such as robots.txt or\\n# .htaccess) here, relative to this directory. These files are copied\\n# directly to the root of the documentation.\\n#html_extra_path = []\\n\\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\\n# using the given strftime format.\\n#html_last_updated_fmt = '%b %d, %Y'\\n\\n# If true, SmartyPants will be used to convert quotes and dashes to\\n# typographically correct entities.\\n#html_use_smartypants = True\\n\\n# Custom sidebar templates, maps document names to template names.\\n#html_sidebars = {}\\n\\n# Additional templates that should be rendered to pages, maps page names to\\n# template names.\\n#html_additional_pages = {}\\n\\n# If false, no module index is generated.\\n#html_domain_indices = True\\n\\n# If false, no index is generated.\\n#html_use_index = True\\n\\n# If true, the index is split into individual pages for each letter.\\n#html_split_index = False\\n\\n# If true, links to the reST sources are added to the pages.\\n#html_show_sourcelink = True\\n\\n# If true, \\\"Created using Sphinx\\\" is shown in the HTML footer. Default is True.\\n#html_show_sphinx = True\\n\\n# If true, \\\"(C) Copyright ...\\\" is shown in the HTML footer. Default is True.\\n#html_show_copyright = True\\n\\n# If true, an OpenSearch description file will be output, and all pages will\\n# contain a <link> tag referring to it. The value of this option must be the\\n# base URL from which the finished HTML is served.\\n#html_use_opensearch = ''\\n\\n# This is the file name suffix for HTML files (e.g. \\\".xhtml\\\").\\n#html_file_suffix = None\\n\\n# Output file base name for HTML help builder.\\nhtmlhelp_basename = 'Ptyprocessdoc'\\n\\n\\n# -- Options for LaTeX output ---------------------------------------------\\n\\nlatex_elements = {\\n# The paper size ('letterpaper' or 'a4paper').\\n#'papersize': 'letterpaper',\\n\\n# The font size ('10pt', '11pt' or '12pt').\\n#'pointsize': '10pt',\\n\\n# Additional stuff for the LaTeX preamble.\\n#'preamble': '',\\n}\\n\\n# Grouping the document tree into LaTeX files. List of tuples\\n# (source start file, target name, title,\\n# author, documentclass [howto, manual, or own class]).\\nlatex_documents = [\\n ('index', 'Ptyprocess.tex', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'manual'),\\n]\\n\\n# The name of an image file (relative to this directory) to place at the top of\\n# the title page.\\n#latex_logo = None\\n\\n# For \\\"manual\\\" documents, if this is true, then toplevel headings are parts,\\n# not chapters.\\n#latex_use_parts = False\\n\\n# If true, show page references after internal links.\\n#latex_show_pagerefs = False\\n\\n# If true, show URL addresses after external links.\\n#latex_show_urls = False\\n\\n# Documents to append as an appendix to all manuals.\\n#latex_appendices = []\\n\\n# If false, no module index is generated.\\n#latex_domain_indices = True\\n\\n\\n# -- Options for manual page output ---------------------------------------\\n\\n# One entry per manual page. List of tuples\\n# (source start file, name, description, authors, manual section).\\nman_pages = [\\n ('index', 'ptyprocess', u'Ptyprocess Documentation',\\n [u'Thomas Kluyver'], 1)\\n]\\n\\n# If true, show URL addresses after external links.\\n#man_show_urls = False\\n\\n\\n# -- Options for Texinfo output -------------------------------------------\\n\\n# Grouping the document tree into Texinfo files. List of tuples\\n# (source start file, target name, title, author,\\n# dir menu entry, description, category)\\ntexinfo_documents = [\\n ('index', 'Ptyprocess', u'Ptyprocess Documentation',\\n u'Thomas Kluyver', 'Ptyprocess', 'One line description of project.',\\n 'Miscellaneous'),\\n]\\n\\n# Documents to append as an appendix to all manuals.\\n#texinfo_appendices = []\\n\\n# If false, no module index is generated.\\n#texinfo_domain_indices = True\\n\\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\\n#texinfo_show_urls = 'footnote'\\n\\n# If true, do not generate a @detailmenu in the \\\"Top\\\" node's menu.\\n#texinfo_no_detailmenu = False\\n\\n\\n# Example configuration for intersphinx: refer to the Python standard library.\\nintersphinx_mapping = {'http://docs.python.org/': None}\\n\\n[end of docs/conf.py]\",\n \"filename\": \"docs/conf.py\",\n \"id\": \"6\"\n },\n {\n \"content\": \"Ptyprocess API\\n==============\\n\\n.. module:: ptyprocess\\n\\n.. autoclass:: PtyProcess\\n\\n .. automethod:: spawn\\n\\n .. automethod:: read\\n\\n .. automethod:: readline\\n\\n .. automethod:: write\\n\\n .. automethod:: sendcontrol\\n\\n .. automethod:: sendeof\\n\\n .. automethod:: sendintr\\n\\n .. automethod:: getecho\\n\\n .. automethod:: waitnoecho\\n\\n .. automethod:: setecho\\n\\n .. automethod:: getwinsize\\n\\n .. automethod:: setwinsize\\n\\n .. automethod:: eof\\n\\n .. automethod:: isalive\\n\\n .. automethod:: wait\\n\\n .. automethod:: kill\\n\\n .. automethod:: terminate\\n\\n .. automethod:: close\\n\\n.. autoclass:: PtyProcessUnicode\\n\\n[end of docs/api.rst]\",\n \"filename\": \"docs/api.rst\",\n \"id\": \"7\"\n },\n {\n \"content\": \"try:\\n from shutil import which # Python >= 3.3\\nexcept ImportError:\\n import os, sys\\n \\n # This is copied from Python 3.4.1\\n def which(cmd, mode=os.F_OK | os.X_OK, path=None):\\n \\\"\\\"\\\"Given a command, mode, and a PATH string, return the path which\\n conforms to the given mode on the PATH, or None if there is no such\\n file.\\n \\n `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result\\n of os.environ.get(\\\"PATH\\\"), or can be overridden with a custom search\\n path.\\n \\n \\\"\\\"\\\"\\n # Check that a given file can be accessed with the correct mode.\\n # Additionally check that `file` is not a directory, as on Windows\\n # directories pass the os.access check.\\n def _access_check(fn, mode):\\n return (os.path.exists(fn) and os.access(fn, mode)\\n and not os.path.isdir(fn))\\n \\n # If we're given a path with a directory part, look it up directly rather\\n # than referring to PATH directories. This includes checking relative to the\\n # current directory, e.g. ./script\\n if os.path.dirname(cmd):\\n if _access_check(cmd, mode):\\n return cmd\\n return None\\n \\n if path is None:\\n path = os.environ.get(\\\"PATH\\\", os.defpath)\\n if not path:\\n return None\\n path = path.split(os.pathsep)\\n \\n if sys.platform == \\\"win32\\\":\\n # The current directory takes precedence on Windows.\\n if not os.curdir in path:\\n path.insert(0, os.curdir)\\n \\n # PATHEXT is necessary to check on Windows.\\n pathext = os.environ.get(\\\"PATHEXT\\\", \\\"\\\").split(os.pathsep)\\n # See if the given file matches any of the expected path extensions.\\n # This will allow us to short circuit when given \\\"python.exe\\\".\\n # If it does match, only test that one, otherwise we have to try\\n # others.\\n if any(cmd.lower().endswith(ext.lower()) for ext in pathext):\\n files = [cmd]\\n else:\\n files = [cmd + ext for ext in pathext]\\n else:\\n # On other platforms you don't have things like PATHEXT to tell you\\n # what file suffixes are executable, so just pass on cmd as-is.\\n files = [cmd]\\n \\n seen = set()\\n for dir in path:\\n normdir = os.path.normcase(dir)\\n if not normdir in seen:\\n seen.add(normdir)\\n for thefile in files:\\n name = os.path.join(dir, thefile)\\n if _access_check(name, mode):\\n return name\\n return None\\n\\n\\nclass PtyProcessError(Exception):\\n \\\"\\\"\\\"Generic error class for this package.\\\"\\\"\\\"\\n\\n[end of ptyprocess/util.py]\",\n \"filename\": \"ptyprocess/util.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Substitute for the forkpty system call, to support Solaris.\\n\\\"\\\"\\\"\\nimport os\\nimport errno\\n\\nfrom pty import (STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO, CHILD)\\nfrom .util import PtyProcessError\\n\\ndef fork_pty():\\n '''This implements a substitute for the forkpty system call. This\\n should be more portable than the pty.fork() function. Specifically,\\n this should work on Solaris.\\n\\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\\n resolve the issue with Python's pty.fork() not supporting Solaris,\\n particularly ssh. Based on patch to posixmodule.c authored by Noah\\n Spurrier::\\n\\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\\n\\n '''\\n\\n parent_fd, child_fd = os.openpty()\\n if parent_fd < 0 or child_fd < 0:\\n raise OSError(\\\"os.openpty() failed\\\")\\n\\n pid = os.fork()\\n if pid == CHILD:\\n # Child.\\n os.close(parent_fd)\\n pty_make_controlling_tty(child_fd)\\n\\n os.dup2(child_fd, STDIN_FILENO)\\n os.dup2(child_fd, STDOUT_FILENO)\\n os.dup2(child_fd, STDERR_FILENO)\\n\\n else:\\n # Parent.\\n os.close(child_fd)\\n\\n return pid, parent_fd\\n\\ndef pty_make_controlling_tty(tty_fd):\\n '''This makes the pseudo-terminal the controlling tty. This should be\\n more portable than the pty.fork() function. Specifically, this should\\n work on Solaris. '''\\n\\n child_name = os.ttyname(tty_fd)\\n\\n # Disconnect from controlling tty, if any. Raises OSError of ENXIO\\n # if there was no controlling tty to begin with, such as when\\n # executed by a cron(1) job.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n os.setsid()\\n\\n # Verify we are disconnected from controlling tty by attempting to open\\n # it again. We expect that OSError of ENXIO should always be raised.\\n try:\\n fd = os.open(\\\"/dev/tty\\\", os.O_RDWR | os.O_NOCTTY)\\n os.close(fd)\\n raise PtyProcessError(\\\"OSError of errno.ENXIO should be raised.\\\")\\n except OSError as err:\\n if err.errno != errno.ENXIO:\\n raise\\n\\n # Verify we can open child pty.\\n fd = os.open(child_name, os.O_RDWR)\\n os.close(fd)\\n\\n # Verify we now have a controlling tty.\\n fd = os.open(\\\"/dev/tty\\\", os.O_WRONLY)\\n os.close(fd)\\n\\n[end of ptyprocess/_fork_pty.py]\",\n \"filename\": \"ptyprocess/_fork_pty.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"import codecs\\nimport errno\\nimport fcntl\\nimport io\\nimport os\\nimport pty\\nimport resource\\nimport signal\\nimport struct\\nimport sys\\nimport termios\\nimport time\\n\\ntry:\\n import builtins # Python 3\\nexcept ImportError:\\n import __builtin__ as builtins # Python 2\\n\\n# Constants\\nfrom pty import (STDIN_FILENO, CHILD)\\n\\nfrom .util import which, PtyProcessError\\n\\n_platform = sys.platform.lower()\\n\\n# Solaris uses internal __fork_pty(). All others use pty.fork().\\n_is_solaris = (\\n _platform.startswith('solaris') or\\n _platform.startswith('sunos'))\\n\\nif _is_solaris:\\n use_native_pty_fork = False\\n from . import _fork_pty\\nelse:\\n use_native_pty_fork = True\\n\\nPY3 = sys.version_info[0] >= 3\\n\\nif PY3:\\n def _byte(i):\\n return bytes([i])\\nelse:\\n def _byte(i):\\n return chr(i)\\n \\n class FileNotFoundError(OSError): pass\\n class TimeoutError(OSError): pass\\n\\n_EOF, _INTR = None, None\\n\\ndef _make_eof_intr():\\n \\\"\\\"\\\"Set constants _EOF and _INTR.\\n \\n This avoids doing potentially costly operations on module load.\\n \\\"\\\"\\\"\\n global _EOF, _INTR\\n if (_EOF is not None) and (_INTR is not None):\\n return\\n\\n # inherit EOF and INTR definitions from controlling process.\\n try:\\n from termios import VEOF, VINTR\\n fd = None\\n for name in 'stdin', 'stdout':\\n stream = getattr(sys, '__%s__' % name, None)\\n if stream is None or not hasattr(stream, 'fileno'):\\n continue\\n try:\\n fd = stream.fileno()\\n except ValueError:\\n continue\\n if fd is None:\\n # no fd, raise ValueError to fallback on CEOF, CINTR\\n raise ValueError(\\\"No stream has a fileno\\\")\\n intr = ord(termios.tcgetattr(fd)[6][VINTR])\\n eof = ord(termios.tcgetattr(fd)[6][VEOF])\\n except (ImportError, OSError, IOError, ValueError, termios.error):\\n # unless the controlling process is also not a terminal,\\n # such as cron(1), or when stdin and stdout are both closed.\\n # Fall-back to using CEOF and CINTR. There\\n try:\\n from termios import CEOF, CINTR\\n (intr, eof) = (CINTR, CEOF)\\n except ImportError:\\n # ^C, ^D\\n (intr, eof) = (3, 4)\\n \\n _INTR = _byte(intr)\\n _EOF = _byte(eof)\\n\\n# setecho and setwinsize are pulled out here because on some platforms, we need\\n# to do this from the child before we exec()\\n \\ndef _setecho(fd, state):\\n errmsg = 'setecho() may not be called on this platform (it may still be possible to enable/disable echo when spawning the child process)'\\n\\n try:\\n attr = termios.tcgetattr(fd)\\n except termios.error as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n if state:\\n attr[3] = attr[3] | termios.ECHO\\n else:\\n attr[3] = attr[3] & ~termios.ECHO\\n\\n try:\\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent and\\n # blocked on some platforms. TCSADRAIN would probably be ideal.\\n termios.tcsetattr(fd, termios.TCSANOW, attr)\\n except IOError as err:\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\ndef _setwinsize(fd, rows, cols):\\n # Some very old platforms have a bug that causes the value for\\n # termios.TIOCSWINSZ to be truncated. There was a hack here to work\\n # around this, but it caused problems with newer platforms so has been\\n # removed. For details see https://github.com/pexpect/pexpect/issues/39\\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\\n # Note, assume ws_xpixel and ws_ypixel are zero.\\n s = struct.pack('HHHH', rows, cols, 0, 0)\\n fcntl.ioctl(fd, TIOCSWINSZ, s)\\n\\nclass PtyProcess(object):\\n '''This class represents a process running in a pseudoterminal.\\n \\n The main constructor is the :meth:`spawn` classmethod.\\n '''\\n string_type = bytes\\n if PY3:\\n linesep = os.linesep.encode('ascii')\\n crlf = '\\\\r\\\\n'.encode('ascii')\\n\\n @staticmethod\\n def write_to_stdout(b):\\n try:\\n return sys.stdout.buffer.write(b)\\n except AttributeError:\\n # If stdout has been replaced, it may not have .buffer\\n return sys.stdout.write(b.decode('ascii', 'replace'))\\n else:\\n linesep = os.linesep\\n crlf = '\\\\r\\\\n'\\n write_to_stdout = sys.stdout.write\\n\\n encoding = None\\n \\n argv = None\\n env = None\\n launch_dir = None\\n\\n def __init__(self, pid, fd):\\n _make_eof_intr() # Ensure _EOF and _INTR are calculated\\n self.pid = pid\\n self.fd = fd\\n readf = io.open(fd, 'rb', buffering=0)\\n writef = io.open(fd, 'wb', buffering=0, closefd=False)\\n self.fileobj = io.BufferedRWPair(readf, writef)\\n\\n self.terminated = False\\n self.closed = False\\n self.exitstatus = None\\n self.signalstatus = None\\n # status returned by os.waitpid\\n self.status = None\\n self.flag_eof = False\\n # Used by close() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterclose = 0.1\\n # Used by terminate() to give kernel time to update process status.\\n # Time in seconds.\\n self.delayafterterminate = 0.1\\n\\n @classmethod\\n def spawn(\\n cls, argv, cwd=None, env=None, echo=True, preexec_fn=None,\\n dimensions=(24, 80), pass_fds=()):\\n '''Start the given command in a child process in a pseudo terminal.\\n\\n This does all the fork/exec type of stuff for a pty, and returns an\\n instance of PtyProcess.\\n\\n If preexec_fn is supplied, it will be called with no arguments in the\\n child process before exec-ing the specified command.\\n It may, for instance, set signal handlers to SIG_DFL or SIG_IGN.\\n\\n Dimensions of the psuedoterminal used for the subprocess can be\\n specified as a tuple (rows, cols), or the default (24, 80) will be used.\\n\\n By default, all file descriptors except 0, 1 and 2 are closed. This\\n behavior can be overridden with pass_fds, a list of file descriptors to\\n keep open between the parent and the child.\\n '''\\n # Note that it is difficult for this method to fail.\\n # You cannot detect if the child process cannot start.\\n # So the only way you can tell if the child process started\\n # or not is to try to read from the file descriptor. If you get\\n # EOF immediately then it means that the child is already dead.\\n # That may not necessarily be bad because you may have spawned a child\\n # that performs some task; creates no stdout output; and then dies.\\n\\n if not isinstance(argv, (list, tuple)):\\n raise TypeError(\\\"Expected a list or tuple for argv, got %r\\\" % argv)\\n\\n # Shallow copy of argv so we can modify it\\n argv = argv[:]\\n command = argv[0]\\n\\n command_with_path = which(command)\\n if command_with_path is None:\\n raise FileNotFoundError('The command was not found or was not ' +\\n 'executable: %s.' % command)\\n command = command_with_path\\n argv[0] = command\\n\\n # [issue #119] To prevent the case where exec fails and the user is\\n # stuck interacting with a python child process instead of whatever\\n # was expected, we implement the solution from\\n # http://stackoverflow.com/a/3703179 to pass the exception to the\\n # parent process\\n\\n # [issue #119] 1. Before forking, open a pipe in the parent process.\\n exec_err_pipe_read, exec_err_pipe_write = os.pipe()\\n\\n if use_native_pty_fork:\\n pid, fd = pty.fork()\\n else:\\n # Use internal fork_pty, for Solaris\\n pid, fd = _fork_pty.fork_pty()\\n\\n # Some platforms must call setwinsize() and setecho() from the\\n # child process, and others from the master process. We do both,\\n # allowing IOError for either.\\n\\n if pid == CHILD:\\n # set window size\\n try:\\n _setwinsize(STDIN_FILENO, *dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # disable echo if spawn argument echo was unset\\n if not echo:\\n try:\\n _setecho(STDIN_FILENO, False)\\n except (IOError, termios.error) as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY):\\n raise\\n\\n # [issue #119] 3. The child closes the reading end and sets the\\n # close-on-exec flag for the writing end.\\n os.close(exec_err_pipe_read)\\n fcntl.fcntl(exec_err_pipe_write, fcntl.F_SETFD, fcntl.FD_CLOEXEC)\\n\\n # Do not allow child to inherit open file descriptors from parent,\\n # with the exception of the exec_err_pipe_write of the pipe\\n # and pass_fds.\\n # Impose ceiling on max_fd: AIX bugfix for users with unlimited\\n # nofiles where resource.RLIMIT_NOFILE is 2^63-1 and os.closerange()\\n # occasionally raises out of range error\\n max_fd = min(1048576, resource.getrlimit(resource.RLIMIT_NOFILE)[0])\\n spass_fds = sorted(set(pass_fds) | {exec_err_pipe_write})\\n for pair in zip([2] + spass_fds, spass_fds + [max_fd]):\\n os.closerange(pair[0]+1, pair[1])\\n\\n if cwd is not None:\\n os.chdir(cwd)\\n\\n if preexec_fn is not None:\\n try:\\n preexec_fn()\\n except Exception as e:\\n ename = type(e).__name__\\n tosend = '{}:0:{}'.format(ename, str(e))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(1)\\n\\n try:\\n if env is None:\\n os.execv(command, argv)\\n else:\\n os.execvpe(command, argv, env)\\n except OSError as err:\\n # [issue #119] 5. If exec fails, the child writes the error\\n # code back to the parent using the pipe, then exits.\\n tosend = 'OSError:{}:{}'.format(err.errno, str(err))\\n if PY3:\\n tosend = tosend.encode('utf-8')\\n os.write(exec_err_pipe_write, tosend)\\n os.close(exec_err_pipe_write)\\n os._exit(os.EX_OSERR)\\n\\n # Parent\\n inst = cls(pid, fd)\\n \\n # Set some informational attributes\\n inst.argv = argv\\n if env is not None:\\n inst.env = env\\n if cwd is not None:\\n inst.launch_dir = cwd\\n\\n # [issue #119] 2. After forking, the parent closes the writing end\\n # of the pipe and reads from the reading end.\\n os.close(exec_err_pipe_write)\\n exec_err_data = os.read(exec_err_pipe_read, 4096)\\n os.close(exec_err_pipe_read)\\n\\n # [issue #119] 6. The parent reads eof (a zero-length read) if the\\n # child successfully performed exec, since close-on-exec made\\n # successful exec close the writing end of the pipe. Or, if exec\\n # failed, the parent reads the error code and can proceed\\n # accordingly. Either way, the parent blocks until the child calls\\n # exec.\\n if len(exec_err_data) != 0:\\n try:\\n errclass, errno_s, errmsg = exec_err_data.split(b':', 2)\\n exctype = getattr(builtins, errclass.decode('ascii'), Exception)\\n\\n exception = exctype(errmsg.decode('utf-8', 'replace'))\\n if exctype is OSError:\\n exception.errno = int(errno_s)\\n except:\\n raise Exception('Subprocess failed, got bad error data: %r'\\n % exec_err_data)\\n else:\\n raise exception\\n\\n try:\\n inst.setwinsize(*dimensions)\\n except IOError as err:\\n if err.args[0] not in (errno.EINVAL, errno.ENOTTY, errno.ENXIO):\\n raise\\n\\n return inst\\n\\n def __repr__(self):\\n clsname = type(self).__name__\\n if self.argv is not None:\\n args = [repr(self.argv)]\\n if self.env is not None:\\n args.append(\\\"env=%r\\\" % self.env)\\n if self.launch_dir is not None:\\n args.append(\\\"cwd=%r\\\" % self.launch_dir)\\n \\n return \\\"{}.spawn({})\\\".format(clsname, \\\", \\\".join(args))\\n \\n else:\\n return \\\"{}(pid={}, fd={})\\\".format(clsname, self.pid, self.fd)\\n\\n @staticmethod\\n def _coerce_send_string(s):\\n if not isinstance(s, bytes):\\n return s.encode('utf-8')\\n return s\\n\\n @staticmethod\\n def _coerce_read_string(s):\\n return s\\n\\n def __del__(self):\\n '''This makes sure that no system resources are left open. Python only\\n garbage collects Python objects. OS file descriptors are not Python\\n objects, so they must be handled explicitly. If the child file\\n descriptor was opened outside of this class (passed to the constructor)\\n then this does not close it. '''\\n\\n if not self.closed:\\n # It is possible for __del__ methods to execute during the\\n # teardown of the Python VM itself. Thus self.close() may\\n # trigger an exception because os.close may be None.\\n try:\\n self.close()\\n # which exception, shouldn't we catch explicitly .. ?\\n except:\\n pass\\n\\n\\n def fileno(self):\\n '''This returns the file descriptor of the pty for the child.\\n '''\\n return self.fd\\n\\n def close(self, force=True):\\n '''This closes the connection with the child application. Note that\\n calling close() more than once is valid. This emulates standard Python\\n behavior with files. Set force to True if you want to make sure that\\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\\n and SIGINT). '''\\n if not self.closed:\\n self.flush()\\n self.fileobj.close() # Closes the file descriptor\\n # Give kernel time to update process status.\\n time.sleep(self.delayafterclose)\\n if self.isalive():\\n if not self.terminate(force):\\n raise PtyProcessError('Could not terminate the child.')\\n self.fd = -1\\n self.closed = True\\n #self.pid = None\\n\\n def flush(self):\\n '''This does nothing. It is here to support the interface for a\\n File-like object. '''\\n\\n pass\\n\\n def isatty(self):\\n '''This returns True if the file descriptor is open and connected to a\\n tty(-like) device, else False.\\n\\n On SVR4-style platforms implementing streams, such as SunOS and HP-UX,\\n the child pty may not appear as a terminal device. This means\\n methods such as setecho(), setwinsize(), getwinsize() may raise an\\n IOError. '''\\n\\n return os.isatty(self.fd)\\n\\n def waitnoecho(self, timeout=None):\\n '''Wait until the terminal ECHO flag is set False.\\n\\n This returns True if the echo mode is off, or False if echo was not\\n disabled before the timeout. This can be used to detect when the\\n child is waiting for a password. Usually a child application will turn\\n off echo mode when it is waiting for the user to enter a password. For\\n example, instead of expecting the \\\"password:\\\" prompt you can wait for\\n the child to turn echo off::\\n\\n p = pexpect.spawn('ssh user@example.com')\\n p.waitnoecho()\\n p.sendline(mypassword)\\n\\n If ``timeout=None`` then this method to block until ECHO flag is False.\\n '''\\n\\n if timeout is not None:\\n end_time = time.time() + timeout\\n while True:\\n if not self.getecho():\\n return True\\n if timeout < 0 and timeout is not None:\\n return False\\n if timeout is not None:\\n timeout = end_time - time.time()\\n time.sleep(0.1)\\n\\n def getecho(self):\\n '''Returns True if terminal echo is on, or False if echo is off.\\n\\n Child applications that are expecting you to enter a password often\\n disable echo. See also :meth:`waitnoecho`.\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n\\n try:\\n attr = termios.tcgetattr(self.fd)\\n except termios.error as err:\\n errmsg = 'getecho() may not be called on this platform'\\n if err.args[0] == errno.EINVAL:\\n raise IOError(err.args[0], '%s: %s.' % (err.args[1], errmsg))\\n raise\\n\\n self.echo = bool(attr[3] & termios.ECHO)\\n return self.echo\\n\\n def setecho(self, state):\\n '''Enable or disable terminal echo.\\n\\n Anything the child sent before the echo will be lost, so you should be\\n sure that your input buffer is empty before you call setecho().\\n For example, the following will work as expected::\\n\\n p = pexpect.spawn('cat') # Echo is on by default.\\n p.sendline('1234') # We expect see this twice from the child...\\n p.expect(['1234']) # ... once from the tty echo...\\n p.expect(['1234']) # ... and again from cat itself.\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n The following WILL NOT WORK because the lines sent before the setecho\\n will be lost::\\n\\n p = pexpect.spawn('cat')\\n p.sendline('1234')\\n p.setecho(False) # Turn off tty echo\\n p.sendline('abcd') # We will set this only once (echoed by cat).\\n p.sendline('wxyz') # We will set this only once (echoed by cat)\\n p.expect(['1234'])\\n p.expect(['1234'])\\n p.expect(['abcd'])\\n p.expect(['wxyz'])\\n\\n\\n Not supported on platforms where ``isatty()`` returns False.\\n '''\\n _setecho(self.fd, state)\\n\\n self.echo = state\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read and return at most ``size`` bytes from the pty.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\n Unlike Pexpect's ``read_nonblocking`` method, this doesn't try to deal\\n with the vagaries of EOF on platforms that do strange things, like IRIX\\n or older Solaris systems. It handles the errno=EIO pattern used on\\n Linux, and the empty-string return used on BSD platforms and (seemingly)\\n on recent Solaris.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.read1(size)\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n try:\\n s = self.fileobj.readline()\\n except (OSError, IOError) as err:\\n if err.args[0] == errno.EIO:\\n # Linux-style EOF\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Exception style platform.')\\n raise\\n if s == b'':\\n # BSD-style EOF (also appears to work on recent Solaris (OpenIndiana))\\n self.flag_eof = True\\n raise EOFError('End Of File (EOF). Empty string style platform.')\\n\\n return s\\n\\n def _writeb(self, b, flush=True):\\n n = self.fileobj.write(b)\\n if flush:\\n self.fileobj.flush()\\n return n\\n\\n def write(self, s, flush=True):\\n \\\"\\\"\\\"Write bytes to the pseudoterminal.\\n \\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n return self._writeb(s, flush=flush)\\n\\n def sendcontrol(self, char):\\n '''Helper method for sending control characters to the terminal.\\n\\n For example, to send Ctrl-G (ASCII 7, bell, ``'\\\\\\\\a'``)::\\n\\n child.sendcontrol('g')\\n\\n See also, :meth:`sendintr` and :meth:`sendeof`.\\n '''\\n char = char.lower()\\n a = ord(char)\\n if 97 <= a <= 122:\\n a = a - ord('a') + 1\\n byte = _byte(a)\\n return self._writeb(byte), byte\\n d = {'@': 0, '`': 0,\\n '[': 27, '{': 27,\\n '\\\\\\\\': 28, '|': 28,\\n ']': 29, '}': 29,\\n '^': 30, '~': 30,\\n '_': 31,\\n '?': 127}\\n if char not in d:\\n return 0, b''\\n\\n byte = _byte(d[char])\\n return self._writeb(byte), byte\\n\\n def sendeof(self):\\n '''Sends an EOF (typically Ctrl-D) through the terminal.\\n\\n This sends a character which causes\\n the pending parent output buffer to be sent to the waiting child\\n program without waiting for end-of-line. If it is the first character\\n of the line, the read() in the user program returns 0, which signifies\\n end-of-file. This means to work as expected a sendeof() has to be\\n called at the beginning of a line. This method does not send a newline.\\n It is the responsibility of the caller to ensure the eof is sent at the\\n beginning of a line.\\n '''\\n return self._writeb(_EOF), _EOF\\n\\n def sendintr(self):\\n '''Send an interrupt character (typically Ctrl-C) through the terminal.\\n\\n This will normally trigger the kernel to send SIGINT to the current\\n foreground process group. Processes can turn off this translation, in\\n which case they can read the raw data sent, e.g. ``b'\\\\\\\\x03'`` for Ctrl-C.\\n\\n See also the :meth:`kill` method, which sends a signal directly to the\\n immediate child process in the terminal (which is not necessarily the\\n foreground process).\\n '''\\n return self._writeb(_INTR), _INTR\\n\\n def eof(self):\\n '''This returns True if the EOF exception was ever raised.\\n '''\\n\\n return self.flag_eof\\n\\n def terminate(self, force=False):\\n '''This forces a child process to terminate. It starts nicely with\\n SIGHUP and SIGINT. If \\\"force\\\" is True then moves onto SIGKILL. This\\n returns True if the child was terminated. This returns False if the\\n child could not be terminated. '''\\n\\n if not self.isalive():\\n return True\\n try:\\n self.kill(signal.SIGHUP)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGCONT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n self.kill(signal.SIGINT)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n if force:\\n self.kill(signal.SIGKILL)\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n return False\\n except OSError:\\n # I think there are kernel timing issues that sometimes cause\\n # this to happen. I think isalive() reports True, but the\\n # process is dead to the kernel.\\n # Make one last attempt to see if the kernel is up to date.\\n time.sleep(self.delayafterterminate)\\n if not self.isalive():\\n return True\\n else:\\n return False\\n\\n def wait(self):\\n '''This waits until the child exits. This is a blocking call. This will\\n not read any data from the child, so this will block forever if the\\n child has unread output and has terminated. In other words, the child\\n may have printed output then called exit(), but, the child is\\n technically still alive until its output is read by the parent. '''\\n\\n if self.isalive():\\n pid, status = os.waitpid(self.pid, 0)\\n else:\\n return self.exitstatus\\n self.exitstatus = os.WEXITSTATUS(status)\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status): # pragma: no cover\\n # You can't call wait() on a child process in the stopped state.\\n raise PtyProcessError('Called wait() on a stopped child ' +\\n 'process. This is not supported. Is some other ' +\\n 'process attempting job control with our child pid?')\\n return self.exitstatus\\n\\n def isalive(self):\\n '''This tests if the child process is running or not. This is\\n non-blocking. If the child was terminated then this will read the\\n exitstatus or signalstatus of the child. This returns True if the child\\n process appears to be running or False if not. It can take literally\\n SECONDS for Solaris to return the right status. '''\\n\\n if self.terminated:\\n return False\\n\\n if self.flag_eof:\\n # This is for Linux, which requires the blocking form\\n # of waitpid to get the status of a defunct process.\\n # This is super-lame. The flag_eof would have been set\\n # in read_nonblocking(), so this should be safe.\\n waitpid_options = 0\\n else:\\n waitpid_options = os.WNOHANG\\n\\n try:\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e:\\n # No child processes\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where \\\"terminated\\\" is 0, but there was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # I have to do this twice for Solaris.\\n # I can't even believe that I figured this out...\\n # If waitpid() returns 0 it means that no child process\\n # wishes to report, and the value of status is undefined.\\n if pid == 0:\\n try:\\n ### os.WNOHANG) # Solaris!\\n pid, status = os.waitpid(self.pid, waitpid_options)\\n except OSError as e: # pragma: no cover\\n # This should never happen...\\n if e.errno == errno.ECHILD:\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'that should never happen. There was no child ' +\\n 'process. Did someone else call waitpid() ' +\\n 'on our process?')\\n else:\\n raise\\n\\n # If pid is still 0 after two calls to waitpid() then the process\\n # really is alive. This seems to work on all platforms, except for\\n # Irix which seems to require a blocking call on waitpid or select,\\n # so I let read_nonblocking take care of this situation\\n # (unfortunately, this requires waiting through the timeout).\\n if pid == 0:\\n return True\\n\\n if pid == 0:\\n return True\\n\\n if os.WIFEXITED(status):\\n self.status = status\\n self.exitstatus = os.WEXITSTATUS(status)\\n self.signalstatus = None\\n self.terminated = True\\n elif os.WIFSIGNALED(status):\\n self.status = status\\n self.exitstatus = None\\n self.signalstatus = os.WTERMSIG(status)\\n self.terminated = True\\n elif os.WIFSTOPPED(status):\\n raise PtyProcessError('isalive() encountered condition ' +\\n 'where child process is stopped. This is not ' +\\n 'supported. Is some other process attempting ' +\\n 'job control with our child pid?')\\n return False\\n\\n def kill(self, sig):\\n \\\"\\\"\\\"Send the given signal to the child application.\\n\\n In keeping with UNIX tradition it has a misleading name. It does not\\n necessarily kill the child unless you send the right signal. See the\\n :mod:`signal` module for constants representing signal numbers.\\n \\\"\\\"\\\"\\n\\n # Same as os.kill, but the pid is given for you.\\n if self.isalive():\\n os.kill(self.pid, sig)\\n\\n def getwinsize(self):\\n \\\"\\\"\\\"Return the window size of the pseudoterminal as a tuple (rows, cols).\\n \\\"\\\"\\\"\\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912)\\n s = struct.pack('HHHH', 0, 0, 0, 0)\\n x = fcntl.ioctl(self.fd, TIOCGWINSZ, s)\\n return struct.unpack('HHHH', x)[0:2]\\n\\n def setwinsize(self, rows, cols):\\n \\\"\\\"\\\"Set the terminal window size of the child tty.\\n\\n This will cause a SIGWINCH signal to be sent to the child. This does not\\n change the physical window size. It changes the size reported to\\n TTY-aware applications like vi or curses -- applications that respond to\\n the SIGWINCH signal.\\n \\\"\\\"\\\"\\n return _setwinsize(self.fd, rows, cols)\\n\\n\\nclass PtyProcessUnicode(PtyProcess):\\n \\\"\\\"\\\"Unicode wrapper around a process running in a pseudoterminal.\\n\\n This class exposes a similar interface to :class:`PtyProcess`, but its read\\n methods return unicode, and its :meth:`write` accepts unicode.\\n \\\"\\\"\\\"\\n if PY3:\\n string_type = str\\n else:\\n string_type = unicode # analysis:ignore\\n\\n def __init__(self, pid, fd, encoding='utf-8', codec_errors='strict'):\\n super(PtyProcessUnicode, self).__init__(pid, fd)\\n self.encoding = encoding\\n self.codec_errors = codec_errors\\n self.decoder = codecs.getincrementaldecoder(encoding)(errors=codec_errors)\\n\\n def read(self, size=1024):\\n \\\"\\\"\\\"Read at most ``size`` bytes from the pty, return them as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n\\n The size argument still refers to bytes, not unicode code points.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).read(size)\\n return self.decoder.decode(b, final=False)\\n\\n def readline(self):\\n \\\"\\\"\\\"Read one line from the pseudoterminal, and return it as unicode.\\n\\n Can block if there is nothing to read. Raises :exc:`EOFError` if the\\n terminal was closed.\\n \\\"\\\"\\\"\\n b = super(PtyProcessUnicode, self).readline()\\n return self.decoder.decode(b, final=False)\\n\\n def write(self, s):\\n \\\"\\\"\\\"Write the unicode string ``s`` to the pseudoterminal.\\n\\n Returns the number of bytes written.\\n \\\"\\\"\\\"\\n b = s.encode(self.encoding)\\n return super(PtyProcessUnicode, self).write(b)\\n\\n[end of ptyprocess/ptyprocess.py]\",\n \"filename\": \"ptyprocess/ptyprocess.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"\\\"\\\"\\\"Run a subprocess in a pseudo terminal\\\"\\\"\\\"\\nfrom .ptyprocess import PtyProcess, PtyProcessUnicode, PtyProcessError\\n\\n__version__ = '0.7.0'\\n\\n[end of ptyprocess/__init__.py]\",\n \"filename\": \"ptyprocess/__init__.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"no\\\"?>\\n<!-- Created with Inkscape (http://www.inkscape.org/) -->\\n\\n<svg\\n xmlns:dc=\\\"http://purl.org/dc/elements/1.1/\\\"\\n xmlns:cc=\\\"http://creativecommons.org/ns#\\\"\\n xmlns:rdf=\\\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\\\"\\n xmlns:svg=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns=\\\"http://www.w3.org/2000/svg\\\"\\n xmlns:sodipodi=\\\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\\\"\\n xmlns:inkscape=\\\"http://www.inkscape.org/namespaces/inkscape\\\"\\n width=\\\"554.44196\\\"\\n height=\\\"327.38452\\\"\\n id=\\\"svg2\\\"\\n version=\\\"1.1\\\"\\n inkscape:version=\\\"0.48.4 r9939\\\"\\n sodipodi:docname=\\\"pty_vs_popen.svg\\\">\\n <defs\\n id=\\\"defs4\\\">\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3838\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3783\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(1.1,0,0,1.1,1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Tail\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Tail\\\"\\n style=\\\"overflow:visible\\\">\\n <g\\n id=\\\"g3801\\\"\\n transform=\\\"scale(-1.2,-1.2)\\\">\\n <path\\n id=\\\"path3803\\\"\\n d=\\\"M -3.8048674,-3.9585227 0.54352094,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3805\\\"\\n d=\\\"M -1.2866832,-3.9585227 3.0617053,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3807\\\"\\n d=\\\"M 1.3053582,-3.9585227 5.6537466,0\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3809\\\"\\n d=\\\"M -3.8048674,4.1775838 0.54352094,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3811\\\"\\n d=\\\"M -1.2866832,4.1775838 3.0617053,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n <path\\n id=\\\"path3813\\\"\\n d=\\\"M 1.3053582,4.1775838 5.6537466,0.21974226\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </g>\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lstart\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lstart\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3765\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(0.8,0,0,0.8,10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3786\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow1Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow1Lend\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n id=\\\"path3768\\\"\\n d=\\\"M 0,0 5,-5 -12.5,0 5,5 0,0 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"matrix(-0.8,0,0,-0.8,-10,0)\\\"\\n inkscape:connector-curvature=\\\"0\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-9\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-2\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"Arrow2Lend\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"Arrow2Lend-6\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3786-27\\\"\\n style=\\\"fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round\\\"\\n d=\\\"M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z\\\"\\n transform=\\\"matrix(-1.1,0,0,-1.1,-1.1,0)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"SquareM-5\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path3838-7\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10742\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10744\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10746\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10748\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10750\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10752\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10754\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10756\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n <marker\\n inkscape:stockid=\\\"SquareM\\\"\\n orient=\\\"auto\\\"\\n refY=\\\"0\\\"\\n refX=\\\"0\\\"\\n id=\\\"marker10758\\\"\\n style=\\\"overflow:visible\\\">\\n <path\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path10760\\\"\\n d=\\\"M -5,-5 -5,5 5,5 5,-5 -5,-5 z\\\"\\n style=\\\"fill-rule:evenodd;stroke:#000000;stroke-width:1pt\\\"\\n transform=\\\"scale(0.4,0.4)\\\" />\\n </marker>\\n </defs>\\n <sodipodi:namedview\\n id=\\\"base\\\"\\n pagecolor=\\\"#ffffff\\\"\\n bordercolor=\\\"#666666\\\"\\n borderopacity=\\\"1.0\\\"\\n inkscape:pageopacity=\\\"0.0\\\"\\n inkscape:pageshadow=\\\"2\\\"\\n inkscape:zoom=\\\"0.98994949\\\"\\n inkscape:cx=\\\"77.797977\\\"\\n inkscape:cy=\\\"137.24456\\\"\\n inkscape:document-units=\\\"px\\\"\\n inkscape:current-layer=\\\"layer1\\\"\\n showgrid=\\\"false\\\"\\n inkscape:window-width=\\\"1301\\\"\\n inkscape:window-height=\\\"744\\\"\\n inkscape:window-x=\\\"65\\\"\\n inkscape:window-y=\\\"24\\\"\\n inkscape:window-maximized=\\\"1\\\"\\n fit-margin-top=\\\"1\\\"\\n fit-margin-left=\\\"1\\\"\\n fit-margin-right=\\\"1\\\"\\n fit-margin-bottom=\\\"1\\\"\\n units=\\\"cm\\\" />\\n <metadata\\n id=\\\"metadata7\\\">\\n <rdf:RDF>\\n <cc:Work\\n rdf:about=\\\"\\\">\\n <dc:format>image/svg+xml</dc:format>\\n <dc:type\\n rdf:resource=\\\"http://purl.org/dc/dcmitype/StillImage\\\" />\\n <dc:title></dc:title>\\n </cc:Work>\\n </rdf:RDF>\\n </metadata>\\n <g\\n inkscape:label=\\\"Layer 1\\\"\\n inkscape:groupmode=\\\"layer\\\"\\n id=\\\"layer1\\\"\\n transform=\\\"translate(-40.758533,29.820888)\\\">\\n <g\\n id=\\\"g11880\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591\\\"\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.97427\\\"\\n x=\\\"138.65004\\\"\\n id=\\\"tspan10593\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <g\\n id=\\\"g10626\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991\\\"\\n d=\\\"m 196.72731,244.88337 c 67.0421,-0.73967 67.7774,-97.99531 67.7774,-97.99531\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7\\\"\\n d=\\\"m 196.14285,226.15435 c 43.35572,-25.82886 35.12946,-81.02577 35.12946,-81.02577\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"M 115.87982,226.83468 C 83.964646,190.58994 84.459212,146.54858 84.459212,146.54858\\\"\\n id=\\\"path2991-7-8\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5637\\\"\\n d=\\\"M 138.92857,54.147895 C 93.997282,79.826286 84.654646,124.86218 84.654646,124.86218\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5641\\\"\\n d=\\\"M 263.9496,124.76501 C 252.52103,80.836439 194.64286,49.147895 194.64286,49.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#SquareM)\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path5643\\\"\\n d=\\\"M 232.25054,123.75485 C 221.88288,81.1682 185.35714,54.147895 185.35714,54.147895\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#SquareM)\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.57648\\\"\\n x=\\\"90\\\"\\n id=\\\"tspan6247\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"213.07455\\\"\\n x=\\\"184.47076\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"262.00311\\\"\\n x=\\\"192.32663\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(18,0)\\\"\\n id=\\\"g11773\\\">\\n <g\\n id=\\\"g11763\\\">\\n <rect\\n y=\\\"120.8597\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308\\\"\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"129.96561\\\"\\n x=\\\"63.277264\\\"\\n id=\\\"tspan6310\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g11768\\\">\\n <rect\\n y=\\\"135.43114\\\"\\n x=\\\"58.558922\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304\\\"\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"144.58977\\\"\\n x=\\\"64.540932\\\"\\n id=\\\"tspan6306\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(54,-16)\\\"\\n id=\\\"g10674\\\">\\n <g\\n id=\\\"g10664\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <g\\n transform=\\\"translate(86.857134,-15.571435)\\\"\\n id=\\\"g10674-6\\\">\\n <g\\n id=\\\"g10664-6\\\"\\n transform=\\\"translate(0,29.14287)\\\">\\n <rect\\n y=\\\"121.72949\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-0-5\\\"\\n style=\\\"fill:#ff8080;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-9\\\"\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"130.8354\\\"\\n x=\\\"173.51424\\\"\\n id=\\\"tspan6310-7-6\\\"\\n sodipodi:role=\\\"line\\\">w</tspan></text>\\n </g>\\n <g\\n id=\\\"g10669-5\\\">\\n <rect\\n y=\\\"136.30093\\\"\\n x=\\\"168.7959\\\"\\n height=\\\"13.836793\\\"\\n width=\\\"15.97965\\\"\\n id=\\\"rect4573-0-7-4-7-4\\\"\\n style=\\\"fill:#b3b3b3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73463506px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6304-5-3\\\"\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"145.45956\\\"\\n x=\\\"174.77791\\\"\\n id=\\\"tspan6306-6-1\\\"\\n sodipodi:role=\\\"line\\\">r</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"139.6479\\\"\\n x=\\\"135.03683\\\"\\n id=\\\"tspan10728\\\"\\n sodipodi:role=\\\"line\\\">Popen</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-89\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-24\\\"\\n style=\\\"font-size:9px;font-style:normal;-inkscape-font-specification:Sans\\\"\\n y=\\\"158.43169\\\"\\n x=\\\"234.46947\\\"\\n sodipodi:role=\\\"line\\\">pipes</tspan></text>\\n </g>\\n <g\\n id=\\\"g11847\\\"\\n transform=\\\"translate(-10,0.39179)\\\">\\n <a\\n style=\\\"fill:#b380ff\\\"\\n id=\\\"a6328-0\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-8\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(-4.6428572,12.857143)\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10591-3\\\"\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"240.5825\\\"\\n x=\\\"372.50137\\\"\\n id=\\\"tspan10593-2\\\"\\n sodipodi:role=\\\"line\\\">Child</tspan></text>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path11075\\\"\\n d=\\\"m 397.80427,110.64896 0,-52.85714\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:none;marker-end:url(#marker10758)\\\" />\\n <g\\n id=\\\"g10626-5\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n sodipodi:type=\\\"arc\\\"\\n style=\\\"fill:#b380ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\\\"\\n id=\\\"path4575-2-4\\\"\\n sodipodi:cx=\\\"160.71428\\\"\\n sodipodi:cy=\\\"222.89789\\\"\\n sodipodi:rx=\\\"41.07143\\\"\\n sodipodi:ry=\\\"25.535715\\\"\\n d=\\\"m 201.78571,222.89789 c 0,14.10298 -18.38831,25.53571 -41.07143,25.53571 -22.68313,0 -41.07143,-11.43273 -41.07143,-25.53571 0,-14.10299 18.3883,-25.53572 41.07143,-25.53572 22.68312,0 41.07143,11.43273 41.07143,25.53572 z\\\"\\n transform=\\\"translate(2.6428639,-191.24999)\\\" />\\n <text\\n xml:space=\\\"preserve\\\"\\n style=\\\"font-size:14px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\"\\n id=\\\"text6334-0\\\"\\n sodipodi:linespacing=\\\"125%\\\"><tspan\\n sodipodi:role=\\\"line\\\"\\n id=\\\"tspan6336-9\\\"\\n x=\\\"140.40549\\\"\\n y=\\\"36.651806\\\">Parent</tspan></text>\\n </g>\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-4\\\"\\n d=\\\"m 430.57864,244.49159 c 72.59794,2.79586 4.037,-103.77087 -17.74871,-113.05659\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <path\\n sodipodi:nodetypes=\\\"cc\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n id=\\\"path2991-7-87\\\"\\n d=\\\"m 429.99418,225.76257 c 42.23788,-26.36983 -30.60585,-91.62802 -30.60585,-91.62802\\\"\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-mid:none;marker-end:none\\\" />\\n <a\\n id=\\\"a6331-7\\\"\\n transform=\\\"translate(233.85132,-0.39179)\\\">\\n <path\\n style=\\\"fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#SquareM);marker-end:none\\\"\\n d=\\\"m 115.87982,226.83468 c -50.09792,-32.20413 30.963,-94.8423 30.963,-94.8423\\\"\\n id=\\\"path2991-7-8-4\\\"\\n inkscape:connector-curvature=\\\"0\\\"\\n sodipodi:nodetypes=\\\"cc\\\" />\\n </a>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-6\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"240.18468\\\"\\n x=\\\"323.85132\\\"\\n id=\\\"tspan6247-3\\\"\\n sodipodi:role=\\\"line\\\">stdin</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-6\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6270-2\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"207.68279\\\"\\n x=\\\"410.10779\\\"\\n sodipodi:role=\\\"line\\\">stdout</tspan></text>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6245-8-8-1\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n style=\\\"font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n id=\\\"tspan6298-3\\\"\\n style=\\\"font-size:9px;font-style:italic;-inkscape-font-specification:Sans Italic\\\"\\n y=\\\"261.61133\\\"\\n x=\\\"426.17795\\\"\\n sodipodi:role=\\\"line\\\">stderr</tspan></text>\\n <g\\n transform=\\\"translate(227.5656,-301.02546)\\\"\\n id=\\\"g11065\\\">\\n <g\\n id=\\\"g11055\\\">\\n <rect\\n y=\\\"421.34998\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55\\\"\\n style=\\\"fill:#5599ff;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6\\\"\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"431.01376\\\"\\n x=\\\"159.1624\\\"\\n id=\\\"tspan6310-7-9\\\"\\n sodipodi:role=\\\"line\\\">slave</tspan></text>\\n </g>\\n <g\\n id=\\\"g11060\\\">\\n <rect\\n y=\\\"407.25223\\\"\\n x=\\\"147.24721\\\"\\n height=\\\"13.362738\\\"\\n width=\\\"44.791309\\\"\\n id=\\\"rect4573-0-7-0-55-9\\\"\\n style=\\\"fill:#80ffb3;fill-rule:evenodd;stroke:#000000;stroke-width:0.73500001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none\\\" />\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text6308-1-6-7\\\"\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n y=\\\"416.68555\\\"\\n x=\\\"155.16631\\\"\\n id=\\\"tspan6310-7-9-7\\\"\\n sodipodi:role=\\\"line\\\">master</tspan></text>\\n </g>\\n </g>\\n <text\\n sodipodi:linespacing=\\\"125%\\\"\\n id=\\\"text10726-9\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n style=\\\"font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans\\\"\\n xml:space=\\\"preserve\\\"><tspan\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"116.71899\\\"\\n x=\\\"429.1268\\\"\\n id=\\\"tspan10728-7\\\"\\n sodipodi:role=\\\"line\\\">Pseudoterminal</tspan><tspan\\n id=\\\"tspan11761\\\"\\n style=\\\"font-size:16px;font-weight:bold;-inkscape-font-specification:Sans Bold\\\"\\n y=\\\"136.71899\\\"\\n x=\\\"429.1268\\\"\\n sodipodi:role=\\\"line\\\">(pty)</tspan></text>\\n </g>\\n </g>\\n</svg>\\n\\n[end of docs/images/pty_vs_popen.svg]\",\n \"filename\": \"docs/images/pty_vs_popen.svg\",\n \"id\": \"12\"\n },\n {\n \"content\": \"None\\n[end of docs/images/pty_vs_popen.png]\",\n \"filename\": \"docs/images/pty_vs_popen.png\",\n \"id\": \"13\"\n }\n]","isConversational":false}}},{"rowIdx":85,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 85,\n \"num_files\": 17,\n \"repo_id\": \"repo_0085\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":86,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 86,\n \"num_files\": 17,\n \"repo_id\": \"repo_0086\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":87,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 87,\n \"num_files\": 17,\n \"repo_id\": \"repo_0087\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":88,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 88,\n \"num_files\": 17,\n \"repo_id\": \"repo_0088\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":89,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 89,\n \"num_files\": 17,\n \"repo_id\": \"repo_0089\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":90,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 90,\n \"num_files\": 17,\n \"repo_id\": \"repo_0090\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":91,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 91,\n \"num_files\": 17,\n \"repo_id\": \"repo_0091\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":92,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 92,\n \"num_files\": 17,\n \"repo_id\": \"repo_0092\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":93,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 93,\n \"num_files\": 17,\n \"repo_id\": \"repo_0093\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":94,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 94,\n \"num_files\": 17,\n \"repo_id\": \"repo_0094\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":95,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 95,\n \"num_files\": 17,\n \"repo_id\": \"repo_0095\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":96,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 96,\n \"num_files\": 17,\n \"repo_id\": \"repo_0096\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":97,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 97,\n \"num_files\": 17,\n \"repo_id\": \"repo_0097\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":98,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 98,\n \"num_files\": 17,\n \"repo_id\": \"repo_0098\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}},{"rowIdx":99,"cells":{"metadata":{"kind":"string","value":"{\n \"id\": 99,\n \"num_files\": 17,\n \"repo_id\": \"repo_0099\",\n \"subset\": \"32K\"\n}"},"texts":{"kind":"list like","value":[{"content":"The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n[end of LICENSE]","filename":"LICENSE","id":"0"},{"content":"# Changelog\n\n## [v2.2.1] - 2022-10-05\n\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\n\n## [v2.2.0] - 2022-10-05\n\n- Improve type annotation for wait generators from @hauntsaninja\n- Include exception in details dict of call handlers from @petamas\n- Improve type hints for call handlers from @cdce8p\n\n## [v2.1.2] - 2022-06-08\n### Fixed\n\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\n\n## [v2.1.1] - 2022-06-08\n### Fixed\n\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\n\n## [v2.1.0] - 2022-06-07\n### Changed\n\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\n\n## [v2.0.1] - 2022-04-27\n### Changed\n- Allow None for jitter keyword arg (typing)\n\n\n## [v2.0.0] - 2022-04-26\n### Added\n- Add raise_on_giveup keyword arg for decorators\n- Add backoff.runtime wait generator for dynamically setting wait times based\n on target function return value or exception details\n### Changed\n- Improve type hints for on_success, on_backoff, on_giveup handlers\n- Use decorator-specific detail and handler type hints\n- Optionally use typing_extensions for python 3.7 type hinting\n- Drop python 3.6 support\n- Add python 3.10 support\n\n## [v1.11.1] - 2021-07-14\n### Fixed\n- Update __version__ in backoff module\n\n## [v1.11.0] - 2021-07-12\n### Added\n- Configurable logging levels for backoff and giveup events\n### Changed\n- Minor documentation fixes\n\n## [v1.10.0] - 2019-12-07\n### Changed\n- Allow sync decorator call from async function\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\n\n## [v1.9.2] - 2019-11-19\n### Changed\n- Don't include tests and changelog in distribution\n\n## [v1.9.1] - 2019-11-18\n### Changed\n- Include tests and changelog in distribution\n\n## [v1.9.0] - 2019-11-16\n### Changed\n- Support python 3.8\n\n## [v1.8.1] - 2019-10-11\n### Changed\n- Use arguments in log messages rather than fully formatting log\n https://github.com/litl/backoff/pull/82 from @lbernick\n\n## [v1.8.0] - 2018-12-20\n### Added\n- Custom loggers\n- Iterable intervals for constant wait_gen for predefined wait sequences\n### Changed\n- Give up on StopIteration raised in wait generators\n- Nullary jitter signature deprecation warning\n\n## [v1.7.0] - 2018-11-23\n### Changed\n- Support Python 3.7\n- Drop support for async in Python 3.4\n- Drop support for Python 2.6\n- Update development dependencies\n- Use poetry for dependencies and packaging\n\n## [v1.6.0] - 2018-07-14\n### Changed\n- Change default log level from ERROR to INFO\n- Log retries on exception as INFO\n\n## [v1.5.0] - 2018-04-11\n### Added\n- Add max_time keyword argument\n\n## [v1.4.3] - 2017-05-22\n### Changed\n- Add license to source distribution\n\n## [v1.4.2] - 2017-04-25\n### Changed\n- Use documented logger name https://github.com/litl/backoff/pull/32\n from @pquentin\n\n## [v1.4.1] - 2017-04-21\n### Added\n- Expose __version__ at package root\n### Changed\n- Fix checking for running sync version in coroutine in case when event\n loop is not set from @rutsky\n\n## [v1.4.0] - 2017-02-05\n### Added\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\n### Changed\n- Refactor `backoff` module into package with identical API\n\n## [v1.3.2] - 2016-11-18\n### Changed\n- Don't log retried args and kwargs by default\n- README.rst syntax highlighting from @dethi\n\n## [v1.3.1] - 2016-08-08\n### Changed\n- Include README.rst in source distribution (fixes package)\n\n## [v1.3.0] - 2016-08-08\n### Added\n- Support runtime configuration with optional callable kwargs\n- Add giveup kwarg for exception inspection\n### Changed\n- Documentation fixes\n\n## [v1.2.1] - 2016-05-27\n### Changed\n- Documentation fixes\n\n\n## [v1.2.0] - 2016-05-26\n### Added\n- 'Full jitter' algorithm from @jonascheng\n\n### Changed\n- Jitter function now accepts raw value and returns jittered value\n- Change README to reST for the benefit of pypi :(\n- Remove docstring doc generation and make README canonical\n\n## [v1.1.0] - 2015-12-08\n### Added\n- Event handling for success, backoff, and giveup\n- Change log\n### Changed\n- Docs and test for multi exception invocations\n- Update dev environment test dependencies\n\n## [v1.0.7] - 2015-02-10\n### Changed\n- Fix string formatting for python 2.6\n\n## [v1.0.6] - 2015-02-10\n### Added\n- Coveralls.io integration from @singingwolfboy\n### Changed\n- Fix logging bug for function calls with tuple params\n\n## [v1.0.5] - 2015-02-03\n### Changed\n- Add a default interval of 1 second for the constant generator\n- Improve on_predicate stop condition avoiding extra sleep\n\n## [v1.0.4] - 2014-08-12\n### Added\n- Python 2.6 support from @Bonko\n- Python 3.0 support from @robyoung\n- Run tests in Travis from @robyoung\n\n## [v1.0.3] - 2014-06-05\n### Changed\n- Make logging unicode safe\n- Log on_predicate backoff as INFO rather than ERROR\n\n[end of CHANGELOG.md]","filename":"CHANGELOG.md","id":"1"},{"content":"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\nPY_MAJOR := $(word 1,${PY_VERSION})\nPY_MINOR := $(word 2,${PY_VERSION})\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\>=3.5 | bc)\n\n\n.PHONY: all flake8 clean test check\n\nall:\n\t@echo 'flake8 check flake8 compliance'\n\t@echo 'clean cleanup the source tree'\n\t@echo 'test run the unit tests'\n\t@echo 'check make sure you are ready to commit'\n\nflake8:\n\t@flake8 --ignore=E741,W503,W504 backoff tests\n\nmypy:\t\n\t@mypy --show-error-codes backoff tests\n\nclean:\n\t@find . -name \"*.pyc\" -delete\n\t@find . -name \"__pycache__\" -delete\n\t@rm -rf build dist .coverage MANIFEST\n\ntest: clean\n\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\n\ncheck: flake8 mypy test\n\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\n\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\n\n[end of Makefile]","filename":"Makefile","id":"2"},{"content":"[tool.poetry]\nname = \"backoff\"\nversion = \"2.2.1\"\ndescription = \"Function decoration for backoff and retry\"\nauthors = [\"Bob Green <rgreen@aquent.com>\"]\nreadme = \"README.rst\"\nrepository = \"https://github.com/litl/backoff\"\nlicense = \"MIT\"\nkeywords = [\"retry\", \"backoff\", \"decorators\"]\nclassifiers = ['Development Status :: 5 - Production/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Software Development :: Libraries :: Python Modules',\n 'Topic :: Utilities']\npackages = [\n { include = \"backoff\" },\n]\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n[tool.poetry.dev-dependencies]\nflake8 = \"^4.0.1\"\nmypy = \"^0.942\"\npytest = \"^7.1.2\"\npytest-asyncio = \"^0.18.3\"\npytest-cov = \"^3.0.0\"\nrequests = \"^2.26.0\"\nresponses = \"^0.20.0\"\ntypes-requests = \"^2.27.20\"\n\n[build-system]\nrequires = [\"poetry-core>=1.0.0\"]\nbuild-backend = \"poetry.core.masonry.api\"\n\n[end of pyproject.toml]","filename":"pyproject.toml","id":"3"},{"content":"include LICENSE\ninclude README.rst\n\n[end of MANIFEST.in]","filename":"MANIFEST.in","id":"4"},{"content":"backoff\n=======\n\n.. image:: https://travis-ci.org/litl/backoff.svg\n :target: https://travis-ci.org/litl/backoff\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\n.. image:: https://img.shields.io/pypi/v/backoff.svg\n :target: https://pypi.python.org/pypi/backoff\n.. image:: https://img.shields.io/github/license/litl/backoff\n :target: https://github.com/litl/backoff/blob/master/LICENSE\n\n**Function decoration for backoff and retry**\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nDecorators support both regular functions for synchronous code and\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\nfor asynchronous code.\n\nExamples\n========\n\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\nhas become a defacto standard for synchronous HTTP clients in Python,\nnetworking examples below are written using it, but it is in no way required\nby the backoff module.\n\n@backoff.on_exception\n---------------------\n\nThe ``on_exception`` decorator is used to retry when a specified exception\nis raised. Here's an example using exponential backoff when any\n``requests`` exception is raised:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException)\n def get_url(url):\n return requests.get(url)\n\nThe decorator will also accept a tuple of exceptions for cases where\nthe same backoff behavior is desired for more than one exception type:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n (requests.exceptions.Timeout,\n requests.exceptions.ConnectionError))\n def get_url(url):\n return requests.get(url)\n\n**Give Up Conditions**\n\nOptional keyword arguments can specify conditions under which to give\nup.\n\nThe keyword argument ``max_time`` specifies the maximum amount\nof total time in seconds that can elapse before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=60)\n def get_url(url):\n return requests.get(url)\n\n\nKeyword argument ``max_tries`` specifies the maximum number of calls\nto make to the target function before giving up.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_tries=8,\n jitter=None)\n def get_url(url):\n return requests.get(url)\n\n\nIn some cases the raised exception instance itself may need to be\ninspected in order to determine if it is a retryable condition. The\n``giveup`` keyword arg can be used to specify a function which accepts\nthe exception and returns a truthy value if the exception should not\nbe retried:\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nBy default, when a give up event occurs, the exception in question is reraised\nand so code calling an `on_exception`-decorated function may still\nneed to do exception handling. This behavior can optionally be disabled\nusing the `raise_on_giveup` keyword argument.\n\nIn the code below, `requests.exceptions.RequestException` will not be raised\nwhen giveup occurs. Note that the decorated function will return `None` in this\ncase, regardless of the logic in the `on_exception` handler.\n\n.. code-block:: python\n\n def fatal_code(e):\n return 400 <= e.response.status_code < 500\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n max_time=300,\n raise_on_giveup=False,\n giveup=fatal_code)\n def get_url(url):\n return requests.get(url)\n\nThis is useful for non-mission critical code where you still wish to retry\nthe code inside of `backoff.on_exception` but wish to proceed with execution\neven if all retries fail.\n\n@backoff.on_predicate\n---------------------\n\nThe ``on_predicate`` decorator is used to retry when a particular\ncondition is true of the return value of the target function. This may\nbe useful when polling a resource for externally generated content.\n\nHere's an example which uses a fibonacci sequence backoff when the\nreturn value of the target function is the empty list:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\n def poll_for_messages(queue):\n return queue.get()\n\nExtra keyword arguments are passed when initializing the\nwait generator, so the ``max_value`` param above is passed as a keyword\narg when initializing the fibo generator.\n\nWhen not specified, the predicate param defaults to the falsey test,\nso the above can more concisely be written:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n def poll_for_message(queue):\n return queue.get()\n\nMore simply, a function which continues polling every second until it\ngets a non-falsey result could be defined like like this:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\n def poll_for_message(queue):\n return queue.get()\n\nThe jitter is disabled in order to keep the polling frequency fixed. \n\n@backoff.runtime\n----------------\n\nYou can also use the ``backoff.runtime`` generator to make use of the\nreturn value or thrown exception of the decorated method.\n\nFor example, to use the value in the ``Retry-After`` header of the response:\n\n.. code-block:: python\n\n @backoff.on_predicate(\n backoff.runtime,\n predicate=lambda r: r.status_code == 429,\n value=lambda r: int(r.headers.get(\"Retry-After\")),\n jitter=None,\n )\n def get_url():\n return requests.get(url)\n\nJitter\n------\n\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\neither of the backoff decorators. This argument should be a function\naccepting the original unadulterated backoff value and returning it's\njittered counterpart.\n\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\nimplements the 'Full Jitter' algorithm as defined in the AWS\nArchitecture Blog's `Exponential Backoff And Jitter\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\nNote that with this algorithm, the time yielded by the wait generator\nis actually the *maximum* amount of time to wait.\n\nPrevious versions of backoff defaulted to adding some random number of\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\nbehavior is now available as ``backoff.random_jitter``.\n\nUsing multiple decorators\n-------------------------\n\nThe backoff decorators may also be combined to specify different\nbackoff behavior for different cases:\n\n.. code-block:: python\n\n @backoff.on_predicate(backoff.fibo, max_value=13)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.HTTPError,\n max_time=60)\n @backoff.on_exception(backoff.expo,\n requests.exceptions.Timeout,\n max_time=300)\n def poll_for_message(queue):\n return queue.get()\n\n\nRuntime Configuration\n---------------------\n\nThe decorator functions ``on_exception`` and ``on_predicate`` are\ngenerally evaluated at import time. This is fine when the keyword args\nare passed as constant values, but suppose we want to consult a\ndictionary with configuration options that only become available at\nruntime. The relevant values are not available at import time. Instead,\ndecorator functions can be passed callables which are evaluated at\nruntime to obtain the value:\n\n.. code-block:: python\n\n def lookup_max_time():\n # pretend we have a global reference to 'app' here\n # and that it has a dictionary-like 'config' property\n return app.config[\"BACKOFF_MAX_TIME\"]\n\n @backoff.on_exception(backoff.expo,\n ValueError,\n max_time=lookup_max_time)\n\nEvent handlers\n--------------\n\nBoth backoff decorators optionally accept event handler functions\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\nThis may be useful in reporting statistics or performing other custom\nlogging.\n\nHandlers must be callables with a unary signature accepting a dict\nargument. This dict contains the details of the invocation. Valid keys\ninclude:\n\n* *target*: reference to the function or method being invoked\n* *args*: positional arguments to func\n* *kwargs*: keyword arguments to func\n* *tries*: number of invocation tries so far\n* *elapsed*: elapsed time in seconds so far\n* *wait*: seconds to wait (``on_backoff`` handler only)\n* *value*: value triggering backoff (``on_predicate`` decorator only)\n\nA handler which prints the details of the backoff event could be\nimplemented like so:\n\n.. code-block:: python\n\n def backoff_hdlr(details):\n print (\"Backing off {wait:0.1f} seconds after {tries} tries \"\n \"calling function {target} with args {args} and kwargs \"\n \"{kwargs}\".format(**details))\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=backoff_hdlr)\n def get_url(url):\n return requests.get(url)\n\n**Multiple handlers per event type**\n\nIn all cases, iterables of handler functions are also accepted, which\nare called in turn. For example, you might provide a simple list of\nhandler functions as the value of the ``on_backoff`` keyword arg:\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\n def get_url(url):\n return requests.get(url)\n\n**Getting exception info**\n\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\n``on_giveup`` handlers are called from within the except block for the\nexception being handled. Therefore exception info is available to the\nhandler functions via the python standard library, specifically\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\navailable at the *exception* key in the `details` dict passed to the\nhandlers.\n\nAsynchronous code\n-----------------\n\nBackoff supports asynchronous execution in Python 3.5 and above.\n\nTo use backoff in asynchronous code based on\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\nto coroutines.\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\n``on_giveup`` event handlers, with the interface otherwise being identical.\n\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\nasynchronous HTTP client/server library.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\n async def get_url(url):\n async with aiohttp.ClientSession(raise_for_status=True) as session:\n async with session.get(url) as response:\n return await response.text()\n\nLogging configuration\n---------------------\n\nBy default, backoff and retry attempts are logged to the 'backoff'\nlogger. By default, this logger is configured with a NullHandler, so\nthere will be nothing output unless you configure a handler.\nProgrammatically, this might be accomplished with something as simple\nas:\n\n.. code-block:: python\n\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\n\nThe default logging level is INFO, which corresponds to logging\nanytime a retry event occurs. If you would instead like to log\nonly when a giveup event occurs, set the logger level to ERROR.\n\n.. code-block:: python\n\n logging.getLogger('backoff').setLevel(logging.ERROR)\n\nIt is also possible to specify an alternate logger with the ``logger``\nkeyword argument. If a string value is specified the logger will be\nlooked up by name.\n\n.. code-block:: python\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger='my_logger')\n # ...\n\nIt is also supported to specify a Logger (or LoggerAdapter) object\ndirectly.\n\n.. code-block:: python\n\n my_logger = logging.getLogger('my_logger')\n my_handler = logging.StreamHandler()\n my_logger.addHandler(my_handler)\n my_logger.setLevel(logging.ERROR)\n\n @backoff.on_exception(backoff.expo,\n requests.exceptions.RequestException,\n\t\t\t logger=my_logger)\n # ...\n\nDefault logging can be disabled all together by specifying\n``logger=None``. In this case, if desired alternative logging behavior\ncould be defined by using custom event handlers.\n\n[end of README.rst]","filename":"README.rst","id":"5"},{"content":"language: python\npython:\n - \"3.7\"\n - \"3.8\"\n - \"3.9\"\n - \"3.10\"\nbefore_install:\n - pip install poetry more-itertools\ninstall:\n - poetry install\nscript: poetry run make check\nafter_success: coveralls\nnotifications:\n email: false\n\n[end of .travis.yml]","filename":".travis.yml","id":"6"},{"content":"# coding:utf-8\nimport asyncio\nimport logging\nimport operator\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\n\nfrom backoff._common import (\n _prepare_logger,\n _config_handlers,\n _log_backoff,\n _log_giveup\n)\nfrom backoff._jitter import full_jitter\nfrom backoff import _async, _sync\nfrom backoff._typing import (\n _CallableT,\n _Handler,\n _Jitterer,\n _MaybeCallable,\n _MaybeLogger,\n _MaybeSequence,\n _Predicate,\n _WaitGenerator,\n)\n\n\ndef on_predicate(wait_gen: _WaitGenerator,\n predicate: _Predicate[Any] = operator.not_,\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by predicate.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n predicate: A function which when called on the return value of\n the target function will trigger backoff when considered\n truthily. If not specified, the default behavior is to\n backoff on falsey return values.\n max_tries: The maximum number of attempts to make before giving\n up. In the case of failure, the result of the last attempt\n will be returned. The default value of None means there\n is no limit to the number of tries. If a callable is passed,\n it will be evaluated at runtime and its return value used.\n max_time: The maximum total amount of time in seconds to try for before\n giving up. If this time expires, the result of the last\n attempt will be returned. If a callable is passed, it will\n be evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n logger: Name of logger or Logger object to log to. Defaults to\n 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_predicate\n else:\n retry = _sync.retry_predicate\n\n return retry(\n target,\n wait_gen,\n predicate,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n\ndef on_exception(wait_gen: _WaitGenerator,\n exception: _MaybeSequence[Type[Exception]],\n *,\n max_tries: Optional[_MaybeCallable[int]] = None,\n max_time: Optional[_MaybeCallable[float]] = None,\n jitter: Union[_Jitterer, None] = full_jitter,\n giveup: _Predicate[Exception] = lambda e: False,\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\n raise_on_giveup: bool = True,\n logger: _MaybeLogger = 'backoff',\n backoff_log_level: int = logging.INFO,\n giveup_log_level: int = logging.ERROR,\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\n \"\"\"Returns decorator for backoff and retry triggered by exception.\n\n Args:\n wait_gen: A generator yielding successive wait times in\n seconds.\n exception: An exception type (or tuple of types) which triggers\n backoff.\n max_tries: The maximum number of attempts to make before giving\n up. Once exhausted, the exception will be allowed to escape.\n The default value of None means there is no limit to the\n number of tries. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n max_time: The maximum total amount of time to try for before\n giving up. Once expired, the exception will be allowed to\n escape. If a callable is passed, it will be\n evaluated at runtime and its return value used.\n jitter: A function of the value yielded by wait_gen returning\n the actual time to wait. This distributes wait times\n stochastically in order to avoid timing collisions across\n concurrent clients. Wait times are jittered by default\n using the full_jitter function. Jittering may be disabled\n altogether by passing jitter=None.\n giveup: Function accepting an exception instance and\n returning whether or not to give up. Optional. The default\n is to always continue.\n on_success: Callable (or iterable of callables) with a unary\n signature to be called in the event of success. The\n parameter is a dict containing details about the invocation.\n on_backoff: Callable (or iterable of callables) with a unary\n signature to be called in the event of a backoff. The\n parameter is a dict containing details about the invocation.\n on_giveup: Callable (or iterable of callables) with a unary\n signature to be called in the event that max_tries\n is exceeded. The parameter is a dict containing details\n about the invocation.\n raise_on_giveup: Boolean indicating whether the registered exceptions\n should be raised on giveup. Defaults to `True`\n logger: Name or Logger object to log to. Defaults to 'backoff'.\n backoff_log_level: log level for the backoff event. Defaults to \"INFO\"\n giveup_log_level: log level for the give up event. Defaults to \"ERROR\"\n **wait_gen_kwargs: Any additional keyword args specified will be\n passed to wait_gen when it is initialized. Any callable\n args will first be evaluated and their return values passed.\n This is useful for runtime configuration.\n \"\"\"\n def decorate(target):\n nonlocal logger, on_success, on_backoff, on_giveup\n\n logger = _prepare_logger(logger)\n on_success = _config_handlers(on_success)\n on_backoff = _config_handlers(\n on_backoff,\n default_handler=_log_backoff,\n logger=logger,\n log_level=backoff_log_level,\n )\n on_giveup = _config_handlers(\n on_giveup,\n default_handler=_log_giveup,\n logger=logger,\n log_level=giveup_log_level,\n )\n\n if asyncio.iscoroutinefunction(target):\n retry = _async.retry_exception\n else:\n retry = _sync.retry_exception\n\n return retry(\n target,\n wait_gen,\n exception,\n max_tries=max_tries,\n max_time=max_time,\n jitter=jitter,\n giveup=giveup,\n on_success=on_success,\n on_backoff=on_backoff,\n on_giveup=on_giveup,\n raise_on_giveup=raise_on_giveup,\n wait_gen_kwargs=wait_gen_kwargs\n )\n\n # Return a function which decorates a target with a retry loop.\n return decorate\n\n[end of backoff/_decorator.py]","filename":"backoff/_decorator.py","id":"7"},{"content":"# coding:utf-8\nimport logging\nimport sys\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\n TypeVar, Union)\n\nif sys.version_info >= (3, 8): # pragma: no cover\n from typing import TypedDict\nelse: # pragma: no cover\n # use typing_extensions if installed but don't require it\n try:\n from typing_extensions import TypedDict\n except ImportError:\n class TypedDict(dict):\n def __init_subclass__(cls, **kwargs: Any) -> None:\n return super().__init_subclass__()\n\n\nclass _Details(TypedDict):\n target: Callable[..., Any]\n args: Tuple[Any, ...]\n kwargs: Dict[str, Any]\n tries: int\n elapsed: float\n\n\nclass Details(_Details, total=False):\n wait: float # present in the on_backoff handler case for either decorator\n value: Any # present in the on_predicate decorator case\n\n\nT = TypeVar(\"T\")\n\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\n_Handler = Union[\n Callable[[Details], None],\n Callable[[Details], Coroutine[Any, Any, None]],\n]\n_Jitterer = Callable[[float], float]\n_MaybeCallable = Union[T, Callable[[], T]]\n_MaybeLogger = Union[str, logging.Logger, None]\n_MaybeSequence = Union[T, Sequence[T]]\n_Predicate = Callable[[T], bool]\n_WaitGenerator = Callable[..., Generator[float, None, None]]\n\n[end of backoff/_typing.py]","filename":"backoff/_typing.py","id":"8"},{"content":"# coding:utf-8\n\nimport functools\nimport logging\nimport sys\nimport traceback\nimport warnings\n\n\n# Use module-specific logger with a default null handler.\n_logger = logging.getLogger('backoff')\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\n_logger.setLevel(logging.INFO)\n\n\n# Evaluate arg that can be either a fixed value or a callable.\ndef _maybe_call(f, *args, **kwargs):\n if callable(f):\n try:\n return f(*args, **kwargs)\n except TypeError:\n return f\n else:\n return f\n\n\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\n initialized = wait_gen(**kwargs)\n initialized.send(None) # Initialize with an empty send\n return initialized\n\n\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\n value = wait.send(send_value)\n try:\n if jitter is not None:\n seconds = jitter(value)\n else:\n seconds = value\n except TypeError:\n warnings.warn(\n \"Nullary jitter function signature is deprecated. Use \"\n \"unary signature accepting a wait value in seconds and \"\n \"returning a jittered version of it.\",\n DeprecationWarning,\n stacklevel=2,\n )\n\n seconds = value + jitter()\n\n # don't sleep longer than remaining allotted max_time\n if max_time is not None:\n seconds = min(seconds, max_time - elapsed)\n\n return seconds\n\n\ndef _prepare_logger(logger):\n if isinstance(logger, str):\n logger = logging.getLogger(logger)\n return logger\n\n\n# Configure handler list with user specified handler and optionally\n# with a default handler bound to the specified logger.\ndef _config_handlers(\n user_handlers, *, default_handler=None, logger=None, log_level=None\n):\n handlers = []\n if logger is not None:\n assert log_level is not None, \"Log level is not specified\"\n # bind the specified logger to the default log handler\n log_handler = functools.partial(\n default_handler, logger=logger, log_level=log_level\n )\n handlers.append(log_handler)\n\n if user_handlers is None:\n return handlers\n\n # user specified handlers can either be an iterable of handlers\n # or a single handler. either way append them to the list.\n if hasattr(user_handlers, '__iter__'):\n # add all handlers in the iterable\n handlers += list(user_handlers)\n else:\n # append a single handler\n handlers.append(user_handlers)\n\n return handlers\n\n\n# Default backoff handler\ndef _log_backoff(details, logger, log_level):\n msg = \"Backing off %s(...) for %.1fs (%s)\"\n log_args = [details['target'].__name__, details['wait']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n logger.log(log_level, msg, *log_args)\n\n\n# Default giveup handler\ndef _log_giveup(details, logger, log_level):\n msg = \"Giving up %s(...) after %d tries (%s)\"\n log_args = [details['target'].__name__, details['tries']]\n\n exc_typ, exc, _ = sys.exc_info()\n if exc is not None:\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\n log_args.append(exc_fmt.rstrip(\"\\n\"))\n else:\n log_args.append(details['value'])\n\n logger.log(log_level, msg, *log_args)\n\n[end of backoff/_common.py]","filename":"backoff/_common.py","id":"9"},{"content":"# coding:utf-8\n\"\"\"\nFunction decoration for backoff and retry\n\nThis module provides function decorators which can be used to wrap a\nfunction such that it will be retried until some condition is met. It\nis meant to be of use when accessing unreliable resources with the\npotential for intermittent failures i.e. network resources and external\nAPIs. Somewhat more generally, it may also be of use for dynamically\npolling resources for externally generated content.\n\nFor examples and full documentation see the README at\nhttps://github.com/litl/backoff\n\"\"\"\nfrom backoff._decorator import on_exception, on_predicate\nfrom backoff._jitter import full_jitter, random_jitter\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\n\n__all__ = [\n 'on_predicate',\n 'on_exception',\n 'constant',\n 'expo',\n 'decay',\n 'fibo',\n 'runtime',\n 'full_jitter',\n 'random_jitter',\n]\n\n__version__ = \"2.2.1\"\n\n[end of backoff/__init__.py]","filename":"backoff/__init__.py","id":"10"},{"content":"# coding:utf-8\nfrom ._typing import Details\n\n__all__ = [\n 'Details'\n]\n\n[end of backoff/types.py]","filename":"backoff/types.py","id":"11"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport asyncio\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _ensure_coroutine(coro_or_func):\n if asyncio.iscoroutinefunction(coro_or_func):\n return coro_or_func\n else:\n @functools.wraps(coro_or_func)\n async def f(*args, **kwargs):\n return coro_or_func(*args, **kwargs)\n return f\n\n\ndef _ensure_coroutines(coros_or_funcs):\n return [_ensure_coroutine(f) for f in coros_or_funcs]\n\n\nasync def _call_handlers(handlers,\n *,\n target, args, kwargs, tries, elapsed,\n **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for handler in handlers:\n await handler(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n assert asyncio.iscoroutinefunction(target)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n # update variables from outer function args\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = await target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, value=ret)\n break\n\n await _call_handlers(on_backoff, **details, value=ret,\n wait=seconds)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n continue\n else:\n await _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n on_success = _ensure_coroutines(on_success)\n on_backoff = _ensure_coroutines(on_backoff)\n on_giveup = _ensure_coroutines(on_giveup)\n giveup = _ensure_coroutine(giveup)\n\n # Easy to implement, please report if you need this.\n assert not asyncio.iscoroutinefunction(max_tries)\n assert not asyncio.iscoroutinefunction(jitter)\n\n @functools.wraps(target)\n async def retry(*args, **kwargs):\n\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = await target(*args, **kwargs)\n except exception as e:\n giveup_result = await giveup(e)\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup_result or max_tries_exceeded or max_time_exceeded:\n await _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n await _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n await _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n # Note: there is no convenient way to pass explicit event\n # loop to decorator, so here we assume that either default\n # thread event loop is set and correct (it mostly is\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\n # where loop.get_event_loop() in coroutine guaranteed to\n # return correct value.\n # See for details:\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\n # <https://bugs.python.org/issue28613>\n await asyncio.sleep(seconds)\n else:\n await _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_async.py]","filename":"backoff/_async.py","id":"12"},{"content":"[end of backoff/py.typed]","filename":"backoff/py.typed","id":"13"},{"content":"# coding:utf-8\n\nimport random\n\n\ndef random_jitter(value: float) -> float:\n \"\"\"Jitter the value a random number of milliseconds.\n\n This adds up to 1 second of additional time to the original value.\n Prior to backoff version 1.2 this was the default jitter behavior.\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return value + random.random()\n\n\ndef full_jitter(value: float) -> float:\n \"\"\"Jitter the value across the full range (0 to value).\n\n This corresponds to the \"Full Jitter\" algorithm specified in the\n AWS blog's post on the performance of various jitter algorithms.\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\n\n Args:\n value: The unadulterated backoff value.\n \"\"\"\n return random.uniform(0, value)\n\n[end of backoff/_jitter.py]","filename":"backoff/_jitter.py","id":"14"},{"content":"# coding:utf-8\nimport datetime\nimport functools\nimport time\nfrom datetime import timedelta\n\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\n\n\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\n details = {\n 'target': target,\n 'args': args,\n 'kwargs': kwargs,\n 'tries': tries,\n 'elapsed': elapsed,\n }\n details.update(extra)\n for hdlr in hdlrs:\n hdlr(details)\n\n\ndef retry_predicate(target, wait_gen, predicate,\n *,\n max_tries, max_time, jitter,\n on_success, on_backoff, on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n ret = target(*args, **kwargs)\n if predicate(ret):\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, value=ret)\n break\n\n try:\n seconds = _next_wait(wait, ret, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details)\n break\n\n _call_handlers(on_backoff, **details,\n value=ret, wait=seconds)\n\n time.sleep(seconds)\n continue\n else:\n _call_handlers(on_success, **details, value=ret)\n break\n\n return ret\n\n return retry\n\n\ndef retry_exception(target, wait_gen, exception,\n *,\n max_tries, max_time, jitter, giveup,\n on_success, on_backoff, on_giveup, raise_on_giveup,\n wait_gen_kwargs):\n\n @functools.wraps(target)\n def retry(*args, **kwargs):\n max_tries_value = _maybe_call(max_tries)\n max_time_value = _maybe_call(max_time)\n\n tries = 0\n start = datetime.datetime.now()\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\n while True:\n tries += 1\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\n details = {\n \"target\": target,\n \"args\": args,\n \"kwargs\": kwargs,\n \"tries\": tries,\n \"elapsed\": elapsed,\n }\n\n try:\n ret = target(*args, **kwargs)\n except exception as e:\n max_tries_exceeded = (tries == max_tries_value)\n max_time_exceeded = (max_time_value is not None and\n elapsed >= max_time_value)\n\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\n _call_handlers(on_giveup, **details, exception=e)\n if raise_on_giveup:\n raise\n return None\n\n try:\n seconds = _next_wait(wait, e, jitter, elapsed,\n max_time_value)\n except StopIteration:\n _call_handlers(on_giveup, **details, exception=e)\n raise e\n\n _call_handlers(on_backoff, **details, wait=seconds,\n exception=e)\n\n time.sleep(seconds)\n else:\n _call_handlers(on_success, **details)\n\n return ret\n return retry\n\n[end of backoff/_sync.py]","filename":"backoff/_sync.py","id":"15"},{"content":"# coding:utf-8\n\nimport itertools\nimport math\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\n\n\ndef expo(\n base: float = 2,\n factor: float = 1,\n max_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay.\n\n Args:\n base: The mathematical base of the exponentiation operation\n factor: Factor to multiply the exponentiation by.\n max_value: The maximum value to yield. Once the value in the\n true exponential sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n n = 0\n while True:\n a = factor * base ** n\n if max_value is None or a < max_value:\n yield a\n n += 1\n else:\n yield max_value\n\n\ndef decay(\n initial_value: float = 1,\n decay_factor: float = 1,\n min_value: Optional[float] = None\n) -> Generator[float, Any, None]:\n\n \"\"\"Generator for exponential decay[1]:\n\n Args:\n initial_value: initial quantity\n decay_factor: exponential decay constant.\n min_value: The minimum value to yield. Once the value in the\n true exponential sequence is lower than this, the value\n of min_value will forever after be yielded.\n\n [1] https://en.wikipedia.org/wiki/Exponential_decay\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n t = 0\n while True:\n a = initial_value * math.e ** (-t * decay_factor)\n if min_value is None or a > min_value:\n yield a\n t += 1\n else:\n yield min_value\n\n\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\n \"\"\"Generator for fibonaccial decay.\n\n Args:\n max_value: The maximum value to yield. Once the value in the\n true fibonacci sequence exceeds this, the value\n of max_value will forever after be yielded.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n a = 1\n b = 1\n while True:\n if max_value is None or a < max_value:\n yield a\n a, b = b, a + b\n else:\n yield max_value\n\n\ndef constant(\n interval: Union[int, Iterable[float]] = 1\n) -> Generator[float, None, None]:\n \"\"\"Generator for constant intervals.\n\n Args:\n interval: A constant value to yield or an iterable of such values.\n \"\"\"\n # Advance past initial .send() call\n yield # type: ignore[misc]\n\n try:\n itr = iter(interval) # type: ignore\n except TypeError:\n itr = itertools.repeat(interval) # type: ignore\n\n for val in itr:\n yield val\n\n\ndef runtime(\n *,\n value: Callable[[Any], float]\n) -> Generator[float, None, None]:\n \"\"\"Generator that is based on parsing the return value or thrown\n exception of the decorated method\n\n Args:\n value: a callable which takes as input the decorated\n function's return value or thrown exception and\n determines how long to wait\n \"\"\"\n ret_or_exc = yield # type: ignore[misc]\n while True:\n ret_or_exc = yield value(ret_or_exc)\n\n[end of backoff/_wait_gen.py]","filename":"backoff/_wait_gen.py","id":"16"}],"string":"[\n {\n \"content\": \"The MIT License (MIT)\\n\\nCopyright (c) 2014 litl, LLC.\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in\\nall copies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\\nTHE SOFTWARE.\\n\\n[end of LICENSE]\",\n \"filename\": \"LICENSE\",\n \"id\": \"0\"\n },\n {\n \"content\": \"# Changelog\\n\\n## [v2.2.1] - 2022-10-05\\n\\n- Fix type hint for wait generators https://github.com/litl/backoff/issues/177\\n\\n## [v2.2.0] - 2022-10-05\\n\\n- Improve type annotation for wait generators from @hauntsaninja\\n- Include exception in details dict of call handlers from @petamas\\n- Improve type hints for call handlers from @cdce8p\\n\\n## [v2.1.2] - 2022-06-08\\n### Fixed\\n\\n- Don't use importlib.metadata for __version__ https://github.com/litl/backoff/issues/166\\n\\n## [v2.1.1] - 2022-06-08\\n### Fixed\\n\\n- Fix bug with max_tries/max_time callables https://github.com/litl/backoff/issues/164\\n\\n## [v2.1.0] - 2022-06-07\\n### Changed\\n\\n- Get max_tries/max_time values for every call fixes #160 (from @jvrsantacruz)\\n\\n## [v2.0.1] - 2022-04-27\\n### Changed\\n- Allow None for jitter keyword arg (typing)\\n\\n\\n## [v2.0.0] - 2022-04-26\\n### Added\\n- Add raise_on_giveup keyword arg for decorators\\n- Add backoff.runtime wait generator for dynamically setting wait times based\\n on target function return value or exception details\\n### Changed\\n- Improve type hints for on_success, on_backoff, on_giveup handlers\\n- Use decorator-specific detail and handler type hints\\n- Optionally use typing_extensions for python 3.7 type hinting\\n- Drop python 3.6 support\\n- Add python 3.10 support\\n\\n## [v1.11.1] - 2021-07-14\\n### Fixed\\n- Update __version__ in backoff module\\n\\n## [v1.11.0] - 2021-07-12\\n### Added\\n- Configurable logging levels for backoff and giveup events\\n### Changed\\n- Minor documentation fixes\\n\\n## [v1.10.0] - 2019-12-07\\n### Changed\\n- Allow sync decorator call from async function\\n- NOTE: THIS WILL BE THE FINAL PYTHON 2.7 COMPATIBLE RELEASE.\\n\\n## [v1.9.2] - 2019-11-19\\n### Changed\\n- Don't include tests and changelog in distribution\\n\\n## [v1.9.1] - 2019-11-18\\n### Changed\\n- Include tests and changelog in distribution\\n\\n## [v1.9.0] - 2019-11-16\\n### Changed\\n- Support python 3.8\\n\\n## [v1.8.1] - 2019-10-11\\n### Changed\\n- Use arguments in log messages rather than fully formatting log\\n https://github.com/litl/backoff/pull/82 from @lbernick\\n\\n## [v1.8.0] - 2018-12-20\\n### Added\\n- Custom loggers\\n- Iterable intervals for constant wait_gen for predefined wait sequences\\n### Changed\\n- Give up on StopIteration raised in wait generators\\n- Nullary jitter signature deprecation warning\\n\\n## [v1.7.0] - 2018-11-23\\n### Changed\\n- Support Python 3.7\\n- Drop support for async in Python 3.4\\n- Drop support for Python 2.6\\n- Update development dependencies\\n- Use poetry for dependencies and packaging\\n\\n## [v1.6.0] - 2018-07-14\\n### Changed\\n- Change default log level from ERROR to INFO\\n- Log retries on exception as INFO\\n\\n## [v1.5.0] - 2018-04-11\\n### Added\\n- Add max_time keyword argument\\n\\n## [v1.4.3] - 2017-05-22\\n### Changed\\n- Add license to source distribution\\n\\n## [v1.4.2] - 2017-04-25\\n### Changed\\n- Use documented logger name https://github.com/litl/backoff/pull/32\\n from @pquentin\\n\\n## [v1.4.1] - 2017-04-21\\n### Added\\n- Expose __version__ at package root\\n### Changed\\n- Fix checking for running sync version in coroutine in case when event\\n loop is not set from @rutsky\\n\\n## [v1.4.0] - 2017-02-05\\n### Added\\n- Async support via `asyncio` coroutines (Python 3.4) from @rutsky\\n### Changed\\n- Refactor `backoff` module into package with identical API\\n\\n## [v1.3.2] - 2016-11-18\\n### Changed\\n- Don't log retried args and kwargs by default\\n- README.rst syntax highlighting from @dethi\\n\\n## [v1.3.1] - 2016-08-08\\n### Changed\\n- Include README.rst in source distribution (fixes package)\\n\\n## [v1.3.0] - 2016-08-08\\n### Added\\n- Support runtime configuration with optional callable kwargs\\n- Add giveup kwarg for exception inspection\\n### Changed\\n- Documentation fixes\\n\\n## [v1.2.1] - 2016-05-27\\n### Changed\\n- Documentation fixes\\n\\n\\n## [v1.2.0] - 2016-05-26\\n### Added\\n- 'Full jitter' algorithm from @jonascheng\\n\\n### Changed\\n- Jitter function now accepts raw value and returns jittered value\\n- Change README to reST for the benefit of pypi :(\\n- Remove docstring doc generation and make README canonical\\n\\n## [v1.1.0] - 2015-12-08\\n### Added\\n- Event handling for success, backoff, and giveup\\n- Change log\\n### Changed\\n- Docs and test for multi exception invocations\\n- Update dev environment test dependencies\\n\\n## [v1.0.7] - 2015-02-10\\n### Changed\\n- Fix string formatting for python 2.6\\n\\n## [v1.0.6] - 2015-02-10\\n### Added\\n- Coveralls.io integration from @singingwolfboy\\n### Changed\\n- Fix logging bug for function calls with tuple params\\n\\n## [v1.0.5] - 2015-02-03\\n### Changed\\n- Add a default interval of 1 second for the constant generator\\n- Improve on_predicate stop condition avoiding extra sleep\\n\\n## [v1.0.4] - 2014-08-12\\n### Added\\n- Python 2.6 support from @Bonko\\n- Python 3.0 support from @robyoung\\n- Run tests in Travis from @robyoung\\n\\n## [v1.0.3] - 2014-06-05\\n### Changed\\n- Make logging unicode safe\\n- Log on_predicate backoff as INFO rather than ERROR\\n\\n[end of CHANGELOG.md]\",\n \"filename\": \"CHANGELOG.md\",\n \"id\": \"1\"\n },\n {\n \"content\": \"PY_VERSION := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1)))\\nPY_MAJOR := $(word 1,${PY_VERSION})\\nPY_MINOR := $(word 2,${PY_VERSION})\\nPY_GTE_35 = $(shell echo $(PY_MAJOR).$(PY_MINOR)\\\\>=3.5 | bc)\\n\\n\\n.PHONY: all flake8 clean test check\\n\\nall:\\n\\t@echo 'flake8 check flake8 compliance'\\n\\t@echo 'clean cleanup the source tree'\\n\\t@echo 'test run the unit tests'\\n\\t@echo 'check make sure you are ready to commit'\\n\\nflake8:\\n\\t@flake8 --ignore=E741,W503,W504 backoff tests\\n\\nmypy:\\t\\n\\t@mypy --show-error-codes backoff tests\\n\\nclean:\\n\\t@find . -name \\\"*.pyc\\\" -delete\\n\\t@find . -name \\\"__pycache__\\\" -delete\\n\\t@rm -rf build dist .coverage MANIFEST\\n\\ntest: clean\\n\\t@PYTHONPATH=. py.test --cov-report term-missing --cov backoff tests\\n\\ncheck: flake8 mypy test\\n\\t@coverage report | grep ^TOTAL | grep 100% >/dev/null || \\\\\\n\\t{ echo 'Unit tests coverage is incomplete.'; exit 1; }\\n\\n[end of Makefile]\",\n \"filename\": \"Makefile\",\n \"id\": \"2\"\n },\n {\n \"content\": \"[tool.poetry]\\nname = \\\"backoff\\\"\\nversion = \\\"2.2.1\\\"\\ndescription = \\\"Function decoration for backoff and retry\\\"\\nauthors = [\\\"Bob Green <rgreen@aquent.com>\\\"]\\nreadme = \\\"README.rst\\\"\\nrepository = \\\"https://github.com/litl/backoff\\\"\\nlicense = \\\"MIT\\\"\\nkeywords = [\\\"retry\\\", \\\"backoff\\\", \\\"decorators\\\"]\\nclassifiers = ['Development Status :: 5 - Production/Stable',\\n 'Intended Audience :: Developers',\\n 'Programming Language :: Python',\\n 'License :: OSI Approved :: MIT License',\\n 'Natural Language :: English',\\n 'Operating System :: OS Independent',\\n 'Programming Language :: Python',\\n 'Programming Language :: Python :: 3',\\n 'Programming Language :: Python :: 3.7',\\n 'Programming Language :: Python :: 3.8',\\n 'Programming Language :: Python :: 3.9',\\n 'Programming Language :: Python :: 3.10',\\n 'Topic :: Internet :: WWW/HTTP',\\n 'Topic :: Software Development :: Libraries :: Python Modules',\\n 'Topic :: Utilities']\\npackages = [\\n { include = \\\"backoff\\\" },\\n]\\n\\n[tool.poetry.dependencies]\\npython = \\\"^3.7\\\"\\n\\n[tool.poetry.dev-dependencies]\\nflake8 = \\\"^4.0.1\\\"\\nmypy = \\\"^0.942\\\"\\npytest = \\\"^7.1.2\\\"\\npytest-asyncio = \\\"^0.18.3\\\"\\npytest-cov = \\\"^3.0.0\\\"\\nrequests = \\\"^2.26.0\\\"\\nresponses = \\\"^0.20.0\\\"\\ntypes-requests = \\\"^2.27.20\\\"\\n\\n[build-system]\\nrequires = [\\\"poetry-core>=1.0.0\\\"]\\nbuild-backend = \\\"poetry.core.masonry.api\\\"\\n\\n[end of pyproject.toml]\",\n \"filename\": \"pyproject.toml\",\n \"id\": \"3\"\n },\n {\n \"content\": \"include LICENSE\\ninclude README.rst\\n\\n[end of MANIFEST.in]\",\n \"filename\": \"MANIFEST.in\",\n \"id\": \"4\"\n },\n {\n \"content\": \"backoff\\n=======\\n\\n.. image:: https://travis-ci.org/litl/backoff.svg\\n :target: https://travis-ci.org/litl/backoff\\n.. image:: https://coveralls.io/repos/litl/backoff/badge.svg\\n :target: https://coveralls.io/r/litl/backoff?branch=python-3\\n.. image:: https://github.com/litl/backoff/workflows/CodeQL/badge.svg\\n :target: https://github.com/litl/backoff/actions/workflows/codeql-analysis.yml\\n.. image:: https://img.shields.io/pypi/v/backoff.svg\\n :target: https://pypi.python.org/pypi/backoff\\n.. image:: https://img.shields.io/github/license/litl/backoff\\n :target: https://github.com/litl/backoff/blob/master/LICENSE\\n\\n**Function decoration for backoff and retry**\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nDecorators support both regular functions for synchronous code and\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__'s coroutines\\nfor asynchronous code.\\n\\nExamples\\n========\\n\\nSince Kenneth Reitz's `requests <http://python-requests.org>`_ module\\nhas become a defacto standard for synchronous HTTP clients in Python,\\nnetworking examples below are written using it, but it is in no way required\\nby the backoff module.\\n\\n@backoff.on_exception\\n---------------------\\n\\nThe ``on_exception`` decorator is used to retry when a specified exception\\nis raised. Here's an example using exponential backoff when any\\n``requests`` exception is raised:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException)\\n def get_url(url):\\n return requests.get(url)\\n\\nThe decorator will also accept a tuple of exceptions for cases where\\nthe same backoff behavior is desired for more than one exception type:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n (requests.exceptions.Timeout,\\n requests.exceptions.ConnectionError))\\n def get_url(url):\\n return requests.get(url)\\n\\n**Give Up Conditions**\\n\\nOptional keyword arguments can specify conditions under which to give\\nup.\\n\\nThe keyword argument ``max_time`` specifies the maximum amount\\nof total time in seconds that can elapse before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=60)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nKeyword argument ``max_tries`` specifies the maximum number of calls\\nto make to the target function before giving up.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_tries=8,\\n jitter=None)\\n def get_url(url):\\n return requests.get(url)\\n\\n\\nIn some cases the raised exception instance itself may need to be\\ninspected in order to determine if it is a retryable condition. The\\n``giveup`` keyword arg can be used to specify a function which accepts\\nthe exception and returns a truthy value if the exception should not\\nbe retried:\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nBy default, when a give up event occurs, the exception in question is reraised\\nand so code calling an `on_exception`-decorated function may still\\nneed to do exception handling. This behavior can optionally be disabled\\nusing the `raise_on_giveup` keyword argument.\\n\\nIn the code below, `requests.exceptions.RequestException` will not be raised\\nwhen giveup occurs. Note that the decorated function will return `None` in this\\ncase, regardless of the logic in the `on_exception` handler.\\n\\n.. code-block:: python\\n\\n def fatal_code(e):\\n return 400 <= e.response.status_code < 500\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n max_time=300,\\n raise_on_giveup=False,\\n giveup=fatal_code)\\n def get_url(url):\\n return requests.get(url)\\n\\nThis is useful for non-mission critical code where you still wish to retry\\nthe code inside of `backoff.on_exception` but wish to proceed with execution\\neven if all retries fail.\\n\\n@backoff.on_predicate\\n---------------------\\n\\nThe ``on_predicate`` decorator is used to retry when a particular\\ncondition is true of the return value of the target function. This may\\nbe useful when polling a resource for externally generated content.\\n\\nHere's an example which uses a fibonacci sequence backoff when the\\nreturn value of the target function is the empty list:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_value=13)\\n def poll_for_messages(queue):\\n return queue.get()\\n\\nExtra keyword arguments are passed when initializing the\\nwait generator, so the ``max_value`` param above is passed as a keyword\\narg when initializing the fibo generator.\\n\\nWhen not specified, the predicate param defaults to the falsey test,\\nso the above can more concisely be written:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nMore simply, a function which continues polling every second until it\\ngets a non-falsey result could be defined like like this:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.constant, jitter=None, interval=1)\\n def poll_for_message(queue):\\n return queue.get()\\n\\nThe jitter is disabled in order to keep the polling frequency fixed. \\n\\n@backoff.runtime\\n----------------\\n\\nYou can also use the ``backoff.runtime`` generator to make use of the\\nreturn value or thrown exception of the decorated method.\\n\\nFor example, to use the value in the ``Retry-After`` header of the response:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(\\n backoff.runtime,\\n predicate=lambda r: r.status_code == 429,\\n value=lambda r: int(r.headers.get(\\\"Retry-After\\\")),\\n jitter=None,\\n )\\n def get_url():\\n return requests.get(url)\\n\\nJitter\\n------\\n\\nA jitter algorithm can be supplied with the ``jitter`` keyword arg to\\neither of the backoff decorators. This argument should be a function\\naccepting the original unadulterated backoff value and returning it's\\njittered counterpart.\\n\\nAs of version 1.2, the default jitter function ``backoff.full_jitter``\\nimplements the 'Full Jitter' algorithm as defined in the AWS\\nArchitecture Blog's `Exponential Backoff And Jitter\\n<https://www.awsarchitectureblog.com/2015/03/backoff.html>`_ post.\\nNote that with this algorithm, the time yielded by the wait generator\\nis actually the *maximum* amount of time to wait.\\n\\nPrevious versions of backoff defaulted to adding some random number of\\nmilliseconds (up to 1s) to the raw sleep value. If desired, this\\nbehavior is now available as ``backoff.random_jitter``.\\n\\nUsing multiple decorators\\n-------------------------\\n\\nThe backoff decorators may also be combined to specify different\\nbackoff behavior for different cases:\\n\\n.. code-block:: python\\n\\n @backoff.on_predicate(backoff.fibo, max_value=13)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.HTTPError,\\n max_time=60)\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.Timeout,\\n max_time=300)\\n def poll_for_message(queue):\\n return queue.get()\\n\\n\\nRuntime Configuration\\n---------------------\\n\\nThe decorator functions ``on_exception`` and ``on_predicate`` are\\ngenerally evaluated at import time. This is fine when the keyword args\\nare passed as constant values, but suppose we want to consult a\\ndictionary with configuration options that only become available at\\nruntime. The relevant values are not available at import time. Instead,\\ndecorator functions can be passed callables which are evaluated at\\nruntime to obtain the value:\\n\\n.. code-block:: python\\n\\n def lookup_max_time():\\n # pretend we have a global reference to 'app' here\\n # and that it has a dictionary-like 'config' property\\n return app.config[\\\"BACKOFF_MAX_TIME\\\"]\\n\\n @backoff.on_exception(backoff.expo,\\n ValueError,\\n max_time=lookup_max_time)\\n\\nEvent handlers\\n--------------\\n\\nBoth backoff decorators optionally accept event handler functions\\nusing the keyword arguments ``on_success``, ``on_backoff``, and ``on_giveup``.\\nThis may be useful in reporting statistics or performing other custom\\nlogging.\\n\\nHandlers must be callables with a unary signature accepting a dict\\nargument. This dict contains the details of the invocation. Valid keys\\ninclude:\\n\\n* *target*: reference to the function or method being invoked\\n* *args*: positional arguments to func\\n* *kwargs*: keyword arguments to func\\n* *tries*: number of invocation tries so far\\n* *elapsed*: elapsed time in seconds so far\\n* *wait*: seconds to wait (``on_backoff`` handler only)\\n* *value*: value triggering backoff (``on_predicate`` decorator only)\\n\\nA handler which prints the details of the backoff event could be\\nimplemented like so:\\n\\n.. code-block:: python\\n\\n def backoff_hdlr(details):\\n print (\\\"Backing off {wait:0.1f} seconds after {tries} tries \\\"\\n \\\"calling function {target} with args {args} and kwargs \\\"\\n \\\"{kwargs}\\\".format(**details))\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=backoff_hdlr)\\n def get_url(url):\\n return requests.get(url)\\n\\n**Multiple handlers per event type**\\n\\nIn all cases, iterables of handler functions are also accepted, which\\nare called in turn. For example, you might provide a simple list of\\nhandler functions as the value of the ``on_backoff`` keyword arg:\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n on_backoff=[backoff_hdlr1, backoff_hdlr2])\\n def get_url(url):\\n return requests.get(url)\\n\\n**Getting exception info**\\n\\nIn the case of the ``on_exception`` decorator, all ``on_backoff`` and\\n``on_giveup`` handlers are called from within the except block for the\\nexception being handled. Therefore exception info is available to the\\nhandler functions via the python standard library, specifically\\n``sys.exc_info()`` or the ``traceback`` module. The exception is also\\navailable at the *exception* key in the `details` dict passed to the\\nhandlers.\\n\\nAsynchronous code\\n-----------------\\n\\nBackoff supports asynchronous execution in Python 3.5 and above.\\n\\nTo use backoff in asynchronous code based on\\n`asyncio <https://docs.python.org/3/library/asyncio.html>`__\\nyou simply need to apply ``backoff.on_exception`` or ``backoff.on_predicate``\\nto coroutines.\\nYou can also use coroutines for the ``on_success``, ``on_backoff``, and\\n``on_giveup`` event handlers, with the interface otherwise being identical.\\n\\nThe following examples use `aiohttp <https://aiohttp.readthedocs.io/>`__\\nasynchronous HTTP client/server library.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo, aiohttp.ClientError, max_time=60)\\n async def get_url(url):\\n async with aiohttp.ClientSession(raise_for_status=True) as session:\\n async with session.get(url) as response:\\n return await response.text()\\n\\nLogging configuration\\n---------------------\\n\\nBy default, backoff and retry attempts are logged to the 'backoff'\\nlogger. By default, this logger is configured with a NullHandler, so\\nthere will be nothing output unless you configure a handler.\\nProgrammatically, this might be accomplished with something as simple\\nas:\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').addHandler(logging.StreamHandler())\\n\\nThe default logging level is INFO, which corresponds to logging\\nanytime a retry event occurs. If you would instead like to log\\nonly when a giveup event occurs, set the logger level to ERROR.\\n\\n.. code-block:: python\\n\\n logging.getLogger('backoff').setLevel(logging.ERROR)\\n\\nIt is also possible to specify an alternate logger with the ``logger``\\nkeyword argument. If a string value is specified the logger will be\\nlooked up by name.\\n\\n.. code-block:: python\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger='my_logger')\\n # ...\\n\\nIt is also supported to specify a Logger (or LoggerAdapter) object\\ndirectly.\\n\\n.. code-block:: python\\n\\n my_logger = logging.getLogger('my_logger')\\n my_handler = logging.StreamHandler()\\n my_logger.addHandler(my_handler)\\n my_logger.setLevel(logging.ERROR)\\n\\n @backoff.on_exception(backoff.expo,\\n requests.exceptions.RequestException,\\n\\t\\t\\t logger=my_logger)\\n # ...\\n\\nDefault logging can be disabled all together by specifying\\n``logger=None``. In this case, if desired alternative logging behavior\\ncould be defined by using custom event handlers.\\n\\n[end of README.rst]\",\n \"filename\": \"README.rst\",\n \"id\": \"5\"\n },\n {\n \"content\": \"language: python\\npython:\\n - \\\"3.7\\\"\\n - \\\"3.8\\\"\\n - \\\"3.9\\\"\\n - \\\"3.10\\\"\\nbefore_install:\\n - pip install poetry more-itertools\\ninstall:\\n - poetry install\\nscript: poetry run make check\\nafter_success: coveralls\\nnotifications:\\n email: false\\n\\n[end of .travis.yml]\",\n \"filename\": \".travis.yml\",\n \"id\": \"6\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport asyncio\\nimport logging\\nimport operator\\nfrom typing import Any, Callable, Iterable, Optional, Type, Union\\n\\nfrom backoff._common import (\\n _prepare_logger,\\n _config_handlers,\\n _log_backoff,\\n _log_giveup\\n)\\nfrom backoff._jitter import full_jitter\\nfrom backoff import _async, _sync\\nfrom backoff._typing import (\\n _CallableT,\\n _Handler,\\n _Jitterer,\\n _MaybeCallable,\\n _MaybeLogger,\\n _MaybeSequence,\\n _Predicate,\\n _WaitGenerator,\\n)\\n\\n\\ndef on_predicate(wait_gen: _WaitGenerator,\\n predicate: _Predicate[Any] = operator.not_,\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by predicate.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n predicate: A function which when called on the return value of\\n the target function will trigger backoff when considered\\n truthily. If not specified, the default behavior is to\\n backoff on falsey return values.\\n max_tries: The maximum number of attempts to make before giving\\n up. In the case of failure, the result of the last attempt\\n will be returned. The default value of None means there\\n is no limit to the number of tries. If a callable is passed,\\n it will be evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time in seconds to try for before\\n giving up. If this time expires, the result of the last\\n attempt will be returned. If a callable is passed, it will\\n be evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n logger: Name of logger or Logger object to log to. Defaults to\\n 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_predicate\\n else:\\n retry = _sync.retry_predicate\\n\\n return retry(\\n target,\\n wait_gen,\\n predicate,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n\\ndef on_exception(wait_gen: _WaitGenerator,\\n exception: _MaybeSequence[Type[Exception]],\\n *,\\n max_tries: Optional[_MaybeCallable[int]] = None,\\n max_time: Optional[_MaybeCallable[float]] = None,\\n jitter: Union[_Jitterer, None] = full_jitter,\\n giveup: _Predicate[Exception] = lambda e: False,\\n on_success: Union[_Handler, Iterable[_Handler], None] = None,\\n on_backoff: Union[_Handler, Iterable[_Handler], None] = None,\\n on_giveup: Union[_Handler, Iterable[_Handler], None] = None,\\n raise_on_giveup: bool = True,\\n logger: _MaybeLogger = 'backoff',\\n backoff_log_level: int = logging.INFO,\\n giveup_log_level: int = logging.ERROR,\\n **wait_gen_kwargs: Any) -> Callable[[_CallableT], _CallableT]:\\n \\\"\\\"\\\"Returns decorator for backoff and retry triggered by exception.\\n\\n Args:\\n wait_gen: A generator yielding successive wait times in\\n seconds.\\n exception: An exception type (or tuple of types) which triggers\\n backoff.\\n max_tries: The maximum number of attempts to make before giving\\n up. Once exhausted, the exception will be allowed to escape.\\n The default value of None means there is no limit to the\\n number of tries. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n max_time: The maximum total amount of time to try for before\\n giving up. Once expired, the exception will be allowed to\\n escape. If a callable is passed, it will be\\n evaluated at runtime and its return value used.\\n jitter: A function of the value yielded by wait_gen returning\\n the actual time to wait. This distributes wait times\\n stochastically in order to avoid timing collisions across\\n concurrent clients. Wait times are jittered by default\\n using the full_jitter function. Jittering may be disabled\\n altogether by passing jitter=None.\\n giveup: Function accepting an exception instance and\\n returning whether or not to give up. Optional. The default\\n is to always continue.\\n on_success: Callable (or iterable of callables) with a unary\\n signature to be called in the event of success. The\\n parameter is a dict containing details about the invocation.\\n on_backoff: Callable (or iterable of callables) with a unary\\n signature to be called in the event of a backoff. The\\n parameter is a dict containing details about the invocation.\\n on_giveup: Callable (or iterable of callables) with a unary\\n signature to be called in the event that max_tries\\n is exceeded. The parameter is a dict containing details\\n about the invocation.\\n raise_on_giveup: Boolean indicating whether the registered exceptions\\n should be raised on giveup. Defaults to `True`\\n logger: Name or Logger object to log to. Defaults to 'backoff'.\\n backoff_log_level: log level for the backoff event. Defaults to \\\"INFO\\\"\\n giveup_log_level: log level for the give up event. Defaults to \\\"ERROR\\\"\\n **wait_gen_kwargs: Any additional keyword args specified will be\\n passed to wait_gen when it is initialized. Any callable\\n args will first be evaluated and their return values passed.\\n This is useful for runtime configuration.\\n \\\"\\\"\\\"\\n def decorate(target):\\n nonlocal logger, on_success, on_backoff, on_giveup\\n\\n logger = _prepare_logger(logger)\\n on_success = _config_handlers(on_success)\\n on_backoff = _config_handlers(\\n on_backoff,\\n default_handler=_log_backoff,\\n logger=logger,\\n log_level=backoff_log_level,\\n )\\n on_giveup = _config_handlers(\\n on_giveup,\\n default_handler=_log_giveup,\\n logger=logger,\\n log_level=giveup_log_level,\\n )\\n\\n if asyncio.iscoroutinefunction(target):\\n retry = _async.retry_exception\\n else:\\n retry = _sync.retry_exception\\n\\n return retry(\\n target,\\n wait_gen,\\n exception,\\n max_tries=max_tries,\\n max_time=max_time,\\n jitter=jitter,\\n giveup=giveup,\\n on_success=on_success,\\n on_backoff=on_backoff,\\n on_giveup=on_giveup,\\n raise_on_giveup=raise_on_giveup,\\n wait_gen_kwargs=wait_gen_kwargs\\n )\\n\\n # Return a function which decorates a target with a retry loop.\\n return decorate\\n\\n[end of backoff/_decorator.py]\",\n \"filename\": \"backoff/_decorator.py\",\n \"id\": \"7\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport logging\\nimport sys\\nfrom typing import (Any, Callable, Coroutine, Dict, Generator, Sequence, Tuple,\\n TypeVar, Union)\\n\\nif sys.version_info >= (3, 8): # pragma: no cover\\n from typing import TypedDict\\nelse: # pragma: no cover\\n # use typing_extensions if installed but don't require it\\n try:\\n from typing_extensions import TypedDict\\n except ImportError:\\n class TypedDict(dict):\\n def __init_subclass__(cls, **kwargs: Any) -> None:\\n return super().__init_subclass__()\\n\\n\\nclass _Details(TypedDict):\\n target: Callable[..., Any]\\n args: Tuple[Any, ...]\\n kwargs: Dict[str, Any]\\n tries: int\\n elapsed: float\\n\\n\\nclass Details(_Details, total=False):\\n wait: float # present in the on_backoff handler case for either decorator\\n value: Any # present in the on_predicate decorator case\\n\\n\\nT = TypeVar(\\\"T\\\")\\n\\n_CallableT = TypeVar('_CallableT', bound=Callable[..., Any])\\n_Handler = Union[\\n Callable[[Details], None],\\n Callable[[Details], Coroutine[Any, Any, None]],\\n]\\n_Jitterer = Callable[[float], float]\\n_MaybeCallable = Union[T, Callable[[], T]]\\n_MaybeLogger = Union[str, logging.Logger, None]\\n_MaybeSequence = Union[T, Sequence[T]]\\n_Predicate = Callable[[T], bool]\\n_WaitGenerator = Callable[..., Generator[float, None, None]]\\n\\n[end of backoff/_typing.py]\",\n \"filename\": \"backoff/_typing.py\",\n \"id\": \"8\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport functools\\nimport logging\\nimport sys\\nimport traceback\\nimport warnings\\n\\n\\n# Use module-specific logger with a default null handler.\\n_logger = logging.getLogger('backoff')\\n_logger.addHandler(logging.NullHandler()) # pragma: no cover\\n_logger.setLevel(logging.INFO)\\n\\n\\n# Evaluate arg that can be either a fixed value or a callable.\\ndef _maybe_call(f, *args, **kwargs):\\n if callable(f):\\n try:\\n return f(*args, **kwargs)\\n except TypeError:\\n return f\\n else:\\n return f\\n\\n\\ndef _init_wait_gen(wait_gen, wait_gen_kwargs):\\n kwargs = {k: _maybe_call(v) for k, v in wait_gen_kwargs.items()}\\n initialized = wait_gen(**kwargs)\\n initialized.send(None) # Initialize with an empty send\\n return initialized\\n\\n\\ndef _next_wait(wait, send_value, jitter, elapsed, max_time):\\n value = wait.send(send_value)\\n try:\\n if jitter is not None:\\n seconds = jitter(value)\\n else:\\n seconds = value\\n except TypeError:\\n warnings.warn(\\n \\\"Nullary jitter function signature is deprecated. Use \\\"\\n \\\"unary signature accepting a wait value in seconds and \\\"\\n \\\"returning a jittered version of it.\\\",\\n DeprecationWarning,\\n stacklevel=2,\\n )\\n\\n seconds = value + jitter()\\n\\n # don't sleep longer than remaining allotted max_time\\n if max_time is not None:\\n seconds = min(seconds, max_time - elapsed)\\n\\n return seconds\\n\\n\\ndef _prepare_logger(logger):\\n if isinstance(logger, str):\\n logger = logging.getLogger(logger)\\n return logger\\n\\n\\n# Configure handler list with user specified handler and optionally\\n# with a default handler bound to the specified logger.\\ndef _config_handlers(\\n user_handlers, *, default_handler=None, logger=None, log_level=None\\n):\\n handlers = []\\n if logger is not None:\\n assert log_level is not None, \\\"Log level is not specified\\\"\\n # bind the specified logger to the default log handler\\n log_handler = functools.partial(\\n default_handler, logger=logger, log_level=log_level\\n )\\n handlers.append(log_handler)\\n\\n if user_handlers is None:\\n return handlers\\n\\n # user specified handlers can either be an iterable of handlers\\n # or a single handler. either way append them to the list.\\n if hasattr(user_handlers, '__iter__'):\\n # add all handlers in the iterable\\n handlers += list(user_handlers)\\n else:\\n # append a single handler\\n handlers.append(user_handlers)\\n\\n return handlers\\n\\n\\n# Default backoff handler\\ndef _log_backoff(details, logger, log_level):\\n msg = \\\"Backing off %s(...) for %.1fs (%s)\\\"\\n log_args = [details['target'].__name__, details['wait']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n logger.log(log_level, msg, *log_args)\\n\\n\\n# Default giveup handler\\ndef _log_giveup(details, logger, log_level):\\n msg = \\\"Giving up %s(...) after %d tries (%s)\\\"\\n log_args = [details['target'].__name__, details['tries']]\\n\\n exc_typ, exc, _ = sys.exc_info()\\n if exc is not None:\\n exc_fmt = traceback.format_exception_only(exc_typ, exc)[-1]\\n log_args.append(exc_fmt.rstrip(\\\"\\\\n\\\"))\\n else:\\n log_args.append(details['value'])\\n\\n logger.log(log_level, msg, *log_args)\\n\\n[end of backoff/_common.py]\",\n \"filename\": \"backoff/_common.py\",\n \"id\": \"9\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\\"\\\"\\\"\\nFunction decoration for backoff and retry\\n\\nThis module provides function decorators which can be used to wrap a\\nfunction such that it will be retried until some condition is met. It\\nis meant to be of use when accessing unreliable resources with the\\npotential for intermittent failures i.e. network resources and external\\nAPIs. Somewhat more generally, it may also be of use for dynamically\\npolling resources for externally generated content.\\n\\nFor examples and full documentation see the README at\\nhttps://github.com/litl/backoff\\n\\\"\\\"\\\"\\nfrom backoff._decorator import on_exception, on_predicate\\nfrom backoff._jitter import full_jitter, random_jitter\\nfrom backoff._wait_gen import constant, expo, fibo, runtime, decay\\n\\n__all__ = [\\n 'on_predicate',\\n 'on_exception',\\n 'constant',\\n 'expo',\\n 'decay',\\n 'fibo',\\n 'runtime',\\n 'full_jitter',\\n 'random_jitter',\\n]\\n\\n__version__ = \\\"2.2.1\\\"\\n\\n[end of backoff/__init__.py]\",\n \"filename\": \"backoff/__init__.py\",\n \"id\": \"10\"\n },\n {\n \"content\": \"# coding:utf-8\\nfrom ._typing import Details\\n\\n__all__ = [\\n 'Details'\\n]\\n\\n[end of backoff/types.py]\",\n \"filename\": \"backoff/types.py\",\n \"id\": \"11\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport asyncio\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _ensure_coroutine(coro_or_func):\\n if asyncio.iscoroutinefunction(coro_or_func):\\n return coro_or_func\\n else:\\n @functools.wraps(coro_or_func)\\n async def f(*args, **kwargs):\\n return coro_or_func(*args, **kwargs)\\n return f\\n\\n\\ndef _ensure_coroutines(coros_or_funcs):\\n return [_ensure_coroutine(f) for f in coros_or_funcs]\\n\\n\\nasync def _call_handlers(handlers,\\n *,\\n target, args, kwargs, tries, elapsed,\\n **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for handler in handlers:\\n await handler(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n assert asyncio.iscoroutinefunction(target)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n # update variables from outer function args\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = await target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n await _call_handlers(on_backoff, **details, value=ret,\\n wait=seconds)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n continue\\n else:\\n await _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n on_success = _ensure_coroutines(on_success)\\n on_backoff = _ensure_coroutines(on_backoff)\\n on_giveup = _ensure_coroutines(on_giveup)\\n giveup = _ensure_coroutine(giveup)\\n\\n # Easy to implement, please report if you need this.\\n assert not asyncio.iscoroutinefunction(max_tries)\\n assert not asyncio.iscoroutinefunction(jitter)\\n\\n @functools.wraps(target)\\n async def retry(*args, **kwargs):\\n\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = await target(*args, **kwargs)\\n except exception as e:\\n giveup_result = await giveup(e)\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup_result or max_tries_exceeded or max_time_exceeded:\\n await _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n await _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n await _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n # Note: there is no convenient way to pass explicit event\\n # loop to decorator, so here we assume that either default\\n # thread event loop is set and correct (it mostly is\\n # by default), or Python >= 3.5.3 or Python >= 3.6 is used\\n # where loop.get_event_loop() in coroutine guaranteed to\\n # return correct value.\\n # See for details:\\n # <https://groups.google.com/forum/#!topic/python-tulip/yF9C-rFpiKk>\\n # <https://bugs.python.org/issue28613>\\n await asyncio.sleep(seconds)\\n else:\\n await _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_async.py]\",\n \"filename\": \"backoff/_async.py\",\n \"id\": \"12\"\n },\n {\n \"content\": \"[end of backoff/py.typed]\",\n \"filename\": \"backoff/py.typed\",\n \"id\": \"13\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport random\\n\\n\\ndef random_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value a random number of milliseconds.\\n\\n This adds up to 1 second of additional time to the original value.\\n Prior to backoff version 1.2 this was the default jitter behavior.\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return value + random.random()\\n\\n\\ndef full_jitter(value: float) -> float:\\n \\\"\\\"\\\"Jitter the value across the full range (0 to value).\\n\\n This corresponds to the \\\"Full Jitter\\\" algorithm specified in the\\n AWS blog's post on the performance of various jitter algorithms.\\n (http://www.awsarchitectureblog.com/2015/03/backoff.html)\\n\\n Args:\\n value: The unadulterated backoff value.\\n \\\"\\\"\\\"\\n return random.uniform(0, value)\\n\\n[end of backoff/_jitter.py]\",\n \"filename\": \"backoff/_jitter.py\",\n \"id\": \"14\"\n },\n {\n \"content\": \"# coding:utf-8\\nimport datetime\\nimport functools\\nimport time\\nfrom datetime import timedelta\\n\\nfrom backoff._common import (_init_wait_gen, _maybe_call, _next_wait)\\n\\n\\ndef _call_handlers(hdlrs, target, args, kwargs, tries, elapsed, **extra):\\n details = {\\n 'target': target,\\n 'args': args,\\n 'kwargs': kwargs,\\n 'tries': tries,\\n 'elapsed': elapsed,\\n }\\n details.update(extra)\\n for hdlr in hdlrs:\\n hdlr(details)\\n\\n\\ndef retry_predicate(target, wait_gen, predicate,\\n *,\\n max_tries, max_time, jitter,\\n on_success, on_backoff, on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n ret = target(*args, **kwargs)\\n if predicate(ret):\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, value=ret)\\n break\\n\\n try:\\n seconds = _next_wait(wait, ret, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details)\\n break\\n\\n _call_handlers(on_backoff, **details,\\n value=ret, wait=seconds)\\n\\n time.sleep(seconds)\\n continue\\n else:\\n _call_handlers(on_success, **details, value=ret)\\n break\\n\\n return ret\\n\\n return retry\\n\\n\\ndef retry_exception(target, wait_gen, exception,\\n *,\\n max_tries, max_time, jitter, giveup,\\n on_success, on_backoff, on_giveup, raise_on_giveup,\\n wait_gen_kwargs):\\n\\n @functools.wraps(target)\\n def retry(*args, **kwargs):\\n max_tries_value = _maybe_call(max_tries)\\n max_time_value = _maybe_call(max_time)\\n\\n tries = 0\\n start = datetime.datetime.now()\\n wait = _init_wait_gen(wait_gen, wait_gen_kwargs)\\n while True:\\n tries += 1\\n elapsed = timedelta.total_seconds(datetime.datetime.now() - start)\\n details = {\\n \\\"target\\\": target,\\n \\\"args\\\": args,\\n \\\"kwargs\\\": kwargs,\\n \\\"tries\\\": tries,\\n \\\"elapsed\\\": elapsed,\\n }\\n\\n try:\\n ret = target(*args, **kwargs)\\n except exception as e:\\n max_tries_exceeded = (tries == max_tries_value)\\n max_time_exceeded = (max_time_value is not None and\\n elapsed >= max_time_value)\\n\\n if giveup(e) or max_tries_exceeded or max_time_exceeded:\\n _call_handlers(on_giveup, **details, exception=e)\\n if raise_on_giveup:\\n raise\\n return None\\n\\n try:\\n seconds = _next_wait(wait, e, jitter, elapsed,\\n max_time_value)\\n except StopIteration:\\n _call_handlers(on_giveup, **details, exception=e)\\n raise e\\n\\n _call_handlers(on_backoff, **details, wait=seconds,\\n exception=e)\\n\\n time.sleep(seconds)\\n else:\\n _call_handlers(on_success, **details)\\n\\n return ret\\n return retry\\n\\n[end of backoff/_sync.py]\",\n \"filename\": \"backoff/_sync.py\",\n \"id\": \"15\"\n },\n {\n \"content\": \"# coding:utf-8\\n\\nimport itertools\\nimport math\\nfrom typing import Any, Callable, Generator, Iterable, Optional, Union\\n\\n\\ndef expo(\\n base: float = 2,\\n factor: float = 1,\\n max_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay.\\n\\n Args:\\n base: The mathematical base of the exponentiation operation\\n factor: Factor to multiply the exponentiation by.\\n max_value: The maximum value to yield. Once the value in the\\n true exponential sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n n = 0\\n while True:\\n a = factor * base ** n\\n if max_value is None or a < max_value:\\n yield a\\n n += 1\\n else:\\n yield max_value\\n\\n\\ndef decay(\\n initial_value: float = 1,\\n decay_factor: float = 1,\\n min_value: Optional[float] = None\\n) -> Generator[float, Any, None]:\\n\\n \\\"\\\"\\\"Generator for exponential decay[1]:\\n\\n Args:\\n initial_value: initial quantity\\n decay_factor: exponential decay constant.\\n min_value: The minimum value to yield. Once the value in the\\n true exponential sequence is lower than this, the value\\n of min_value will forever after be yielded.\\n\\n [1] https://en.wikipedia.org/wiki/Exponential_decay\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n t = 0\\n while True:\\n a = initial_value * math.e ** (-t * decay_factor)\\n if min_value is None or a > min_value:\\n yield a\\n t += 1\\n else:\\n yield min_value\\n\\n\\ndef fibo(max_value: Optional[int] = None) -> Generator[int, None, None]:\\n \\\"\\\"\\\"Generator for fibonaccial decay.\\n\\n Args:\\n max_value: The maximum value to yield. Once the value in the\\n true fibonacci sequence exceeds this, the value\\n of max_value will forever after be yielded.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n a = 1\\n b = 1\\n while True:\\n if max_value is None or a < max_value:\\n yield a\\n a, b = b, a + b\\n else:\\n yield max_value\\n\\n\\ndef constant(\\n interval: Union[int, Iterable[float]] = 1\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator for constant intervals.\\n\\n Args:\\n interval: A constant value to yield or an iterable of such values.\\n \\\"\\\"\\\"\\n # Advance past initial .send() call\\n yield # type: ignore[misc]\\n\\n try:\\n itr = iter(interval) # type: ignore\\n except TypeError:\\n itr = itertools.repeat(interval) # type: ignore\\n\\n for val in itr:\\n yield val\\n\\n\\ndef runtime(\\n *,\\n value: Callable[[Any], float]\\n) -> Generator[float, None, None]:\\n \\\"\\\"\\\"Generator that is based on parsing the return value or thrown\\n exception of the decorated method\\n\\n Args:\\n value: a callable which takes as input the decorated\\n function's return value or thrown exception and\\n determines how long to wait\\n \\\"\\\"\\\"\\n ret_or_exc = yield # type: ignore[misc]\\n while True:\\n ret_or_exc = yield value(ret_or_exc)\\n\\n[end of backoff/_wait_gen.py]\",\n \"filename\": \"backoff/_wait_gen.py\",\n \"id\": \"16\"\n }\n]","isConversational":false}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":0,"numItemsPerPage":100,"numTotalItems":443,"offset":0,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sInJlcG9JZHMiOlsiNjhlYWU0OTg5NTY3MjM3YTUyYTNlZGQ2Il0sImlhdCI6MTc5MzgwMjU5OSwianRpIjoiMTQ1OTI5Y2MtZjUzYS00YTEwLTg0ZGYtZDI3YWVhMDQ3YzFlIiwic3ViIjoiL2RhdGFzZXRzL2FndTE4ZGVjL0xvbmdDb2RlUUEiLCJleHAiOjE3OTM4MDYxOTksImlzcyI6Imh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28ifQ.ysAcUQKq_cRAEw2lI9nFIYLMEwWl8KzAgPR5qwgO0EzcVLzt8MOvUWQgLkcDgz6jUi88L3b1D_wEmPIe1S6GDw","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":443,"numBytesParquet":108212095}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
metadata dict | texts listlengths 7 391 |
|---|---|
{
"id": 0,
"num_files": 36,
"repo_id": "repo_0000",
"subset": "32K"
} | [
{
"content": "How to contribute to MarkupSafe\n===============================\n\nThank you for considering contributing to MarkupSafe!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a tool\nto address bugs and feature requests in MarkupSafe itself... |
{
"id": 1,
"num_files": 36,
"repo_id": "repo_0001",
"subset": "32K"
} | [
{
"content": "How to contribute to MarkupSafe\n===============================\n\nThank you for considering contributing to MarkupSafe!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a tool\nto address bugs and feature requests in MarkupSafe itself... |
{
"id": 2,
"num_files": 35,
"repo_id": "repo_0002",
"subset": "32K"
} | [
{
"content": "import sys\n\ncollect_ignore = [\n # this module fails mypy tests because 'setup.py' matches './setup.py'\n 'tests/data/sources/example/setup.py',\n]\n\n\ndef pytest_configure():\n remove_importlib_metadata()\n\n\ndef remove_importlib_metadata():\n \"\"\"\n Ensure importlib_metadata... |
{
"id": 3,
"num_files": 35,
"repo_id": "repo_0003",
"subset": "32K"
} | [
{
"content": "import sys\n\ncollect_ignore = [\n # this module fails mypy tests because 'setup.py' matches './setup.py'\n 'tests/data/sources/example/setup.py',\n]\n\n\ndef pytest_configure():\n remove_importlib_metadata()\n\n\ndef remove_importlib_metadata():\n \"\"\"\n Ensure importlib_metadata... |
{
"id": 4,
"num_files": 35,
"repo_id": "repo_0004",
"subset": "32K"
} | [
{
"content": "import sys\n\ncollect_ignore = [\n # this module fails mypy tests because 'setup.py' matches './setup.py'\n 'tests/data/sources/example/setup.py',\n]\n\n\ndef pytest_configure():\n remove_importlib_metadata()\n\n\ndef remove_importlib_metadata():\n \"\"\"\n Ensure importlib_metadata... |
{
"id": 5,
"num_files": 31,
"repo_id": "repo_0005",
"subset": "32K"
} | [
{
"content": "MIT License\n\nCopyright (c) 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, includin... |
{
"id": 6,
"num_files": 31,
"repo_id": "repo_0006",
"subset": "32K"
} | [
{
"content": "MIT License\n\nCopyright (c) 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, includin... |
{
"id": 7,
"num_files": 31,
"repo_id": "repo_0007",
"subset": "32K"
} | [
{
"content": "MIT License\n\nCopyright (c) 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, includin... |
{
"id": 8,
"num_files": 24,
"repo_id": "repo_0008",
"subset": "32K"
} | [
{
"content": "import builtins\nimport sys\n\n\ndef pytest_configure():\n add_future_flags()\n\n\ndef add_future_flags(): # pragma: no cover\n if sys.version_info > (3, 10):\n return\n\n builtins.EncodingWarning = type('EncodingWarning', (Warning,), {})\n\n[end of conftest.py]",
"filename": ... |
{
"id": 9,
"num_files": 24,
"repo_id": "repo_0009",
"subset": "32K"
} | [
{
"content": "import builtins\nimport sys\n\n\ndef pytest_configure():\n add_future_flags()\n\n\ndef add_future_flags(): # pragma: no cover\n if sys.version_info > (3, 10):\n return\n\n builtins.EncodingWarning = type('EncodingWarning', (Warning,), {})\n\n[end of conftest.py]",
"filename": ... |
{
"id": 10,
"num_files": 38,
"repo_id": "repo_0010",
"subset": "32K"
} | [
{
"content": "$ve=\"$HOME\\.virtualenvs\\colorama\"\n$bin=\"$ve\\Scripts\"\n\n& $bin\\python.exe -m unittest discover -p *_test.py\n\n\n[end of test.ps1]",
"filename": "test.ps1",
"id": "0"
},
{
"content": "# none\n\n[end of requirements.txt]",
"filename": "requirements.txt",
"id": "1"
... |
{
"id": 11,
"num_files": 38,
"repo_id": "repo_0011",
"subset": "32K"
} | [
{
"content": "$ve=\"$HOME\\.virtualenvs\\colorama\"\n$bin=\"$ve\\Scripts\"\n\n& $bin\\python.exe -m unittest discover -p *_test.py\n\n\n[end of test.ps1]",
"filename": "test.ps1",
"id": "0"
},
{
"content": "# none\n\n[end of requirements.txt]",
"filename": "requirements.txt",
"id": "1"
... |
{
"id": 12,
"num_files": 15,
"repo_id": "repo_0012",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014-2025 Thomas Kemmer\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rig... |
{
"id": 13,
"num_files": 15,
"repo_id": "repo_0013",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014-2025 Thomas Kemmer\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rig... |
{
"id": 14,
"num_files": 15,
"repo_id": "repo_0014",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014-2025 Thomas Kemmer\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rig... |
{
"id": 15,
"num_files": 15,
"repo_id": "repo_0015",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014-2025 Thomas Kemmer\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rig... |
{
"id": 16,
"num_files": 28,
"repo_id": "repo_0016",
"subset": "32K"
} | [
{
"content": "[flake8]\nmax-line-length = 88\nmax-complexity = 10\n# These checks violate PEP8 so let's ignore them\nextend-ignore = E203\nextend-exclude = */site-packages/*\n\n[end of .flake8]",
"filename": ".flake8",
"id": "0"
},
{
"content": "SPDX-License-Identifier: MIT\nSPDX-FileCopyrightTe... |
{
"id": 17,
"num_files": 28,
"repo_id": "repo_0017",
"subset": "32K"
} | [
{
"content": "[flake8]\nmax-line-length = 88\nmax-complexity = 10\n# These checks violate PEP8 so let's ignore them\nextend-ignore = E203\nextend-exclude = */site-packages/*\n\n[end of .flake8]",
"filename": ".flake8",
"id": "0"
},
{
"content": "SPDX-License-Identifier: MIT\nSPDX-FileCopyrightTe... |
{
"id": 18,
"num_files": 13,
"repo_id": "repo_0018",
"subset": "32K"
} | [
{
"content": "# content of example.ini\n[section1] # comment\nname1=value1 # comment\nname1b=value1,value2 # comment\n\n[section2]\nname2=\n line1\n line2\n\n[end of example.ini]",
"filename": "example.ini",
"id": "0"
},
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2010 - 2023 Ho... |
{
"id": 19,
"num_files": 12,
"repo_id": "repo_0019",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 the contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the right... |
{
"id": 20,
"num_files": 12,
"repo_id": "repo_0020",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 the contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the right... |
{
"id": 21,
"num_files": 12,
"repo_id": "repo_0021",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 the contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the right... |
{
"id": 22,
"num_files": 12,
"repo_id": "repo_0022",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 the contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the right... |
{
"id": 23,
"num_files": 26,
"repo_id": "repo_0023",
"subset": "32K"
} | [
{
"content": "For the Trio code of conduct, see:\n https://trio.readthedocs.io/en/latest/code-of-conduct.html\n\n[end of CODE_OF_CONDUCT.md]",
"filename": "CODE_OF_CONDUCT.md",
"id": "0"
},
{
"content": "Apache License\n Version 2.0, January 2004\n ... |
{
"id": 24,
"num_files": 26,
"repo_id": "repo_0024",
"subset": "32K"
} | [
{
"content": "For the Trio code of conduct, see:\n https://trio.readthedocs.io/en/latest/code-of-conduct.html\n\n[end of CODE_OF_CONDUCT.md]",
"filename": "CODE_OF_CONDUCT.md",
"id": "0"
},
{
"content": "Apache License\n Version 2.0, January 2004\n ... |
{
"id": 25,
"num_files": 11,
"repo_id": "repo_0025",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 Alex Grönholm\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights t... |
{
"id": 26,
"num_files": 11,
"repo_id": "repo_0026",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 Alex Grönholm\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights t... |
{
"id": 27,
"num_files": 11,
"repo_id": "repo_0027",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 Alex Grönholm\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights t... |
{
"id": 28,
"num_files": 11,
"repo_id": "repo_0028",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 Alex Grönholm\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights t... |
{
"id": 29,
"num_files": 11,
"repo_id": "repo_0029",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2022 Alex Grönholm\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights t... |
{
"id": 30,
"num_files": 14,
"repo_id": "repo_0030",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 31,
"num_files": 14,
"repo_id": "repo_0031",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 32,
"num_files": 14,
"repo_id": "repo_0032",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 33,
"num_files": 14,
"repo_id": "repo_0033",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 34,
"num_files": 14,
"repo_id": "repo_0034",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 35,
"num_files": 14,
"repo_id": "repo_0035",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 36,
"num_files": 14,
"repo_id": "repo_0036",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 37,
"num_files": 14,
"repo_id": "repo_0037",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 38,
"num_files": 14,
"repo_id": "repo_0038",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 39,
"num_files": 14,
"repo_id": "repo_0039",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 40,
"num_files": 14,
"repo_id": "repo_0040",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 41,
"num_files": 14,
"repo_id": "repo_0041",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 42,
"num_files": 14,
"repo_id": "repo_0042",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 43,
"num_files": 14,
"repo_id": "repo_0043",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 44,
"num_files": 14,
"repo_id": "repo_0044",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 45,
"num_files": 14,
"repo_id": "repo_0045",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 46,
"num_files": 14,
"repo_id": "repo_0046",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 47,
"num_files": 14,
"repo_id": "repo_0047",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 48,
"num_files": 14,
"repo_id": "repo_0048",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 49,
"num_files": 14,
"repo_id": "repo_0049",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 50,
"num_files": 14,
"repo_id": "repo_0050",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 51,
"num_files": 14,
"repo_id": "repo_0051",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 52,
"num_files": 14,
"repo_id": "repo_0052",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 53,
"num_files": 14,
"repo_id": "repo_0053",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 54,
"num_files": 14,
"repo_id": "repo_0054",
"subset": "32K"
} | [
{
"content": "python3 -m timeit -s \"\nfrom decorator import decorator\n@decorator\ndef do_nothing(func, *args, **kw):\n return func(*args, **kw)\n@do_nothing\ndef f():\n pass\n\" \"f()\"\npython3 -m timeit -s \"\ndef f():\n pass\n\" \"f()\"\n\n[end of performance.sh]",
"filename": "performance.sh"... |
{
"id": 55,
"num_files": 20,
"repo_id": "repo_0055",
"subset": "32K"
} | [
{
"content": "TODOs\n=====\n\nThis to do list contains some thoughts and ideas about missing features, and\nparts to think about, whether to implement them or not. This list is probably\nnot complete.\n\nMissing features:\n-----------------\n\n * time formatting does not allow to create fractional representa... |
{
"id": 56,
"num_files": 20,
"repo_id": "repo_0056",
"subset": "32K"
} | [
{
"content": "TODOs\n=====\n\nThis to do list contains some thoughts and ideas about missing features, and\nparts to think about, whether to implement them or not. This list is probably\nnot complete.\n\nMissing features:\n-----------------\n\n * time formatting does not allow to create fractional representa... |
{
"id": 57,
"num_files": 20,
"repo_id": "repo_0057",
"subset": "32K"
} | [
{
"content": "TODOs\n=====\n\nThis to do list contains some thoughts and ideas about missing features, and\nparts to think about, whether to implement them or not. This list is probably\nnot complete.\n\nMissing features:\n-----------------\n\n * time formatting does not allow to create fractional representa... |
{
"id": 58,
"num_files": 16,
"repo_id": "repo_0058",
"subset": "32K"
} | [
{
"content": "[package]\nname = \"rpds-py\"\nversion = \"0.23.1\"\nedition = \"2021\"\n\n[lib]\nname = \"rpds\"\ncrate-type = [\"cdylib\"]\n\n[dependencies]\nrpds = \"1.1.0\"\narchery = \"1.2.1\"\n\n[dependencies.pyo3]\nversion = \"0.23.4\"\n# To build extension for PyPy on Windows, \"generate-import-lib\" is n... |
{
"id": 59,
"num_files": 12,
"repo_id": "repo_0059",
"subset": "32K"
} | [
{
"content": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n ... |
{
"id": 60,
"num_files": 27,
"repo_id": "repo_0060",
"subset": "32K"
} | [
{
"content": "site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n ... |
{
"id": 61,
"num_files": 27,
"repo_id": "repo_0061",
"subset": "32K"
} | [
{
"content": "site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n ... |
{
"id": 62,
"num_files": 27,
"repo_id": "repo_0062",
"subset": "32K"
} | [
{
"content": "site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n ... |
{
"id": 63,
"num_files": 27,
"repo_id": "repo_0063",
"subset": "32K"
} | [
{
"content": "site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n ... |
{
"id": 64,
"num_files": 27,
"repo_id": "repo_0064",
"subset": "32K"
} | [
{
"content": "site_name: python-dotenv\nrepo_url: https://github.com/theskumar/python-dotenv\nedit_uri: \"\"\ntheme:\n name: material\n palette:\n primary: green\n features:\n - toc.follow\n - navigation.sections\n\nmarkdown_extensions:\n - mdx_truly_sane_lists\n\nplugins:\n - mkdocstrings:\n ... |
{
"id": 65,
"num_files": 7,
"repo_id": "repo_0065",
"subset": "32K"
} | [
{
"content": "Mypy extensions are licensed under the terms of the MIT license, reproduced below.\n\n= = = = =\n\nThe MIT License\n\nCopyright (c) 2016-2017 Jukka Lehtosalo and contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentat... |
{
"id": 66,
"num_files": 64,
"repo_id": "repo_0066",
"subset": "32K"
} | [
{
"content": "queue_rules:\n - name: default\n merge_method: squash\n queue_conditions:\n - or:\n - author = jd\n - \"#approved-reviews-by >= 1\"\n - author = dependabot[bot]\n - or:\n - files ~= ^releasenotes/notes/\n - label = no-changelog\n - author ... |
{
"id": 67,
"num_files": 64,
"repo_id": "repo_0067",
"subset": "32K"
} | [
{
"content": "queue_rules:\n - name: default\n merge_method: squash\n queue_conditions:\n - or:\n - author = jd\n - \"#approved-reviews-by >= 1\"\n - author = dependabot[bot]\n - or:\n - files ~= ^releasenotes/notes/\n - label = no-changelog\n - author ... |
{
"id": 68,
"num_files": 64,
"repo_id": "repo_0068",
"subset": "32K"
} | [
{
"content": "queue_rules:\n - name: default\n merge_method: squash\n queue_conditions:\n - or:\n - author = jd\n - \"#approved-reviews-by >= 1\"\n - author = dependabot[bot]\n - or:\n - files ~= ^releasenotes/notes/\n - label = no-changelog\n - author ... |
{
"id": 69,
"num_files": 28,
"repo_id": "repo_0069",
"subset": "32K"
} | [
{
"content": "Copyright (C) 2010, 2011 Sebastian Thiel and contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions \nare met:\n\n* Redistributions of source code must retain the above copyright ... |
{
"id": 70,
"num_files": 28,
"repo_id": "repo_0070",
"subset": "32K"
} | [
{
"content": "Copyright (C) 2010, 2011 Sebastian Thiel and contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions \nare met:\n\n* Redistributions of source code must retain the above copyright ... |
{
"id": 71,
"num_files": 28,
"repo_id": "repo_0071",
"subset": "32K"
} | [
{
"content": "Copyright (C) 2010, 2011 Sebastian Thiel and contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions \nare met:\n\n* Redistributions of source code must retain the above copyright ... |
{
"id": 72,
"num_files": 28,
"repo_id": "repo_0072",
"subset": "32K"
} | [
{
"content": "Copyright (C) 2010, 2011 Sebastian Thiel and contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions \nare met:\n\n* Redistributions of source code must retain the above copyright ... |
{
"id": 73,
"num_files": 43,
"repo_id": "repo_0073",
"subset": "32K"
} | [
{
"content": "How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerou... |
{
"id": 74,
"num_files": 43,
"repo_id": "repo_0074",
"subset": "32K"
} | [
{
"content": "How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerou... |
{
"id": 75,
"num_files": 43,
"repo_id": "repo_0075",
"subset": "32K"
} | [
{
"content": "How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerou... |
{
"id": 76,
"num_files": 43,
"repo_id": "repo_0076",
"subset": "32K"
} | [
{
"content": "How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerou... |
{
"id": 77,
"num_files": 43,
"repo_id": "repo_0077",
"subset": "32K"
} | [
{
"content": "How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerou... |
{
"id": 78,
"num_files": 43,
"repo_id": "repo_0078",
"subset": "32K"
} | [
{
"content": "How to contribute to ItsDangerous\n=================================\n\nThank you for considering contributing to ItsDangerous!\n\n\nSupport questions\n-----------------\n\nPlease don't use the issue tracker for this. The issue tracker is a\ntool to address bugs and feature requests in ItsDangerou... |
{
"id": 79,
"num_files": 14,
"repo_id": "repo_0079",
"subset": "32K"
} | [
{
"content": "python:\n version: 3\n\n[end of readthedocs.yml]",
"filename": "readthedocs.yml",
"id": "0"
},
{
"content": "ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, ... |
{
"id": 80,
"num_files": 14,
"repo_id": "repo_0080",
"subset": "32K"
} | [
{
"content": "python:\n version: 3\n\n[end of readthedocs.yml]",
"filename": "readthedocs.yml",
"id": "0"
},
{
"content": "ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, ... |
{
"id": 81,
"num_files": 14,
"repo_id": "repo_0081",
"subset": "32K"
} | [
{
"content": "python:\n version: 3\n\n[end of readthedocs.yml]",
"filename": "readthedocs.yml",
"id": "0"
},
{
"content": "ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, ... |
{
"id": 82,
"num_files": 14,
"repo_id": "repo_0082",
"subset": "32K"
} | [
{
"content": "python:\n version: 3\n\n[end of readthedocs.yml]",
"filename": "readthedocs.yml",
"id": "0"
},
{
"content": "ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, ... |
{
"id": 83,
"num_files": 14,
"repo_id": "repo_0083",
"subset": "32K"
} | [
{
"content": "python:\n version: 3\n\n[end of readthedocs.yml]",
"filename": "readthedocs.yml",
"id": "0"
},
{
"content": "ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, ... |
{
"id": 84,
"num_files": 14,
"repo_id": "repo_0084",
"subset": "32K"
} | [
{
"content": "python:\n version: 3\n\n[end of readthedocs.yml]",
"filename": "readthedocs.yml",
"id": "0"
},
{
"content": "ISC LICENSE\n\n This license is approved by the OSI and FSF as GPL-compatible.\n http://opensource.org/licenses/isc-license.txt\n\n Copyright (c) 2013-2014, ... |
{
"id": 85,
"num_files": 17,
"repo_id": "repo_0085",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 86,
"num_files": 17,
"repo_id": "repo_0086",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 87,
"num_files": 17,
"repo_id": "repo_0087",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 88,
"num_files": 17,
"repo_id": "repo_0088",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 89,
"num_files": 17,
"repo_id": "repo_0089",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 90,
"num_files": 17,
"repo_id": "repo_0090",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 91,
"num_files": 17,
"repo_id": "repo_0091",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 92,
"num_files": 17,
"repo_id": "repo_0092",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 93,
"num_files": 17,
"repo_id": "repo_0093",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 94,
"num_files": 17,
"repo_id": "repo_0094",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 95,
"num_files": 17,
"repo_id": "repo_0095",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 96,
"num_files": 17,
"repo_id": "repo_0096",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 97,
"num_files": 17,
"repo_id": "repo_0097",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 98,
"num_files": 17,
"repo_id": "repo_0098",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
{
"id": 99,
"num_files": 17,
"repo_id": "repo_0099",
"subset": "32K"
} | [
{
"content": "The MIT License (MIT)\n\nCopyright (c) 2014 litl, LLC.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto ... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.